产品定位
GitMCP是一个开源服务,旨在通过Model Context Protocol(MCP)将GitHub项目的文档转换为AI助手可访问的端点,提升开发效率和AI助手的理解能力。
核心功能
- Empower AI with GitHub Project Access:AI助手可以通过GitMCP直接访问任何GitHub项目的文档,并具备语义搜索功能以优化令牌使用。
- Zero Setup Required:无需配置或修改,开箱即用。
- Completely Free and Private:完全免费且私有,不收集任何个人身份信息或查询,支持自托管。
适用场景
- AI助手需要访问GitHub项目文档的场景。
- 开发者希望通过语义搜索快速获取项目文档信息的场景。
- 需要动态访问不同GitHub仓库文档的场景。
工具列表
fetch_<repo-name>_documentation
:获取指定GitHub仓库的文档,优先使用llms.txt
文件,若无则回退到README.md
或其他页面。search_<repo-name>_documentation
:通过语义搜索查询仓库文档,适用于特定问题。
常见问题解答
- What is the Model Context Protocol?:Model Context Protocol是一种标准,允许AI助手以结构化方式从外部源请求和接收额外上下文。
- Does GitMCP work with any AI assistant?:是的,GitMCP兼容任何支持MCP的AI助手。
- Is GitMCP compatible with all GitHub projects?:是的,GitMCP适用于所有公开的GitHub仓库,无需修改。
- Does GitMCP cost money?:不,GitMCP是完全免费的服务。
使用教程
使用依赖
无需额外依赖,直接通过URL访问即可。
安装教程
无需安装,直接使用以下URL格式访问:
- 对于GitHub仓库:gitmcp.io/{owner}/{repo}
- 对于GitHub Pages站点:{owner}.gitmcp.io/{repo}
- 动态端点:gitmcp.io/docs
调试方式
直接通过URL访问并检查返回的文档内容是否符合预期。