📇 ☁️ - Generic remote server that provides documentation for any GitHub repository or project
GitMCP
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
What is GitMCP •
Features •
Getting Started •
How It Works •
Badge •
Examples •
FAQ •
Privacy •
Contributing •
License
🤔 What is GitMCP?
**Stop vibe-hallucinating and start vibe-coding!**
GitMCP is a free, open-source, remote Model Context Protocol (MCP) server that transforms **any** GitHub project (repositories or GitHub pages) into a documentation hub. It enables AI tools like Cursor to access up-to-date documentation and code, even if the LLM has never encountered them, thereby eliminating code hallucinations seamlessly.
GitMCP supports **two flavors** -
* **Specific Repository (gitmcp.io/{owner}/{repo} or {owner}.gitmcp.io/{repo}):** Use these when you primarily work with a select number of libraries. This ensures your AI assistant always targets the correct project, enhancing security and relevance by preventing access to unintended repositories.
* **Generic Server (gitmcp.io/docs):** Use this for maximum flexibility when you need to switch between different repositories frequently. The AI assistant will prompt you (or decide based on context) which repository to access for each request. Be mindful that this relies on correctly identifying the target repository each time.
**With GitMCP:**
* AI assistants access the *latest* documentation and code directly from the source.
* Get accurate API usage and reliable code examples.
* Work effectively even with niche, new, or rapidly changing libraries.
* Significantly reduced hallucinations and improved code correctness.
For example, this side-by-side comparison shows the result for the same one-shot prompt in Cursor when creating a three.js scene -
https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45
✨ Features
- 😎 **Latest Documentation on ANY GitHub Project**: Grant your AI assistant seamless access to the GitHub project's documentation and code. The built-in smart search capabilities help find exactly what the AI needs without using too many tokens!
- 🧠 **No More Hallucinations**: With GitMCP, your AI assistant can provide accurate and relevant answers to your questions.
- ☁️ **Zero Setup**: GitMCP runs in the cloud. Simply add the chosen GitMCP URL as an MCP server in your IDE — no downloads, installations, signups, or changes are required.
- 💬 **Embedded Chat**: Start quickly by chatting directly with the repository's documentation through our in-browser chat!
- ✅ **Open, Free, and Private**: GitMCP is open-source and completely free to use. It doesn't collect personal information or store queries. You can even self-host it!
🚀 Getting Started
Using GitMCP is easy! Simply follow these steps:
Step 1: Choose the type of server you want
Choose one of these URL formats depending on what you want to connect to:
- For GitHub repositories: gitmcp.io/{owner}/{repo}
- For GitHub Pages sites: {owner}.gitmcp.io/{repo}
- For a generic tool that supports any repository (dynamic): gitmcp.io/docs
Replace {owner} with the GitHub username or organization name, and {repo} with the repository name.
For your convenience, you can also use the conversion tool on the landing page to format the GitHub URL into an MCP URL!
Step 2: Connect your AI assistant
Select your AI assistant from the options below and follow the configuration instructions:
Connecting Cursor
Update your Cursor configuration file at ~/.cursor/mcp.json:
Connecting Claude Desktop
1. In Claude Desktop, go to Settings > Developer > Edit Config
2. Replace the configuration with:
Connecting Windsurf
Update your Windsurf configuration file at ~/.codeium/windsurf/mcp_config.json:
Connecting VSCode
Update your VSCode configuration file at .vscode/mcp.json:
Connecting Cline
Update your Cline configuration file at ~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json:
Connecting Highlight AI
1. Open Highlight AI and click the plugins icon (@ symbol) in the sidebar