Github

🚀 GitHub MCP (Model Context Protocol) Server

Hello! This is my first GitHub MCP Server, which allows MCP-compatible LLLMs (such as Claude) to interact with the GitHub API through my MCP server.

🚀 Quick Start

✨ Features

MCP mainly supports two types of features:

• Tools (4):
  • create-issue: Create a new issue in a GitHub repository.
  • get-repo-info: Get information about a specific GitHub repository.
  • list-issues: List issues in a GitHub repository.
  • search-repos: Search for GitHub repositories.
• Prompts (5):
  • create-issue-description: Generate a description for a GitHub issue.
  • create-pull-request-description: Generate a description for a GitHub pull request.
  • search-repos-prompt: Generate a query for searching GitHub repositories.
  • create-issue-prompt: Generate parameters for creating a GitHub issue.
  • enhance-github-response: Format and enhance the raw GitHub API response data.

You can write your own prompts or select appropriate ones from the MCP dropdown menu in the "Select Integration" option for testing.

📦 Installation

Requirements

• TypeScript (programming language)
• Octokit (for sending API requests to GitHub)
• Model Context Protocol SDK

Steps to Set Up the Project Locally

1. Clone the repository.
2. Run npm install.
3. Create a .env file based on the .env.example file.
4. To compile TypeScript files to JavaScript, run npx tsc.
5. Finally, to run the project, run node build/index.js.

💻 Usage Examples

Testing Methods

You have two ways to test your MCP server:

• MCP Inspector
• Claude Desktop

Testing with MCP Inspector

1. Run npx @modelcontextprotocol/inspector node build/index.js in the terminal.
2. Open http://localhost:5173.
3. Now you can see the MCP Inspector and conduct tests.

Testing with Claude Desktop

1. Download and install Claude Desktop from here.
2. Go to File > Settings... > Developer > Edit Config.
3. It will open the location of the claude_desktop_config.json file.
4. Open the file in a code editor and add the following content:

{
    "mcpServers": {
        "gh": {
            "command": "node",
            "args": ["Absolute\\Path\\To\\Your\\index.js\\File"],
            "env": {
                "GITHUB_TOKEN": "Your GitHub Personal Access Token"
            }
        }
    }
}

5. Quit and reopen Claude Desktop.