Skip to main content
Glama
context-hub

CTX: Context as Code (CaC) tool

by context-hub

ctx:你的代码库和 LLM 之间缺失的环节。内置 MCP 服务器的上下文即代码 (CaC) 工具。

早上好,法学硕士

目录

CTX是一个工具,用于解决与 ChatGPT 或 Claude 等 LLM 聊天时的一个大问题:为他们提供有关您的项目的足够背景信息

Medium上有一篇关于 Context Generator 的文章,解释了该项目背后的动机及其解决的问题。

当你在开发中使用 AI 时,上下文不仅仅是有用的,它更是一切。ctx 无需每次手动复制或解释整个代码库,它会自动从以下位置构建整洁有序的上下文文件:

  • 代码文件,

  • GitHub 和 Gitlab 存储库,

  • Git 提交和差异

  • 带有 CSS 选择器的网页(URL),

  • MCP 服务器

  • 和纯文本。

它的创建是为了解决一个常见问题:有效地为 Claude 等 AI 语言模型提供有关代码库的必要上下文。

Related MCP server: Claude-LMStudio Bridge

工作原理

  1. 从文件、目录、GitHub 或 Gitlab 存储库、网页或纯文本收集代码。

  2. 通过模式匹配、内容搜索、大小或日期过滤器定位特定文件

  3. 应用可选修饰符(例如提取没有实现细节的 PHP 签名)

  4. 将内容组织成结构良好的 Markdown 文档

  5. 保存上下文文件,准备与 LLM 共享

  6. 可选择通过 MCP 服务器提供上下文,允许 Claude 等 AI 助手直接访问项目信息

快速入门

CTX 入门非常简单。按照以下简单步骤即可创建您的第一个上下文文件。

1.安装CTX

使用我们的安装脚本下载并安装该工具:

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

这会将ctx命令安装到您的系统中(通常在/usr/local/bin中)。

**想要更多选择?**请参阅完整的安装指南,了解其他安装方法。

2.初始化配置文件

在您的项目目录中创建一个新的配置文件:

ctx init

这将生成一个具有基本结构的context.yaml文件来帮助您入门。

检查命令参考以了解所有可用的命令和选项。

3.描述你的项目结构

编辑生成的context.yaml文件以指定您想要包含的代码或内容。

例如:

$schema: 'https://raw.githubusercontent.com/context-hub/generator/refs/heads/main/json-schema.json' documents: - description: "User Authentication System" outputPath: "auth-context.md" sources: - type: file description: "Authentication Controllers" sourcePaths: - src/Auth filePattern: "*.php" - type: file description: "Authentication Models" sourcePaths: - src/Models filePattern: "*User*.php"

此配置将从src/Auth目录中收集所有 PHP 文件,并从src/Models目录中收集名称中包含“User”的任何 PHP 文件。

需要更高级的配置吗?

4. 构建上下文

通过运行以下命令生成上下文文件:

ctx

CTX 将处理您的配置并创建指定的输出文件(在我们的示例中为auth-context.md )。

提示:使用-v-vv-vvv配置日志记录以获取详细输出

5. 与法学硕士分享

将生成的上下文文件上传或粘贴到您最喜欢的 LLM(例如 ChatGPT 或 Claude)。现在,您可以针对代码库提出具体问题,LLM 将提供必要的上下文信息,从而提供准确的帮助。

示例提示:

我已经将我的身份验证系统代码分享给您了。您能帮我找出用户注册过程中潜在的安全漏洞吗?

**下一步:**查看使用上下文生成器进行开发,了解将上下文生成集成到 AI 驱动的开发工作流程中的最佳实践。

就这样!现在,您已经准备好利用 LLM 来了解您的代码库的正确上下文了。

6. 连接到 Claude AI(可选)

为了获得更无缝的体验,您可以使用 MCP 服务器将 Context Generator 直接连接到 Claude AI:

有一个内置的 MCP 服务器,允许您将 Claude AI 直接连接到您的代码库。

将 MCP 客户端指向上下文生成器服务器:

{ "mcpServers": { "ctx": { "command": "ctx server -c /path/to/your/project" } } }

**注意:**阅读有关MCP 服务器的更多信息以获取详细的设置说明。

现在您可以向 Claude 询问有关您的代码库的问题,而无需手动上传上下文文件!

完整文档

如需完整文档,包括所有可用功能和配置选项,请访问:

https://docs.ctxgithub.com


执照

该项目已获得 MIT 许可。

-
security - not tested
A
license - permissive license
-
quality - not tested

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/context-hub/generator'

If you have feedback or need assistance with the MCP directory API, please join our Discord server