Installing via Smithery

Skip to content

You signed in with another tab or window. Reload
to refresh your session. You signed out in another tab or window. Reload
to refresh your session. You switched accounts on another tab or window. Reload
to refresh your session. Dismiss alert

dazeb / MCP-Github-Mapper Public

• Notifications
  You must be signed in to change notification settings

• Fork 2

• Star 11

MCP GitHub Mapper is a MCP tool that will map any repository remotely and import the map directly into your code editor.

11 stars
2 forks
Branches
Tags
Activity

Star

Notifications
You must be signed in to change notification settings

dazeb/MCP-Github-Mapper

main

2 Branches
0 Tags

Go to file

Code

Folders and files

| Name | | Name | Last commit message | Last commit date |
| --- | --- | --- | --- |
| Latest commit
-------------


dazeb

Merge pull request
#2
from smithery-ai/smithery/config-a2s0

Mar 13, 2025

b2aee0d
 · Mar 13, 2025

History
-------

12 Commits

| | |
| src | | src | Add initial project setup with environment configuration and TypeScri… | Dec 20, 2024 |
| .gitignore | | .gitignore | Update .gitignore and upgrade TypeScript to version 4.9.5 | Dec 20, 2024 |
| Dockerfile | | Dockerfile | Add Dockerfile | Jan 28, 2025 |
| README.md | | README.md | Update README | Jan 28, 2025 |
| package-lock.json | | package-lock.json | Update .gitignore and upgrade TypeScript to version 4.9.5 | Dec 20, 2024 |
| package.json | | package.json | Update .gitignore and upgrade TypeScript to version 4.9.5 | Dec 20, 2024 |
| smithery.yaml | | smithery.yaml | Add Smithery configuration | Jan 28, 2025 |
| tsconfig.json | | tsconfig.json | Add initial project setup with environment configuration and TypeScri… | Dec 20, 2024 |
| View all files | | |

Repository files navigation

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
:

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

1. Start the server:

   npm start
   

2. 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

Example, in your IDE or Claude Desktop:

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

2. map-github-repo

Maps a GitHub repository structure and provides summary information.

Example:

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

Manual install 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!
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
}

Images

Error Handling

• If the GitHub token is not set, you'll receive an error message prompting you to use the set-github-token tool 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.

About

MCP GitHub Mapper is a MCP tool that will map any repository remotely and import the map directly into your code editor.

Topics

mcp
cline
mcp-server
roocode

Resources

Readme

Activity

Stars

11 stars

Watchers

1 watching

Forks

2 forks

Report repository

Releases

No releases published

Contributors 2

• 
  dazeb Darren Bennett

• 
  calclavia Henry Mao

Languages

• TypeScript 84.8%

• Dockerfile 15.2%

You can’t perform that action at this time.