GitMCP

<img width="1148" alt="image" src="https://github.com/user-attachments/assets/e0c719d2-62f4-450e-90f3-c7dd0194f0b9" />

<p align="center"> <a href="#features">特性</a> • <a href="#usage">用法</a> • <a href="#how-it-works">工作原理</a> • <a href="#examples">示例</a> • <a href="#faq">常见问题解答</a> • <a href="#privacy">隐私</a> • <a href="#contributing">贡献</a> • <a href="#license">许可证</a> </p> <div align="center">

</div>

什么是 GitMCP？

GitMCP 是一个免费的开源服务，它可以无缝地将任何 GitHub 项目转换为远程 模型上下文协议 (MCP) 端点，使 AI 助手能够轻松访问和理解项目的文档。

特性

• 使用 GitHub 项目访问权限增强 AI 能力：将您的 AI 助手定向到 GitMCP，以便即时访问任何 GitHub 项目的文档，并具有语义搜索功能以优化令牌使用。
• 零设置要求：无需配置或修改 — GitMCP 开箱即用。
• 完全免费和私密：GitMCP 是免费的。我们不收集任何个人身份信息或查询。此外，您可以自己托管它！

入门（用法）

要使您的 GitHub 存储库可以通过 GitMCP 供 AI 助手访问，请使用以下 URL 格式：

• 对于 GitHub 存储库：gitmcp.io/{owner}/{repo}
• 对于 GitHub Pages 站点：{owner}.gitmcp.io/{repo}
• 动态端点：gitmcp.io/docs

恭喜！所选的 GitHub 项目现在可以完全供您的 AI 访问。

将 {owner} 替换为您的 GitHub 用户名或组织名称，并将 {repo} 替换为您的存储库名称。配置完成后，您的 AI 助手可以无缝访问项目的文档。 动态端点不需要预定义的存储库。使用时，您的 AI 助手可以动态输入任何 GitHub 存储库以享受 GitMCP 的功能。

<video src="https://github.com/user-attachments/assets/2c3afaf9-6c08-436e-9efd-db8710554430"></video>

工作原理

GitMCP 通过实现模型上下文协议 (MCP) 充当 GitHub 存储库文档和 AI 助手之间的桥梁。当 AI 助手需要来自您的存储库的信息时，它会向 GitMCP 发送请求。 GitMCP 检索相关内容并提供语义搜索功能，确保高效准确的信息传递。

示例

以下是一些如何将 GitMCP 与不同存储库一起使用的示例：

• 示例 1：对于存储库 https://github.com/octocat/Hello-World，请使用：https://gitmcp.io/octocat/Hello-World
• 示例 2：对于 GitHub Pages 站点 langchain-ai.gitmcp.io/langgraph，请使用：https://langchain-ai.gitmcp.io/langgraph
• 示例 3：使用通用的 gitmcp.com/docs 端点，以便您的 AI 动态选择存储库

这些 URL 使 AI 助手能够通过 GitMCP 访问项目的文档并与之交互。

工具

GitMCP 提供了一组工具，可用于访问项目的文档并与之交互。

fetch_<repo-name>_documentation:

获取 {owner}/{repo} GitHub 存储库的文档（从 URL 中提取：gitmcp.io/{owner}/{repo} 或 {owner}.gitmcp.io/{repo}）。对于一般问题很有用。检索 llms.txt 文件，如果前者不可用，则回退到 README.md 或其他页面。

search_<repo-name>_documentation:

它通过提供 query 来搜索存储库的文档。这对于特定问题很有用。它使用语义搜索来查找最相关的文档。这减轻了大型文档集的成本，这些文档集无法作为直接上下文提供给 LLM。

注意：在使用通用 gitmcp.com/docs 的情况下，这些工具被称为 fetch_generic_documentation 和 search_generic_documentation，并接收额外的 owner 和 repo 参数。

常见问题解答

什么是模型上下文协议？

模型上下文协议 是一种标准，允许 AI 助手以结构化的方式从外部来源请求和接收额外的上下文，从而增强他们的理解和性能。

GitMCP 是否适用于任何 AI 助手？

是的，GitMCP 与任何支持模型上下文协议的 AI 助手兼容，包括 Cursor、VSCode、Claude 等工具。

GitMCP 是否与所有 GitHub 项目兼容？

当然！ GitMCP 适用于任何公共 GitHub 存储库，无需任何修改。它优先考虑 llms.txt 文件，如果前者不可用，则回退到 README.md 或其他页面。未来的更新旨在支持其他文档方法，甚至动态生成内容。

GitMCP 是否需要付费？

不，GitMCP 是一项免费的社区服务，不收取任何相关费用。

隐私

GitMCP 坚定地致力于用户的隐私。该服务无法访问或存储任何个人身份信息，因为它不需要身份验证。此外，它不存储代理发送的任何查询。此外，由于 GitMCP 是一个开源项目，因此可以在您的环境中独立部署。

GitMCP 仅访问已公开可用的内容，并且仅在用户查询时才访问。 GitMCP 不会自动抓取存储库。在访问任何 GitHub Pages 站点之前，代码会检查 robots.txt 规则并遵循站点所有者设置的指令，允许他们选择退出。请注意，GitMCP 不会永久存储有关 GitHub 项目或其内容的数据。

贡献

我们欢迎贡献！请查看我们的贡献指南。

许可证

本项目根据 MIT 许可证 获得许可。

免责声明

GitMCP 按“原样”提供，不提供任何形式的保证。虽然我们努力确保我们服务的可靠性和安全性，但我们不对因其使用而可能造成的任何损害或问题负责。通过 GitMCP 访问的 GitHub 项目受其各自所有者的条款和条件的约束。 GitMCP 不隶属于 GitHub 或任何提及的 AI 工具。