GitMCP Documentation

GitMCP offers two main ways to connect to GitHub content via MCP URLs. Choose the format that best fits your workflow:

1. Specific Repository: Targets a single project. Use this for stability and security when working with specific libraries.

   • For GitHub repositories: gitmcp.io/{owner}/{repo}
   • For GitHub Pages sites: {owner}.gitmcp.io/{repo}

2. Generic/Dynamic Server: Allows the AI to decide which repository to access based on your prompt. Use this for maximum flexibility.

   • URL: gitmcp.io/docs

Follow these steps to deploy the server to Cloudflare:

1. Create a KV namespace for OAuth: npx wrangler@latest kv namespace create remote-mcp-server-oauth-kv
2. Retrieve the KV namespace ID from the command output and add it to your wrangler.jsonc file.
3. Deploy the worker: npm run deploy

Once deployed to Cloudflare, update your Claude Desktop configuration to point to your production workers.dev URL using the mcp-remote proxy.

1. Open your Claude Desktop configuration file.
2. Update the args to use your specific worker URL:

{
  "mcpServers": {
    "math": {
      "command": "npx",
      "args": ["mcp-remote", "https://worker-name.account-name.workers.dev/sse"]
    }
  }
}

3. Restart Claude.

Update your Windsurf configuration file at ~/.codeium/windsurf/mcp_config.json to include the GitMCP server URL.

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

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.

Use the following details:

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

To connect Claude Desktop, go to Settings > Developer > Edit Config and add the following configuration. This uses npx to run the remote MCP connection.

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

You can use the MCP Inspector to explore the MCP API via SSE (Server-Sent Events).

1. Start the inspector: npx @modelcontextprotocol/inspector
2. In the inspector interface (usually http://localhost:5173), set the Transport Type to SSE.
3. Enter the server URL: http://localhost:8787/sse (for local) or your workers.dev/sse URL (for remote).
4. Click Connect.
5. If prompted, navigate the (mock) user/password login screen by entering any email and password.

Once connected, you can list and call defined tools directly from the inspector.

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": []
    }
  }
}

To use GitMCP in Cursor, update your local MCP configuration file at ~/.cursor/mcp.json with the chosen GitMCP URL.

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

Update your VSCode configuration file at .vscode/mcp.json using the sse type.

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

Navigate to the MCP section in Augment Code settings and add a new server named git-mcp Docs using either the command line or a JSON configuration.

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

Or via JSON:

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

To set up a local development environment for the remote MCP server, clone the repository, install dependencies, and run the development command using nx.

1. Clone the repository: git clone git@github.com:cloudflare/ai.git
2. Install dependencies: cd ai && npm install
3. Run the server locally: npx nx dev remote-mcp-server

The server should be accessible at http://localhost:8787/.

Note: The repository path in the instructions refers to cloudflare/ai, ensure you are in the correct directory after cloning.

# clone the repository
git clone git@github.com:cloudflare/ai.git

# install dependencies
cd ai
npm install

# run locally
npx nx dev remote-mcp-server