MCP-Github-Mapper

GitHub Mapper MCP Server provides tools to authenticate with a GitHub token, map repository structures, and retrieve repository summaries. Once running, clients can interact with the server to set a GitHub token, request a repository map, and obtain a detailed structure and metadata for a given GitHub repo. The available tools are designed to be simple single-purpose commands that MCP clients can invoke in sequence to authenticate, map, and inspect repositories. The server communicates via standard MCP channels, running as a Node.js process and exposing functions you can call from your MCP client integrations.

Prerequisites:

• Node.js v18.0.0 or later
• npm (comes with Node.js)
• Git (optional, for cloning the repo)
• A GitHub Personal Access Token (PAT) with repo permissions

Installation steps:

1. Install via Smithery (automatic) - recommended when deploying in Claude Desktop:

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

2. Manual installation from source:

• Clone the repository:

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

• Install dependencies:

npm install

• Build the project (if applicable):

npm run build

• Start the server:

npm start

Note: If you are integrating into an environment that uses a predefined MCP config, you may run the server via your preferred process manager and point to the built entry file (for example build/index.js) as shown in the mcp_config example.

Tips:

• You must provide a GitHub token with appropriate scopes to access repository data. Use the set-github-token tool/id mechanism when available in the MCP client to store it securely on the client side.
• If you see authentication errors, verify the GITHUB_TOKEN env var or the token stored by the MCP client.
• The server communicates via stdio in some configurations; ensure your MCP client is configured to capture stdout/stderr as needed.
• When mapping large repositories, expect longer processing times; consider testing with smaller repos first.
• If you plan to run in different environments (CLI, Claude, etc.), ensure the path to the built index.js matches your deployment layout and that the environment provides Node.js and npm access.