STARWARCLOUD STARWAR.AI
返回市场
Git-MCP

Git-MCP

作者：idosal7021 星标更新：2025-08-22
安装使用来源：spider==github.com

项目介绍

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">

GitMCP Twitter Follow Twitter Follow

</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 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. 将配置替换为： 
    {
  "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}"
      ]
    }
  }
}

连接Msty AI

  1. 打开Msty Studio
  2. 转到工具 > 从JSON剪贴板导入工具
  3. 粘贴以下配置：
{
  "mcpServers": {
    "git-mcp 文档": {
      "command": "npx",
      "args": [
        "mcp-remote",
        "https://gitmcp.io/{owner}/{repo}"
      ]
    }
  }
}

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

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

⚙ 如何工作

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

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

  1. 你提供GitMCP URL 给你的AI助手（例如 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代理中添加记忆"

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）：GitMCP

向你的仓库添加徽章

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

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

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

我们如何计算访问次数

每次对特定仓库的工具调用都会增加一次计数。

自定义徽章

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

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

请联系我们！

❓ 常见问题

模型上下文协议是什么？

模型上下文协议是一种标准，允许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项目及其内容的数据。

👥 贡献

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

本地开发设置

  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 License 2.0 授权。

免责声明

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

Star History

Star History Chart