GitMCP

GitMCP是什么 • 特性 • 开始使用 • 工作原理 • 示例 • 常见问题 • 隐私 • 贡献 • 许可证

🤔 GitMCP是什么？

停止幻想，开始编码！

GitMCP 是一个免费、开源的远程 Model Context Protocol (MCP) 服务器，它将 任何 GitHub 项目（仓库或 GitHub 页面）转换为文档中心。它允许 AI 工具（如 Cursor）访问最新的文档和代码，从而无缝结束代码幻觉。

✨ 特性

• 😎 任何 GitHub 项目的最新文档：授予您的 AI 助手对 GitHub 项目文档和代码的无缝访问权限。内置的智能搜索功能可以帮助 AI 找到所需内容，而无需消耗过多令牌！
• 🧠 不再幻觉：借助 GitMCP，您的 AI 助手可以提供准确且相关的答案。
• ☁️ 零设置：GitMCP 在云端运行。只需在您的 IDE 中添加所选的 GitMCP URL 作为 MCP 服务器即可 —— 无需下载、安装、注册或更改任何内容。
• ✅ 免费且私密：GitMCP 是开源的，并且完全免费使用。它不会收集个人信息或存储查询记录。您甚至可以自行托管它！

🚀 开始使用

使用 GitMCP 很简单！只需按照以下步骤操作：

第一步：选择您想要的服务器类型

根据您要连接的内容，选择以下 URL 格式之一：

• 对于 GitHub 仓库：gitmcp.io/{owner}/{repo}
• 对于 GitHub Pages 站点： {owner}.gitmcp.io/{repo}
• 对于支持任意仓库的通用工具（动态）：gitmcp.io/docs

将 {owner} 替换为 GitHub 用户名或组织名称，将 {repo} 替换为仓库名称。

为了方便起见，您还可以使用主页上的转换工具将 GitHub URL 格式化为 MCP URL！

第二步：连接您的 AI 助手

从以下选项中选择您的 AI 助手并按照配置说明操作：

连接 Cursor

更新您的 Cursor 配置文件 ~/.cursor/mcp.json：

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

连接 Claude Desktop

1. 在 Claude Desktop 中，转到设置 > 开发者 > 编辑配置
2. 将配置替换为：
   json 复制代码

   {
     "mcpServers": {
       "gitmcp": {
         "command": "npx",
         "args": [
           "mcp-remote",
           "https://gitmcp.io/{owner}/{repo}"
         ]
       }
     }
   }

连接 Windsurf

更新您的 Windsurf 配置文件 ~/.codeium/windsurf/mcp_config.json：

{
  "mcpServers": {
    "gitmcp": {
      "serverUrl": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

连接 VSCode

更新您的 VSCode 配置文件 .vscode/mcp.json：

{
  "servers": {
    "gitmcp": {
      "type": "sse",
      "url": "https://gitmcp.io/{owner}/{repo}"
    }
  }
}

连接 Cline

更新您的 Cline 配置文件 ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json：

{
  "mcpServers": {
    "gitmcp": {
      "url": "https://gitmcp.io/{owner}/{repo}",
      "disabled": false,
      "autoApprove": []
    }
  }
}

连接 Highlight AI

1. 打开 Highlight AI 并点击侧边栏中的插件图标（@ 符号）
2. 点击侧边栏顶部的 已安装插件
3. 选择 自定义插件
4. 点击 使用自定义 SSE URL 添加插件

插件名称：gitmcp
SSE URL：https://gitmcp.io/{owner}/{repo}

有关如何向 HighlightAI 添加自定义 MCP 服务器的更多详细信息，请参阅 文档。

注意： 记得将 {owner} 和 {repo} 替换为实际的 GitHub 用户名/组织和仓库名称。您也可以使用动态端点 https://gitmcp.io/docs，以便您的 AI 按需访问任何仓库。

⚙️ 工作原理

GitMCP 使用 Model Context Protocol (MCP) 将您的 AI 助手连接到 GitHub 仓库，这是一种让 AI 工具从外部来源请求额外信息的标准。

当您使用 GitMCP 时会发生什么：

1. 您向 AI 助手提供 GitMCP URL（例如，gitmcp.io/microsoft/typescript）。GitMCP 提供了诸如文档获取、智能搜索、代码搜索等工具。
2. 提示 AI 助手 关于文档/代码相关的问题。
3. 您的 AI 发送请求 到 GitMCP 使用其工具（经过您的批准）。
4. GitMCP 执行 AI 的请求 并返回请求的数据。
5. 您的 AI 接收信息 并生成更准确、基于事实的回答，而不会出现幻觉。

支持的文档

GitMCP 当前支持以下文档（按优先级顺序）：

1. llms.txt
2. 针对 AI 优化的项目文档版本
3. README.md/根目录

💡 示例

以下是如何使用 GitMCP 与不同的 AI 助手和仓库结合的一些示例：

示例 1：使用 Windsurf 与特定仓库

对于 GitHub 仓库 https://github.com/microsoft/playwright-mcp，将 https://gitmcp.io/microsoft/playwright-mcp 添加为 Windsurf 的 MCP 服务器。

提示给 Claude：

"我该如何使用 Playwright MCP"

Windsurf 将从 GitMCP 中提取相关文档以正确实现记忆功能。

示例 2：使用 Cursor 与 GitHub Pages 站点

对于 GitHub Pages 站点 langchain-ai.github.io/langgraph，将 https://langchain-ai.gitmcp.io/langgraph 添加为 Cursor 的 MCP 服务器。

提示给 Cursor：

"为我的 LangGraph agent 添加记忆功能"

Cursor 将从 GitMCP 中提取相关文档和代码以正确实现记忆功能。

示例 3：使用 Claude Desktop 与动态端点

您不必选择特定仓库。通用的 gitmcp.io/docs 端点允许 AI 实时选择 GitHub 项目！

提示给任何 AI 助手：

"我想学习 OpenAI Whisper 语音识别模型的工作原理。解释一下它是如何工作的。"

Claude 将从 GitMCP 中提取数据并回答问题。

🛠️ 工具

GitMCP 为 AI 助手提供了多个有价值的工具，帮助它们访问、理解和查询 GitHub 仓库。

fetch_<repo-name>_documentation

此工具从 GitHub 仓库中获取主要文档。它通过检索相关文档（例如 llms.txt）来工作，这为 AI 提供了关于项目的好概述。

何时有用： 针对有关项目目的、功能或入门方法的一般问题。

search_<repo-name>_documentation

此工具允许 AI 通过提供特定搜索查询来搜索仓库的文档。它不加载所有文档（可能非常庞大），而是使用智能搜索找到相关部分。

何时有用： 针对项目中特定功能、函数或概念的具体问题。

fetch_url_content

此工具帮助 AI 获取文档中提到链接的信息。它从这些链接中检索内容并将其转换为 AI 可轻松读取的格式。

何时有用： 当文档引用了有助于回答您问题的外部信息时。

search_<repo-name>_code

此工具通过 GitHub 的代码搜索功能搜索仓库的实际代码。它帮助 AI 找到特定的代码示例或实现细节。

何时有用： 当您需要查看某项功能的实现示例或需要文档未涵盖的技术细节时。

注意： 当使用动态端点 (gitmcp.io/docs) 时，这些工具的名称略有不同（fetch_generic_documentation、search_generic_code 和 search_generic_documentation），并且需要提供有关要访问的仓库的附加信息。

❓ 常见问题

Model Context Protocol 是什么？

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

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

是的，GitMCP 与支持 Model Context Protocol 的任何 AI 助手兼容，包括 Cursor、VSCode、Claude 等工具。

GitMCP 是否兼容所有 GitHub 项目？

绝对兼容！GitMCP 可以与任何公共 GitHub 仓库配合使用，而无需进行任何修改。它优先使用 llms.txt 文件，如果不可用则回退到 README.md 或其他页面。未来的更新旨在支持更多的文档方法，甚至动态生成内容。

GitMCP 是否收费？

不，GitMCP 是一项免费服务，社区使用无任何费用。

🔒 隐私

GitMCP 非常重视用户的隐私。该服务不会访问或存储任何个人可识别信息，因为它不需要身份验证。此外，它不会存储由代理发送的任何查询。此外，由于 GitMCP 是一个开源项目，您可以独立部署它到自己的环境中。

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

👥 贡献

我们欢迎贡献、反馈和想法！请查阅我们的 贡献 指南。

本地开发设置

1. 克隆仓库

   bash 复制代码

   git clone https://github.com/idosal/git-mcp.git
   cd git-mcp

2. 安装依赖

   bash 复制代码

   pnpm install

3. 本地运行以进行开发

   bash 复制代码

   npm run dev
   # 或
   pnpm dev

使用 MCP Inspector 进行测试

1. 安装 MCP Inspector 工具：

   bash 复制代码

   npx @modelcontextprotocol/inspector

2. 在 inspector 界面中：

   • 设置传输类型为 SSE
   • 输入您的 GitMCP URL（例如，http://localhost:5173/docs)
   • 点击“连接”

📄 许可证

本项目依据 Apache License 2.0 许可。

免责声明

GitMCP 按“原样”提供，没有任何种类的担保。尽管我们努力确保服务的可靠性和安全性，但我们不对因使用该服务而可能产生的任何损害或问题负责。通过 GitMCP 访问的 GitHub 项目受各自所有者的条款和条件约束。GitMCP 与 GitHub 或任何提及的 AI 工具无关联。