MCP Githubcli

🚀 GitHub CLI MCP Server

This MCP server provides a simple and user - friendly interface for the GitHub CLI, allowing you to access GitHub features via the MCP protocol.

🚀 Quick Start

This MCP server offers a convenient way to interact with GitHub through the MCP protocol. By following the installation steps and using the provided tools, you can efficiently manage repositories, issues, PRs, and gists.

✨ Features

• Repository Management: View and create repositories.
• Issue Management: View and create issues.
• PR Management: View, create, and view differences of PRs.
• Gist Management: View and create gists.

📦 Installation

1. Install GitHub CLI (gh)

   # MacOS
   brew install gh
   
   # Ubuntu/Debian
   apt install gh
   
   # For other systems, refer to the official GitHub CLI documentation.
   

2. Complete GitHub authentication via gh auth login.

📚 Documentation

Parameter Type Explanation

This service has the following requirements for parameter types:

• The PR number must be an integer: pr_view(123, "owner/repo").
• The Issue number must be an integer: issue_view(456, "owner/repo").
• The PR base branch name should be a string: pr_create("owner/repo", "title", "content", "main").

All integer parameters will be automatically converted to strings internally to ensure the correct execution of commands.

💻 Usage Examples

Basic Usage

# View PR differences
diff = pr_diff(2543, "qianshouapp/kyc")

# View a repository
repo_info = repo_view("microsoft/vscode")

# Create an issue
issue_create("owner/repo", "title", "This is the content of the issue")

Advanced Usage

# View PR differences and print the full result
diff = pr_diff(2543, "qianshouapp/kyc")
print(diff)  # Display the full differences

PR Difference Viewing

The PR difference viewing function supports full output of all difference content without truncation, ensuring that you can view the complete code changes.

🔧 Technical Details

If you need to extend the functionality, you can modify the main.py file, add new utility functions, and register them with the MCP server.

📚 Documentation

Available Tools

Repository Operations

• repo_list() - List GitHub repositories you own or participate in.
• repo_view(repo) - View detailed repository information.
• repo_create(name, description, private) - Create a new repository.

Issue Operations

• issue_list(repo, state) - List issues in a repository.
• issue_view(issue, repo) - View details of a specific issue.
• issue_create(repo, title, body) - Create a new issue.

PR Operations

• pr_list(repo, state) - List PRs in a repository.
• pr_view(pr, repo) - View details of a specific PR.
• pr_diff(pr, repo) - View code differences of a specific PR.
• pr_create(repo, title, body, base) - Create a new PR.

Gist Operations

• gist_list() - List your gists.
• gist_create(files, description, public) - Create a new gist.

Available Resources

• repo://{owner}/{name} - Get repository information.
• user://{username} - Get user information.

💡 Usage Tip

If you encounter problems:

1. Ensure that GitHub CLI is correctly installed. You can verify this by running gh --version.
2. Ensure that you have authenticated via gh auth login.
3. Check if you have permission to access the corresponding repository or resource.
4. If there are issues with JSON - formatted output, try using the standard output format.

```python
# View a PR
pr_view(123, "owner/repo")

# View a repository
repo_info = repo_view("microsoft/vscode")

# Create an issue
issue_create("owner/repo", "title", "This is the content of the issue")