GitHub MCP server

This MCP server provides GitHub API integration through a Model Context Protocol (MCP) interface, allowing AI agents to interact with GitHub repositories and perform operations like fetching files, creating issues, and making pull requests.

Installation Guide

Prerequisites

• Python 3.11 or higher (recommended)
• GitHub Access Token

Installation Steps

1. Clone the repository:

   git clone https://github.com/mymadhavyadav07/Github-MCP-server.git
   cd Github-MCP-Server
   

2. Install dependencies:

   Using uv (recommended for Python 3.11+):

   uv venv
   uv pip install -r requirements.txt
   

3. Configure GitHub Access Token:

   • Create a .env file by copying the contents from .env.example
   • Add your GitHub access token to the file:

   GITHUB_TOKEN = "<GITHUB_TOKEN>"
   

   You can generate a token from GitHub's token settings page.

Setting Up With Claude

1. Download and install Claude Desktop

   • Get Claude Desktop from Claude's download page

2. Activate the virtual environment:

   .venv\Scripts\activate
   

3. Install the MCP Server in Claude:

   uv run mcp install main.py
   

4. Once installed, you can access the GitHub tools directly through Claude Desktop.

Available GitHub Tools

The MCP server provides the following GitHub operations as callable tools:

GitHub User Operations

• get_user_bio: Retrieves the biography information of a GitHub user

Repository Operations

• get_github_files: Recursively fetches all files and directories from a GitHub repository starting at a specified path
• get_file_content: Fetches the content of a specific file from a GitHub repository

Collaboration Tools

• create_pull_request_with_branch: Creates a new branch and then submits a pull request
• create_github_issue: Creates an issue on a GitHub repository

Usage Examples

After installing the MCP server in Claude, you can interact with it by requesting GitHub operations. For example:

Fetching File Content

Can you get the contents of the README.md file from the mymadhavyadav07/Github-MCP-server repository?

Creating an Issue

Please create an issue in the mymadhavyadav07/Github-MCP-server repository titled "Feature Request: Add Support for Repository Creation" with a description explaining the feature.

Working with Pull Requests

Create a pull request that adds a simple documentation update to the README file in the repository.

The MCP server will handle these requests by calling the appropriate GitHub API endpoints through the configured tools.

How to install this MCP server

For Claude Code

To add this MCP server to Claude Code, run this command in your terminal:

claude mcp add-json "github" '{"command":"python","args":["-m","main.py"]}'

See the official Claude Code MCP documentation for more details.

For Cursor

There are two ways to add an MCP server to Cursor. The most common way is to add the server globally in the ~/.cursor/mcp.json file so that it is available in all of your projects.

If you only need the server in a single project, you can add it to the project instead by creating or adding it to the .cursor/mcp.json file.

Adding an MCP server to Cursor globally

To add a global MCP server go to Cursor Settings > Tools & Integrations and click "New MCP Server".

When you click that button the ~/.cursor/mcp.json file will be opened and you can add your server like this:

{
    "mcpServers": {
        "github": {
            "command": "python",
            "args": [
                "-m",
                "main.py"
            ]
        }
    }
}

Adding an MCP server to a project

To add an MCP server to a project you can create a new .cursor/mcp.json file or add it to the existing one. This will look exactly the same as the global MCP server example above.

How to use the MCP server

Once the server is installed, you might need to head back to Settings > MCP and click the refresh button.

The Cursor agent will then be able to see the available tools the added MCP server has available and will call them when it needs to.

You can also explicitly ask the agent to use the tool by mentioning the tool name and describing what the function does.

For Claude Desktop

To add this MCP server to Claude Desktop:

1. Find your configuration file:

• macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
• Windows: %APPDATA%\Claude\claude_desktop_config.json
• Linux: ~/.config/Claude/claude_desktop_config.json

2. Add this to your configuration file:

{
    "mcpServers": {
        "github": {
            "command": "python",
            "args": [
                "-m",
                "main.py"
            ]
        }
    }
}

3. Restart Claude Desktop for the changes to take effect