MCP Github Mapper

🚀 GitHub Mapper MCP Server

GitHub Mapper is a Model Context Protocol (MCP) server that offers tools for mapping and analyzing GitHub repositories. It enables users to set a GitHub personal access token and retrieve detailed information about specified repositories, including their structure and summary statistics.

🚀 Quick Start

GitHub Mapper is a Model Context Protocol (MCP) server. It provides tools for mapping and analyzing GitHub repositories, allowing users to set tokens and retrieve repository details.

✨ Features

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

📦 Installation

Automatic Installation via Smithery

Automatically install GitHub Mapper for Claude Desktop through 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 stdio, allowing communication with MCP clients.

Advanced Usage

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 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 as -github-token

2. map-github-repo

Map the structure of a GitHub repository and provide summary information.

Example:

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

Manual Installation into Cline or Roo - Cline MCP Clients

{
  "name": "your-app-name",
  "version": "1.0.0",
  "description": "Your app description here",
  "main": "index.js",
  "scripts": {
    "start": "node index.js"
  },
  "dependencies": {
    "github-mapper": "^1.2.3"
  }
}

📚 Documentation

Example Output

Summary Information

{
  "Repository Name": "your-repository-name",
  "Number of Stars": 123,
  "Number of Branches": 45,
  "Language": "JavaScript",
  "Main Dependencies": ["express", "react"]
}

Repository Structure

.
├── README.md
├── package.json
├── index.js
└── src/
    ├── components/
    │   └── App.jsx
    └── services/
        └── api.js

Images

Example image of GitHub Mapper: Image Link Example image of GitHub token setup: Image Link

Error Handling

If you encounter issues, check the following common errors:

• Token not set:
  • Ensure you have run the set-github-token command.
• Invalid URL:
  • Confirm that the repository URL is correct.

Contribution

Welcome to submit issues and pull requests for GitHub Mapper! Please check the contribution guidelines in the GitHub repository.

📄 License

This project is protected by the MIT License.