GitHub Mapper MCP Server
GitHub Mapper is a Model Context Protocol (MCP) server that provides tools for mapping and analyzing GitHub repositories. It allows users to set a GitHub Personal Access Token and retrieve detailed information about a specified repository, including its structure and summary statistics.
Features
- Set GitHub Personal Access Token for authentication
- Map and analyze GitHub repository structure
- Retrieve repository summary information (stars, forks, language, etc.)
- Provide a detailed repository file structure
Prerequisites
- Node.js (v18.0.0 or later recommended)
- npm (comes with Node.js)
- A GitHub Personal Access Token with appropriate permissions
Installation
Installing via Smithery
To install GitHub Mapper for Claude Desktop automatically via Smithery:
Manual Installation
- Clone the repository:
- Install dependencies:
- Build the project:
Usage
- Start the server:
- The server will run on stdio, allowing it to communicate with MCP clients.
Available Tools
1. `set-github-token`
Sets the GitHub Personal Access Token for authentication.
- Create your Personal Access Token here. Choose Tokens (classic). Scopes: repo image
Example, in your IDE or Claude Desktop:
2. `map-github-repo`
Maps a GitHub repository structure and provides summary information.
Example:
Manual install in Cline or Roo-Cline MCP Client:
Example Output
Images
image
Error Handling
- If the GitHub token is not set, you'll receive an error message prompting you to use the
set-github-tokentool first.
- Invalid GitHub URLs or repository paths will result in appropriate error messages.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.
GitHub Mapper MCP Server
GitHub Mapper is a Model Context Protocol (MCP) server that provides tools for mapping and analyzing GitHub repositories. It allows users to set a GitHub Personal Access Token and retrieve detailed information about a specified repository, including its structure and summary statistics.
Features
- Set GitHub Personal Access Token for authentication
- Map and analyze GitHub repository structure
- Retrieve repository summary information (stars, forks, language, etc.)
- Provide a detailed repository file structure
Prerequisites
- Node.js (v18.0.0 or later recommended)
- npm (comes with Node.js)
- A GitHub Personal Access Token with appropriate permissions
Installation
Installing via Smithery
To install GitHub Mapper for Claude Desktop automatically via Smithery:
Manual Installation
- Clone the repository:
- Install dependencies:
- Build the project:
Usage
- Start the server:
- The server will run on stdio, allowing it to communicate with MCP clients.
Available Tools
1. `set-github-token`
Sets the GitHub Personal Access Token for authentication.
- Create your Personal Access Token here. Choose Tokens (classic). Scopes: repo image
Example, in your IDE or Claude Desktop:
2. `map-github-repo`
Maps a GitHub repository structure and provides summary information.
Example:
Manual install in Cline or Roo-Cline MCP Client:
Example Output
Images
image
Error Handling
- If the GitHub token is not set, you'll receive an error message prompting you to use the
set-github-tokentool first.
- Invalid GitHub URLs or repository paths will result in appropriate error messages.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License.