Github MCP Server Ts

🚀 GitHub MCP Usage Instructions

This document provides a comprehensive guide on using GitHub MCP, covering issue management, pull request creation, milestone and label management, comment handling, search query syntax, configuration guides, and build instructions.

🚀 Quick Start

Prerequisites

• A GitHub account.
• Personal access token with appropriate permissions.

✨ Features

• Create issues, pull requests, milestones, labels, and comments using the GitHub API.
• Use various search query syntaxes to find code, issues, and users on GitHub.
• Configure and run the MCP server in different environments.

📦 Installation

Personal Access Token Creation

1. Log in to your GitHub account.
2. Navigate to the Personal Access Tokens page.
3. Click the "Generate new token" button.
4. Select the required permissions and click "Generate token".
5. Copy the token and store it in a secure location.

Using in Claude Desktop

Docker Configuration

# Install Docker
curl -fsSL https://get.docker.com | bash -s docker

# Run the MCP server
docker run -it --rm -p 8080:8080 mcp-server:latest

NPX Configuration

npm install -g mcp-cli
mcp serve

💻 Usage Examples

Issue Creation Example

curl -X POST https://api.github.com/repos/{owner}/{repo}/issues \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"This is a test issue","body":"This issue is for testing the GitHub API."}'

Pull Request Creation Example

curl -X POST https://api.github.com/repos/{owner}/{repo}/pulls \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"This is a test pull request","body":"This pull request is for testing the GitHub API.","head":"main","base":"main"}'

Milestone Management

Create a New Milestone

curl -X POST https://api.github.com/repos/{owner}/{repo}/milestones \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"title":"v1.0","state":"open","description":"Release of version 1.0"}'

Label Management

Create a New Label

curl -X POST https://api.github.com/repos/{owner}/{repo}/labels \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"name":"bug","color":"ff0000"}'

Comment Management

Add an Issue Comment

curl -X POST https://api.github.com/repos/{owner}/{repo}/issues/{issue_number}/comments \
-H "Authorization: token <YOUR_TOKEN>" \
-d '{"body":"This is a test comment."}'

Search Query Syntax

Code Search

• language:javascript: Search by programming language.
• repo:owner/name: Search within a specific repository.
• path:app/src: Search by path.
• extension:js: Search by file extension.
• Example: q: "import express" language:typescript path:src/

Issue Search

• is:issue or is:pr: Filter by type.
• is:open or is:closed: Filter by status.
• label:bug: Filter by label.
• author:username: Filter by author.
• Example: q: "memory leak" is:issue is:open label:bug

User Search

• type:user or type:org: Filter by account type.
• followers:>1000: Filter by the number of followers.
• location:London: Filter by location.
• Example: q: "John Doe" type:user location:New York

📚 Documentation

Build Instructions

Use the following command to build the Docker image:

docker build -t mcp-server . && docker tag mcp-server:latest yourname/mcp-server:latest

📄 License

The GitHub MCP server is licensed under the MIT License. For more details, please refer to the license file.