ctx: The missing link between your codebase and your LLM. Context as Code (CaC) tool with MCP server inside.

CTX：你的 AI 编码伙伴

由 MCP 驱动的开发工具包，让 AI 完全访问你的代码库


CTX 是什么？

CTX 是一个仅约 20 MB 的独立二进制文件，无需任何依赖。无需 Node.js、无需 Python、无需运行时——只需下载、连接到 MCP 客户端，即可开始使用 AI 编码。

将它连接到 Claude Desktop、Cursor、Cline 或任何兼容 MCP 的客户端，AI 就能直接读取、写入、搜索和修改你各个项目中的文件。

CTX 专为 Claude Desktop 设计，与它搭配效果最佳。Claude 对代码的深入理解，结合 CTX 的文件系统工具、自定义命令和多项目支持，带来流畅的开发体验——就像一位熟悉你整个代码库的资深开发者坐在你身边。

目录

• 主要功能
• 快速入门
• 工作原理
• 使用场景
• 完整文档
• 许可证

主要功能

🛠 MCP 服务——AI 直接在你的项目中开发

CTX 内置了功能强大的 MCP 服务，提供文件系统工具：

• 读取和写入文件——AI 可直接创建、修改和分析代码
• 跨代码库搜索——支持文本和正则表达式搜索，并显示上下文行
• PHP 结构分析——一览类层次结构、接口和依赖关系
• 目录探索——按模式、日期、大小和内容智能筛选

⚡ 自定义工具——将任意命令变成 AI 工具

定义项目专属命令，让 AI 通过 MCP 执行：

tools:
  - id: run-tests
    description: "Run project tests with coverage"
    type: run
    commands:
      - cmd: vendor/bin/phpunit
        args: [ "--coverage-html", "logs/coverage" ]

  - id: deploy
    description: "Deploy to staging"
    type: run
    schema:
      type: object
      properties:
        branch:
          type: string
          default: "main"
    commands:
      - cmd: ./deploy.sh
        args: [ "{{branch}}" ]

测试、迁移、代码检查、部署——终端能运行的任何操作，AI 都能触发。

📁 多项目开发

同时处理多个微服务。AI 可以查看你的所有项目，并开发跨项目功能：

projects:
  - name: backend-api
    path: ../backend
    description: "REST API service"

  - name: auth-service
    path: ../auth
    description: "Authentication microservice"

  - name: shared-lib
    path: ../packages/shared
    description: "Shared domain models"

启动会话后，让 AI 列出可用项目，并开发横跨多个服务的功能——全部在一次对话中完成。

🎯 智能上下文生成

精确定义 AI 所需的上下文。CTX 会从文件、Git 差异、GitHub 仓库、URL 等来源收集代码，然后将其整理为清晰的 Markdown 文档：

documents:
  - description: User Authentication System
    outputPath: auth.md
    sources:
      - type: file
        sourcePaths: [ src/Auth ]
        filePattern: "*.php"
      - type: git_diff
        commit: "last-week"

📐 基于 JSON Schema 的声明式配置

所有内容都通过 context.yaml 配置，并全面支持 JSON Schema。AI 助手可以为你生成和修改这些配置——只需描述你的需求。

ctx init    # Generate initial config
ctx generate  # Build context documents
ctx server  # Start MCP server

快速入门

安装

Linux / WSL：

curl -sSL https://raw.githubusercontent.com/context-hub/generator/main/download-latest.sh | sh

Windows：

powershell -c "& ([ScriptBlock]::Create((irm 'https://raw.githubusercontent.com/context-hub/generator/main/download-latest.ps1'))) -AddToPath"

连接到 Claude Desktop（或任何 MCP 客户端）

最快的方法——自动检测操作系统并配置 MCP 客户端：

ctx mcp:config

也可以手动添加到 MCP 客户端配置中：

{
  "mcpServers": {
    "ctx": {
      "command": "ctx",
      "args": [
        "server"
      ]
    }
  }
}

指定项目：

{
  "mcpServers": {
    "ctx": {
      "command": "ctx",
      "args": [
        "server",
        "-c",
        "/path/to/project"
      ]
    }
  }
}

完成。现在，你的 AI 助手即可通过 MCP 全面访问你的项目。

可选：生成上下文文档

如果你还想为复制粘贴工作流生成静态上下文文件：

cd your-project
ctx init       # Create context.yaml
ctx generate   # Build markdown contexts

工作原理

CTX 以两种互补的模式运行：

MCP 服务模式——AI 实时与你的代码库交互：

AI Assistant ←→ CTX MCP Server ←→ Your Project Files
                     ↕
              Custom Tools (tests, deploy, lint...)
              Multiple Projects
              Context Documents

上下文生成模式——为任意大模型构建结构化文档：

context.yaml → Sources → Filters → Modifiers → Markdown Documents

使用场景

🔧 AI 驱动的开发（MCP）

将 CTX 连接到 Claude Desktop 或 Cursor。让 AI 探索代码库、了解架构、编写新功能、运行测试和修复问题——所有操作都无需离开对话。

🏗 多服务功能开发

要开发横跨多个微服务的功能？注册所有项目后，AI 就能读取一个服务中的代码、了解共享模型，并在整个技术栈中实现更改。

📝 代码审查上下文

生成包含近期 Git 差异、相关源文件和架构概览的上下文文档。分享给审查者或 AI 助手，以便进行全面、充分的审查。

🚀 入门

新团队成员？几秒内生成全面的项目概览——包括架构、关键接口和领域模型。 AI 随后便能在充分了解上下文的基础上回答有关代码库的问题。

📚 文档生成

使用 php-signature 等修饰符指定 CTX 分析源代码，提取 API 概览，然后让 AI 生成全面的文档。

完整文档

如需查看包括所有功能和配置选项在内的完整文档：

https://docs.ctxllm.com

加入我们的社区

你可以在这里：

• 💡 分享和探索配置与工作流
• 🛠️ 获取设置和高级用法方面的帮助
• 🚀 展示你的 AI 开发工作流
• 📢 第一时间了解新版本

---

许可证

本项目基于 MIT License 授权。