GitMCP 项目详细介绍

🚀 项目概述

GitMCP是一个免费、开源的远程Model Context Protocol (MCP)服务器，能够将任何GitHub项目（仓库或GitHub Pages）转换为文档中心。它使AI工具如Cursor能够访问最新的文档和代码，即使LLM从未遇到过这些内容，从而无缝地消除代码幻觉。

核心特性

• 😎 任何GitHub项目的最新文档：为AI助手提供对GitHub项目文档和代码的无缝访问，内置智能搜索功能帮助找到AI需要的确切内容
• 🧠 消除幻觉：使用GitMCP，AI助手可以提供准确且相关的答案
• ☁️ 零配置：GitMCP在云端运行，只需在IDE中添加GitMCP URL作为MCP服务器即可
• 💬 嵌入式聊天：通过浏览器内聊天直接与仓库文档对话
• ✅ 开放、免费且私密：完全开源免费使用，不收集个人信息或存储查询，支持自托管

🛠️ 工作原理

GitMCP使用Model Context Protocol (MCP)标准连接AI助手和GitHub仓库，该标准允许AI工具从外部源请求额外信息。

工作流程：

1. 向AI助手提供GitMCP URL（例如：gitmcp.io/microsoft/typescript）
2. GitMCP暴露文档获取、智能搜索、代码搜索等工具
3. 向AI助手询问文档/代码相关问题
4. AI助手向GitMCP发送请求使用其工具（需要您的批准）
5. GitMCP执行AI的请求并返回所需数据
6. AI助手接收信息并生成更准确、有根据的回应，无幻觉

📋 支持的文档格式

GitMCP目前按优先级顺序支持以下文档：

1. llms.txt - AI优化版本的项目文档
2. README.md
3. /root 目录下的其他文档

🔧 配置方式

URL格式选择

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

• GitHub仓库：gitmcp.io/{owner}/{repo}
• GitHub Pages网站：{owner}.gitmcp.io/{repo}
• 通用工具（支持任何仓库，动态）：gitmcp.io/docs

AI工具配置示例

Cursor配置

更新 ~/.cursor/mcp.json 文件：

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

Claude Desktop配置

在设置 > 开发者 > 编辑配置中替换配置：

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

Windsurf配置

更新 ~/.codeium/windsurf/mcp_config.json 文件：

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

🔨 可用工具

1. 获取文档 (fetch_documentation)

从GitHub仓库获取主要文档，通过检索相关文档（如llms.txt）为AI提供项目概览。

适用场景：关于项目目的、功能或入门指南的一般性问题

2. 搜索文档 (search_documentation)

让AI通过特定搜索查询在仓库文档中搜索，使用智能搜索找到相关部分而不是加载所有文档。

适用场景：关于项目内特定功能、函数或概念的具体问题

3. 获取链接内容 (fetch_link_content)

帮助AI从文档中提到的链接获取信息，检索这些链接的内容并转换为AI易读的格式。

适用场景：当文档引用有助于回答问题的外部信息时

4. 搜索代码 (search_code)

使用GitHub的代码搜索功能在仓库的实际代码中搜索，帮助AI找到特定代码示例或实现细节。

适用场景：需要实现示例或文档未涵盖的技术细节时

📊 徽章集成

GitMCP提供仓库徽章，允许用户通过IDE或浏览器快速访问文档，并展示通过GitMCP访问文档的次数。

添加徽章

在README.md中添加以下代码：

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

徽章自定义参数

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

🛡️ 隐私与安全

• 隐私承诺：GitMCP深度关注用户隐私，不需要身份验证，无法访问或存储任何个人身份信息
• 查询不存储：不存储代理发送的任何查询
• 开源透明：作为开源项目，可在您的环境中独立部署
• 按需访问：仅访问已公开可用的内容，且仅在用户查询时访问
• 遵循规则：访问GitHub Pages网站前检查robots.txt规则并遵循网站所有者设置的指令

🚦 使用限制

GitMCP仅在被查询时访问内容，不会自动抓取仓库。对于GitHub Pages网站，会检查并遵循robots.txt规则，允许网站所有者选择退出。GitMCP不会永久存储关于GitHub项目或其内容的数据。

💻 开发与贡献

本地运行

# 克隆仓库
git clone https://github.com/idosal/git-mcp.git
cd git-mcp

# 安装依赖
pnpm install

# 本地开发运行
npm run dev # 或 pnpm dev

MCP检查器工具

# 安装MCP检查器工具
npx @modelcontextprotocol/inspector

在检查器界面中：

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

📄 许可证

本项目采用Apache License 2.0许可证授权。

⚠️ 免责声明

GitMCP按"原样"提供，不提供任何形式的保证。虽然我们努力确保服务的可靠性和安全性，但我们不对使用中可能出现的任何损害或问题承担责任。通过GitMCP访问的GitHub项目受其各自所有者的条款和条件约束。GitMCP与GitHub或任何提到的AI工具均无关联。