Skip to content
Back to search

git-mcp

Put an end to code hallucinations! GitMCP is a free, open-source, remote MCP server for any GitHub project

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/idosal--git-mcp/badge.svg)](/listings/idosal--git-mcp)

HTML

<a href="/listings/idosal--git-mcp"><img src="/api/listings/idosal--git-mcp/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

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`:

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

Connecting Claude Desktop

1. In Claude Desktop, go to Settings > Developer > Edit Config 2. Replace the configuration with:

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

Connecting Windsurf

Update your Windsurf configuration file at `~/.codeium/windsurf/mcp_config.json`:

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

Connecting VSCode

Update your VSCode configuration file at `.vscode/mcp.json`:

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

Connecting Cline

Update your Cline configuration file at `~/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": []
       }
     }
   }

Connecting Highlight AI

1. Open Highlight AI and click the plugins icon (@ symbol) in the sidebar 2. Click **Installed Plugins** at the top of the sidebar 3. Select **Custom Plugin** 4. Click **Add a plugin using a custom SSE URL**

Plugin name: `gitmcp` SSE URL: `https://gitmcp.io/{owner}/{repo}`

For more details on adding custom MCP servers to HighlightAI, refer to [the documentation](https://docs.highlightai.com/plugins/custom).

Connecting Augment Code

1. Open Augment Code settings 2. Navigate to the MCP section 3. Add a new MCP server with the following details:

Name the MCP server: `git-mcp Docs`

Use this command:

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

Or use the following configuration:

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

Connecting Msty AI

1. Open Msty Studio 2. Go to Tools > Import Tools from JSON Clipboard 3. Paste the following configuration:

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

For more details on configuring MCP servers in Augment Code, visit [the Augment Code documentation](https://docs.augmentcode.com/setup-augment/mcp).

> **Note:** Remember to replace `{owner}` and `{repo}` with the actual GitHub username/organization and repository name. You can also use the dynamic endpoint `https://gitmcp.io/docs` to allow your AI to access any repository on demand.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 399 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # GitMCP
  2. <p align="center">
  3. <img width="884" alt="image" src="https://github.com/user-attachments/assets/2bf3e3df-556c-49c6-ab7b-36c279d53bba" />
  4. </p>
  5. <p align="center">
  6. <a href="#-what-is-gitmcp">What is GitMCP</a> •
  7. <a href="#-features">Features</a> •
  8. <a href="#-getting-started">Getting Started</a> •
  9. <a href="#-how-it-works">How It Works</a> •
  10. <a href="#-badge">Badge</a> •
  11. <a href="#-examples">Examples</a> •
  12. <a href="#-faq">FAQ</a> •
  13. <a href="#-privacy">Privacy</a> •
  14. <a href="#-contributing">Contributing</a> •
  15. <a href="#-license">License</a>
  16. </p>
  17. <div align="center">
  18. [![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/idosal/git-mcp)](https://gitmcp.io/idosal/git-mcp)
  19. [![Twitter Follow](https://img.shields.io/twitter/follow/idosal1?style=social)](https://twitter.com/idosal1)
  20. [![Twitter Follow](https://img.shields.io/twitter/follow/liadyosef?style=social)](https://twitter.com/liadyosef)
  21. </div>
  22. <div align="center">
  23. <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 Badge"></a>
  24. </div>
  25. ## 🤔 What is GitMCP?
  26. **Stop vibe-hallucinating and start vibe-coding!**
  27. [GitMCP](https://gitmcp.io) is a free, open-source, remote [Model Context Protocol (MCP)](https://docs.anthropic.com/en/docs/agents-and-tools/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.
  28. GitMCP supports **two flavors** -
  29. * **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.
  30. * **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.
  31. **With GitMCP:**
  32. * AI assistants access the *latest* documentation and code directly from the source.
  33. * Get accurate API usage and reliable code examples.
  34. * Work effectively even with niche, new, or rapidly changing libraries.
  35. * Significantly reduced hallucinations and improved code correctness.
  36. For example, this side-by-side comparison shows the result for the same one-shot prompt in Cursor when creating a [three.js](https://github.com/mrdoob/three.js) scene -
  37. https://github.com/user-attachments/assets/fbf1b4a7-f9f0-4c0e-831c-4d64faae2c45
  38. ## ✨ Features
  39. - 😎 **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!
  40. - 🧠 **No More Hallucinations**: With GitMCP, your AI assistant can provide accurate and relevant answers to your questions.
  41. - ☁️ **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.
  42. - 💬 **Embedded Chat**: Start quickly by chatting directly with the repository's documentation through our in-browser chat!
  43. - ✅ **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!
  44. <video src="https://github.com/user-attachments/assets/2c3afaf9-6c08-436e-9efd-db8710554430"></video>
  45. ## 🚀 Getting Started
  46. Using GitMCP is easy! Simply follow these steps:
  47. ### Step 1: Choose the type of server you want
  48. Choose one of these URL formats depending on what you want to connect to:
  49. - For GitHub repositories: `gitmcp.io/{owner}/{repo}`
  50. - For GitHub Pages sites: `{owner}.gitmcp.io/{repo}`
  51. - For a generic tool that supports any repository (dynamic): `gitmcp.io/docs`
  52. Replace `{owner}` with the GitHub username or organization name, and `{repo}` with the repository name.
  53. For your convenience, you can also use the conversion tool on the landing page to format the GitHub URL into an MCP URL!
  54. ### Step 2: Connect your AI assistant
  55. Select your AI assistant from the options below and follow the configuration instructions:
  56. #### Connecting Cursor
  57. Update your Cursor configuration file at `~/.cursor/mcp.json`:
  58. ```json
  59. {
  60. "mcpServers": {
  61. "gitmcp": {
  62. "url": "https://gitmcp.io/{owner}/{repo}"
  63. }
  64. }
  65. }
  66. ```
  67. #### Connecting Claude Desktop
  68. 1. In Claude Desktop, go to Settings > Developer > Edit Config
  69. 2. Replace the configuration with:
  70. ```json
  71. {
  72. "mcpServers": {
  73. "gitmcp": {
  74. "command": "npx",
  75. "args": [
  76. "mcp-remote",
  77. "https://gitmcp.io/{owner}/{repo}"
  78. ]
  79. }
  80. }
  81. }
  82. ```
  83. #### Connecting Windsurf
  84. Update your Windsurf configuration file at `~/.codeium/windsurf/mcp_config.json`:
  85. ```json
  86. {
  87. "mcpServers": {
  88. "gitmcp": {
  89. "serverUrl": "https://gitmcp.io/{owner}/{repo}"
  90. }
  91. }
  92. }
  93. ```
  94. #### Connecting VSCode
  95. Update your VSCode configuration file at `.vscode/mcp.json`:
  96. ```json
  97. {
  98. "servers": {
  99. "gitmcp": {
  100. "type": "sse",
  101. "url": "https://gitmcp.io/{owner}/{repo}"
  102. }
  103. }
  104. }
  105. ```
  106. #### Connecting Cline
  107. Update your Cline configuration file at `~/Library/Application Support/Code/User/globalStorage/saoudrizwan.claude-dev/settings/cline_mcp_settings.json`:
  108. ```json
  109. {
  110. "mcpServers": {
  111. "gitmcp": {
  112. "url": "https://gitmcp.io/{owner}/{repo}",
  113. "disabled": false,
  114. "autoApprove": []
  115. }
  116. }
  117. }
  118. ```
  119. #### Connecting Highlight AI
  120. 1. Open Highlight AI and click the plugins icon (@ symbol) in the sidebar
  121. 2. Click **Installed Plugins** at the top of the sidebar
  122. 3. Select **Custom Plugin**
  123. 4. Click **Add a plugin using a custom SSE URL**
  124. Plugin name: `gitmcp`
  125. SSE URL: `https://gitmcp.io/{owner}/{repo}`
  126. For more details on adding custom MCP servers to HighlightAI, refer to [the documentation](https://docs.highlightai.com/plugins/custom).
  127. #### Connecting Augment Code
  128. 1. Open Augment Code settings
  129. 2. Navigate to the MCP section
  130. 3. Add a new MCP server with the following details:
  131. Name the MCP server: `git-mcp Docs`
  132. Use this command:
  133. ```bash
  134. npx mcp-remote https://gitmcp.io/{owner}/{repo}
  135. ```
  136. Or use the following configuration:
  137. ```json
  138. {
  139. "mcpServers": {
  140. "git-mcp Docs": {
  141. "command": "npx",
  142. "args": [
  143. "mcp-remote",
  144. "https://gitmcp.io/{owner}/{repo}"
  145. ]
  146. }
  147. }
  148. }
  149. ```
  150. #### Connecting Msty AI
  151. 1. Open Msty Studio
  152. 2. Go to Tools > Import Tools from JSON Clipboard
  153. 3. Paste the following configuration:
  154. ```json
  155. {
  156. "mcpServers": {
  157. "git-mcp Docs": {
  158. "command": "npx",
  159. "args": [
  160. "mcp-remote",
  161. "https://gitmcp.io/{owner}/{repo}"
  162. ]
  163. }
  164. }
  165. }
  166. ```
  167. For more details on configuring MCP servers in Augment Code, visit [the Augment Code documentation](https://docs.augmentcode.com/setup-augment/mcp).
  168. > **Note:** Remember to replace `{owner}` and `{repo}` with the actual GitHub username/organization and repository name. You can also use the dynamic endpoint `https://gitmcp.io/docs` to allow your AI to access any repository on demand.
  169. ## ⚙ How It Works
  170. GitMCP connects your AI assistant to GitHub repositories using the Model Context Protocol (MCP), a standard that lets AI tools request additional information from external sources.
  171. What happens when you use GitMCP:
  172. 1. **You provide the GitMCP URL** to your AI assistant (e.g., `gitmcp.io/microsoft/typescript`). GitMCP exposes tools like documentation fetching, smart search, code search, etc.
  173. 2. **Prompt the AI assistant** on documentation/code-related questions.
  174. 3. **Your AI sends requests** to GitMCP to use its tools (with your approval).
  175. 4. **GitMCP executes the AI's request** and returns the requested data.
  176. 5. **Your AI receives the information** and generates a more accurate, grounded response without hallucinations.
  177. ### Supported Documentation
  178. GitMCP currently supports the following documents (in order of priority):
  179. 1. [llms.txt](https://llmstxt.org)
  180. 2. AI-optimized version of the project's documentation
  181. 3. `README.md`/root
  182. ## 💡 Examples
  183. Here are some examples of how to use GitMCP with different AI assistants and repositories:
  184. ### Example 1: Using Windsurf with a specific repository
  185. For the GitHub repository `https://github.com/microsoft/playwright-mcp`, add `https://gitmcp.io/microsoft/playwright-mcp` as an MCP server to Windsurf.
  186. **Prompt to Claude:**
  187. > "How do I use the Playwright MCP"
  188. Windsurf will pull the relevant documentation from GitMCP to implement the memory feature correctly.
  189. ### Example 2: Using Cursor with a GitHub Pages site
  190. For the GitHub Pages site `langchain-ai.github.io/langgraph`, add `https://langchain-ai.gitmcp.io/langgraph` as an MCP server to Cursor.
  191. **Prompt to Cursor:**
  192. > "Add memory to my LangGraph agent"
  193. Cursor will pull the relevant documentation and code from GitMCP to correctly implement the memory feature.
  194. ### Example 3: Using Claude Desktop with the dynamic endpoint
  195. You don't have to pick specific repositories. The generic `gitmcp.io/docs` endpoint allows AI to pick the GitHub project on the fly!
  196. **Prompt to any AI assistant:**
  197. > "I want to learn about the OpenAI Whisper speech recognition model. Explain how it works."
  198. Claude will pull the data from GitMCP and answer the question.
  199. ## 🛠️ Tools
  200. GitMCP provides AI assistants with several valuable tools to help them access, understand, and query GitHub repositories.
  201. ### `fetch_<repo-name>_documentation`
  202. This tool gets the primary documentation from a GitHub repository. It works by retrieving relevant documentation (e.g., `llms.txt`). This gives the AI a good overview of what the project is about
  203. **When it's useful:** For general questions about a project's purpose, features, or how to get started
  204. ### `search_<repo-name>_documentation`
  205. This tool lets the AI search through a repository's documentation by providing a specific search query. Instead of loading all the documentation (which could be very large), it uses intelligent search to find just the relevant parts.
  206. **When it's useful:** For specific questions about particular features, functions, or concepts within a project
  207. ### `fetch_url_content`
  208. This tool helps the AI get information from links mentioned in the documentation. It retrieves the content from those links and converts it to a format the AI can easily read.
  209. **When it's useful:** When documentation references external information that would help answer your question
  210. ### `search_<repo-name>_code`
  211. This tool searches through the actual code in the repository using GitHub's code search. It helps AI find specific code examples or implementation details.
  212. **When it's useful:** When you want examples of how something is implemented or need technical details not covered in documentation
  213. > **Note:** When using the dynamic endpoint (`gitmcp.io/docs`), these tools are named slightly differently (`fetch_generic_documentation`, `search_generic_code`, and `search_generic_documentation`) and need additional information about which repository to access.
  214. ## 📊 Badge
  215. GitMCP has a badge for your repository's README. It allows users to quickly access your documentation through their IDE or browser (using the embedded chat). It also showcases how many times your documentation has been accessed through GitMCP.
  216. Example (`idosal/git-mcp`): [![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/idosal/git-mcp)](https://gitmcp.io/idosal/git-mcp)
  217. ### Adding the Badge to Your Repository
  218. Add the following to your `README.md`:
  219. ```markdown
  220. [![GitMCP](https://img.shields.io/endpoint?url=https://gitmcp.io/badge/OWNER/REPO)](https://gitmcp.io/OWNER/REPO)
  221. ```
  222. Replace `OWNER` with your GitHub username or organization, and `REPO` with your repository name.
  223. ### How We Count Views
  224. Increment for each tool call on the specific repository.
  225. ### Customizing the Badge
  226. You can customize the badge's appearance with parameters:
  227. | Parameter | Description | Default | Example |
  228. |-----------|-------------|---------|---------|
  229. | `color` | Color for the badge value | `aquamarine` | `?color=green` |
  230. | `label` | Badge label | `GitMCP` | `Documentation`
  231. Please reach out if you need help!
  232. ## ❓ FAQ
  233. ### What is the Model Context Protocol?
  234. The [Model Context Protocol](https://modelcontextprotocol.io/introduction) is a standard that allows AI assistants to request and receive additional context from external sources in a structured manner, enhancing their understanding and performance.
  235. ### Does GitMCP work with any AI assistant?
  236. Yes, GitMCP is compatible with any AI assistant supporting the Model Context Protocol, including tools like Cursor, VSCode, Claude, etc.
  237. ### Is GitMCP compatible with all GitHub projects?
  238. Absolutely! GitMCP works with any public GitHub repository without requiring any modifications. It prioritizes the `llms.txt` file and falls back to `README.md` or other pages if the former is unavailable. Future updates aim to support additional documentation methods and even generate content dynamically.
  239. ### Does GitMCP cost money?
  240. No, GitMCP is a free service to the community with no associated costs.
  241. ## 🔒 Privacy
  242. GitMCP is deeply committed to its users' privacy. The service doesn't have access to or store any personally identifiable information as it doesn't require authentication. In addition, it doesn't store any queries sent by the agents. Moreover, as GitMCP is an open-source project, it can be deployed independently in your environment.
  243. GitMCP only accesses content that is already publicly available and only when queried by a user. GitMCP does not automatically scrape repositories. Before accessing any GitHub Pages site, the code checks for `robots.txt` rules and follows the directives set by site owners, allowing them to opt out. Please note that GitMCP doesn't permanently store data regarding the GitHub projects or their content.
  244. ## 👥 Contributing
  245. We welcome contributions, feedback, and ideas! Please review our [contribution](https://github.com/idosal/git-mcp/blob/main/.github/CONTRIBUTING.md) guidelines.
  246. ### Local Development Setup
  247. 1. **Clone the repository**
  248. ```bash
  249. git clone https://github.com/idosal/git-mcp.git
  250. cd git-mcp
  251. ```
  252. 2. **Install dependencies**
  253. ```bash
  254. pnpm install
  255. ```
  256. 3. **Run locally for development**
  257. ```bash
  258. npm run dev
  259. # or
  260. pnpm dev
  261. ```
  262. #### Using MCP Inspector for Testing
  263. 1. Install the MCP Inspector tool:
  264. ```bash
  265. npx @modelcontextprotocol/inspector
  266. ```
  267. 2. In the inspector interface:
  268. - Set Transport Type to `SSE`
  269. - Enter your GitMCP URL (e.g., `http://localhost:5173/docs`)
  270. - Click "Connect"
  271. ## 📄 License
  272. This project is licensed under the [Apache License 2.0](LICENSE).
  273. ## Disclaimer
  274. GitMCP is provided "as is" without warranty of any kind. While we strive to ensure the reliability and security of our service, we are not responsible for any damages or issues that may arise from its use. GitHub projects accessed through GitMCP are subject to their respective owners' terms and conditions. GitMCP is not affiliated with GitHub or any of the mentioned AI tools.
  275. ## Star History
  276. [![Star History Chart](https://api.star-history.com/svg?repos=idosal/git-mcp&type=Timeline)](https://www.star-history.com/#idosal/git-mcp&Timeline)

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.