GitMCP

<p align="center"> <img width="884" alt="image" src="https://gips0.baidu.com/it/u=125128794,2330698718&fm=3081&app=3081&f=PNG?w=1768&h=1692" /> </p> <p align="center"> <a href="#-what-is-gitmcp">什么是 GitMCP</a> • <a href="#-features">特性</a> • <a href="#-getting-started">快速开始</a> • <a href="#-how-it-works">如何工作</a> • <a href="#-badge">徽章</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> <div align="center"> <a href="https://www.pulsemcp.com/servers/idosal-git-mcp"><img src="https://www.pulsemcp.com/badge/top-pick/idosal-git-mcp" width="400" alt="Pulse MCP 徽章"></a> </div>

🤔 什么是 GitMCP？

停止猜测，开始编码！

GitMCP 是一个免费、开源的远程 模型上下文协议（MCP） 服务器，它可以将任何 GitHub 项目（仓库或 GitHub 页面）转换成一个文档中心。它使像 Cursor 这样的 AI 工具能够访问最新的文档和代码，即使大型语言模型从未遇到过这些内容，也能无缝地消除代码猜测。

GitMCP 支持两种类型：

• 特定仓库 (gitmcp.io/{owner}/{repo} 或 {owner}.gitmcp.io/{repo})： 当你主要与选定数量的库一起工作时使用这些。这确保你的 AI 助手始终针对正确的项目，通过防止访问意外的仓库来增强安全性和相关性。
• 通用服务器 (gitmcp.io/docs)： 当你需要频繁切换不同的仓库时使用此功能。AI 助手会提示你（或根据上下文决定）每次请求要访问哪个仓库。请注意，这依赖于每次正确识别目标仓库。

使用 GitMCP：

• AI 助手可以直接从源获取最新文档和代码。
• 获取准确的 API 使用方法和可靠的代码示例。
• 即使是小众、新出现或快速变化的库也能有效工作。
• 显著减少猜测并提高代码正确性。

例如，这个并排比较展示了在 Cursor 中创建 three.js 场景时，相同的单次提示的结果：

https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45

✨ 特性

• 😎 任何 GitHub 项目的最新文档：授予你的 AI 助手无缝访问 GitHub 项目文档和代码的能力。内置的智能搜索功能帮助找到 AI 所需的确切内容，而不会消耗过多的令牌！
• 🧠 不再有猜测：有了 GitMCP，你的 AI 助手可以提供准确且相关的答案。
• ☁️ 零配置：GitMCP 在云端运行。只需在你的 IDE 中添加选择的 GitMCP URL 作为 MCP 服务器——无需下载、安装、注册或更改。
• 💬 嵌入式聊天：通过我们的浏览器内聊天，你可以快速开始与仓库文档进行对话！
• ✅ 开放、免费且私密：GitMCP 是开源的，并且完全免费使用。它不收集个人信息或存储查询。你甚至可以自行托管！

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

🚀 快速开始

使用 GitMCP 很简单！只需遵循以下步骤：

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

根据你想连接的内容选择以下 URL 格式之一：

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

用 GitHub 用户名或组织名称替换 {owner}，用仓库名称替换 {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. 替换配置为：

   {
     "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 服务器的更多详细信息，请参阅文档。

连接 Augment Code

1. 打开 Augment Code 设置
2. 导航到 MCP 部分
3. 添加一个新的 MCP 服务器，使用以下详细信息：

命名 MCP 服务器：git-mcp 文档

使用此命令：

npx mcp-remote https://gitmcp.io/{owner}/{repo}

或者使用以下配置：

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

有关如何在 Augment Code 中配置 MCP 服务器的更多详细信息，请访问Augment Code 文档。

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

⚙ 如何工作

GitMCP 使用模型上下文协议（MCP），这是一种标准，让 AI 工具可以从外部来源请求额外的信息，从而将你的 AI 助手连接到 GitHub 仓库。

当你使用 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 页面站点

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

提示给 Cursor：

"在我的 LangGraph 代理中添加记忆"

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），并且需要额外的信息来确定要访问哪个仓库。

📊 徽章

GitMCP 有一个徽章可以添加到你的仓库的 README 中。它允许用户通过他们的 IDE 或浏览器（使用嵌入式聊天）快速访问你的文档。它还展示了你的文档通过 GitMCP 被访问了多少次。

示例（idosal/git-mcp）：

将徽章添加到你的仓库

在你的 README.md 中添加以下内容：

[![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)

用你的 GitHub 用户名或组织名称替换 OWNER，用你的仓库名称替换 REPO。

我们如何计算访问量

对特定仓库的每个工具调用进行计数。

自定义徽章

你可以通过参数自定义徽章的外观：

参数	描述	默认值	示例
color	徽章值的颜色	aquamarine	?color=green
label	徽章标签	GitMCP	Documentation

请联系我们！

❓ 常见问题

什么是模型上下文协议？

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

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

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

GitMCP 是否兼容所有 GitHub 项目？

绝对兼容！GitMCP 可以与任何公共 GitHub 仓库一起工作，无需任何修改。它优先考虑 llms.txt 文件，并在前者不可用时回退到 README.md 或其他页面。未来的更新旨在支持更多的文档方法，甚至动态生成内容。

GitMCP 是否收费？

不，GitMCP 是一个免费的服务，对社区没有任何费用。

🔒 隐私

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

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

👥 贡献

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

本地开发设置

1. 克隆仓库

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

2. 安装依赖项

   pnpm install
   

3. 本地运行开发

   npm run dev
   # 或
   pnpm dev
   

使用 MCP Inspector 进行测试

1. 安装 MCP Inspector 工具：

   npx @modelcontextprotocol/inspector
   

2. 在 Inspector 界面中：

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

📄 许可证

本项目根据 Apache 许可证 2.0 授权。

免责声明

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

Star 历史