GitHub Mapper MCP server

GitHub Mapper is a Model Context Protocol (MCP) server that helps you analyze and map GitHub repositories. It retrieves detailed information about repositories including their structure, summary statistics, and other metadata using your GitHub Personal Access Token.

Installation Options

Installing via Smithery

The easiest way to install GitHub Mapper for Claude Desktop is through Smithery:

npx -y @smithery/cli install github-mapper-mcp-server --client claude

Manual Installation

If you prefer to install manually:

1. Clone the repository:

   git clone https://github.com/your-username/github-mapper-mcp-server.git
   cd github-mapper-mcp-server
   

2. Install dependencies:

   npm install
   

3. Build the project:

   npm run build
   

Prerequisites

Before using GitHub Mapper, ensure you have:

• Node.js (v18.0.0 or later recommended)
• npm (included with Node.js)
• A GitHub Personal Access Token with appropriate permissions

Running the Server

Start the server with:

npm start

The server runs on stdio, allowing it to communicate with MCP clients.

Available Tools

Setting Your GitHub Token

Use the set-github-token tool to authenticate with GitHub:

Please set-github-token to YOUR_GITHUB_TOKEN_HERE

To create a GitHub Personal Access Token:

1. Go to GitHub Settings → Developer settings → Personal access tokens
2. Choose "Tokens (classic)"
3. Ensure you select the "repo" scope

Mapping GitHub Repositories

The map-github-repo tool retrieves repository structure and information:

Please map-github-repo https://github.com/username/repository

Setup with Cline or Roo-Cline MCP Client

For manual installation with Cline or Roo-Cline, add this to your configuration:

{
  "mcpServers": {
    "github-mapper": {
      "command": "node",
      "args": ["/home/user/Documents/Cline/MCP/github-mapper/build/index.js"]
    }
  }
}

Example Response

When you map a repository, you'll receive structured output like:

Repository Analysis Summary:

Name: Hello-World
Description: My first repository on GitHub!
Stars: 1234
Forks: 567
Primary Language: JavaScript
Created: 2023-01-01
Last Updated: 2023-06-15

Repository Structure:

{
  "src": {
    "components": {
      "Header.js": null,
      "Footer.js": null
    },
    "pages": {
      "index.js": null,
      "about.js": null
    },
    "styles": {
      "global.css": null
    }
  },
  "public": {
    "images": {
      "logo.png": null
    },
    "favicon.ico": null
  },
  "package.json": null,
  "README.md": null
}

Troubleshooting

• If you receive an error message about the GitHub token, ensure you've used the set-github-token tool first
• Check that you're using a valid GitHub repository URL with the map-github-repo tool
• Verify that your Personal Access Token has the necessary permissions

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "github-mapper" '{"command":"node","args":["/home/user/Documents/Cline/MCP/github-mapper/build/index.js"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "github-mapper": {
            "command": "node",
            "args": [
                "/home/user/Documents/Cline/MCP/github-mapper/build/index.js"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "github-mapper": {
            "command": "node",
            "args": [
                "/home/user/Documents/Cline/MCP/github-mapper/build/index.js"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect