Github Mapper

🚀 GitHub Repository 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 obtain detailed information about specified repositories, including their structure and summary statistics.

🚀 Quick Start

GitHub Mapper is a Model Context Protocol (MCP) server. It enables users to authenticate with a GitHub personal access token, map and analyze the structure of GitHub repositories, and obtain summary information about repositories.

✨ Features

• Set a GitHub personal access token for authentication.
• Map and analyze the structure of GitHub repositories.
• Obtain summary information about repositories (stars, forks, languages, etc.).
• Provide a detailed repository file structure.

📦 Installation

Automatic Installation via Smithery

Automatically install GitHub Mapper on Claude Desktop via Smithery:

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

Manual Installation

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
   

💻 Usage Examples

Basic Usage

1. Start the server:

   npm start
   

2. The server will run on standard input and output, allowing communication with the MCP client.

Advanced Usage

Available Tools

1. set-github-token

Set a GitHub personal access token for authentication.

• Create your personal access token here. Select a classic token. Scope: repo

Example, in your IDE or Claude Desktop:

Please set -github-token to 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

2. map-github-repo

Map the GitHub repository structure and provide summary information.

Example:

Please map -github-repo https://github.com/dazeb/MCP-Github-Mapper

Manual Installation in Cline or Roo - Cline MCP Client

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

Example Output

Repository Analysis Summary:

Name: Hello - World
Description: My first repository on GitHub.
Number of Stars: 123
Number of Forks: 45
Language: JavaScript
Number of Contributors: 6

File Structure:
- .github/workflows/
  - ci.yml
- README.md
- package.json
- src/
  - index.js
  - App.js

🔧 Technical Details

Prerequisites

• Node.js (v18.0.0 or higher is recommended).
• npm (provided with Node.js).
• A GitHub personal access token with appropriate permissions.

Error Handling

• If the Node.js version does not meet the requirements, you may encounter compatibility issues.
• If a valid GitHub token is not set, the repository mapping function will not work properly.

🤝 Contributing

We welcome community contributions! Please refer to our CONTRIBUTING.md file to learn how to get involved.

📄 License

This project is protected under the MIT License.