ghcontext: Supercharge Your LLMs with Real-time GitHub Context
2025.04.14
0
TypeScriptGitHub集成实时数据AI助手增强开发效率
ghcontext（GitHub Context Provider）是一个连接GitHub和大型语言模型（LLM）的工具，通过标准化的模型上下文协议（MCP）为AI助手提供实时的仓库信息。它能够提供最新的API文档、README内容和代码库结构，帮助LLM更准确地理解项目架构、设计原则和API使用模式。ghcontext支持任何兼容MCP的模型，如Claude、GPT等，并具有高效的智能缓存机制，减少API调用次数。
View on GitHub
Overview
基本能力
产品定位
ghcontext旨在为大型语言模型提供实时的GitHub仓库信息，解决传统AI助手在项目信息获取上的滞后性和不完整性问题。
核心功能
- API文档提取：自动从README和专用文档文件中提取API文档。
- 仓库结构分析：提供代码库的组织结构图。
- README内容检索：直接从GitHub获取最新的文档内容。
- 文件内容搜索：查找并提取特定文件或代码片段。
- 仓库搜索：根据特定条件发现匹配的仓库。
适用场景
- 需要实时获取GitHub仓库信息的AI助手。
- 项目架构和API文档的快速理解。
- 代码库中特定文件或代码片段的查找。
工具列表
get-repository-info：获取仓库的详细信息。get-repository-readme：检索当前README内容。get-repository-api-docs：提取API文档。search-repository-files：在仓库中查找文件。get-file-content：检索特定文件内容。
常见问题解答
- GitHub令牌：ghcontext需要GitHub令牌进行认证，用户需自行管理令牌安全，仅授予必要的权限范围。
使用教程
使用依赖
- 需要Node.js 22.x和TypeScript 5.x环境。
安装教程
方法1：使用npx直接运行
npx ghcontext --GITHUB_TOKEN your_github_token
方法2：全局安装
npm install -g ghcontext
ghcontext --GITHUB_TOKEN your_github_token
方法3：手动安装（开发）
git clone https://github.com/yourusername/ghcontext.git
cd ghcontext
pnpm install
pnpm start --GITHUB_TOKEN your_github_token
调试方式
- 启动服务后，连接到MCP服务器端点：
http://localhost:3000/api/mcp
- 使用提供的工具进行测试和调试。