Github MCP Go

🚀 GitHub MCP Server

A GitHub Model Context Protocol (MCP) server implemented in Go. This server enables Large Language Models (LLMs) to interact with GitHub repositories, issues, pull requests, etc., through a standard interface.

🚀 Quick Start

To use the GitHub MCP Server, first set up the environment variables:

export GITHUB_TOKEN="your_token_here"

Then run the server:

github-mcp-server

✨ Features

Comprehensive GitHub API Access

See the Tools section below for details.

Setup Commands

These commands are used for the automatic configuration of AI assistants and are very easy to use:

• --auto-approve: Pre-check the consent box.
• --write-access: Enable write permissions.
• Automatically copy binary files to a stable location.
• Update the MCP server configuration of the tool (supports cline and claude-desktop).

Security Controls

• Write permissions are disabled by default to ensure security.
• There are fine-grained auto-approval options.

Upcoming Features

• [ ] “get_diff”
  • Compare differences between two commits.
  • ? Should this content be included in the output of compare_commits?

📦 Installation

Prerequisites

• A GitHub personal access token with appropriate permissions.

Using Pre-compiled Binaries

Pre-compiled binaries are available for multiple platforms:

• Linux (amd64, arm64)
• macOS (amd64, arm64)
• Windows (amd64)

Building from Source

After cloning the repository, run the following command to install:

go install ./...

💻 Usage Examples

Basic Usage

Set up the environment variables to configure the server:

export GITHUB_TOKEN="your_token_here"

Run the server:

github-mcp-server

Advanced Usage

Enable write permissions temporarily using the --approve option:

github-mcp-server --approve

📚 Documentation

Tools

Repository-Related Tools

• search_repositories: Search for GitHub repositories.
• create_repository: Create a new repository.
• fork_repository: Fork an existing repository.
• list_forks: List the forks of a repository.
• delete_repository: Delete a specified repository.
• transfer_repository: Transfer the ownership of a repository.

Pull Request-Related Tools

• search_pull_requests: Search for pull requests in a specific repository.
• create_pull_request: Create a new pull request.
• update_pull_request: Update the information of an existing pull request.
• merge_pull_request: Merge a specified pull request.
• delete_pull_request: Delete a specified pull request.

Issue-Related Tools

• search_issues: Search for issues and pull requests in a repository.
• create_issue: Create a new issue.
• update_issue: Update the information of an existing issue.
• close_issue: Close a specified issue.
• reopen_issue: Reopen a closed issue.
• add_comment_to_issue: Add a comment to an issue.

Branch-Related Tools

• list_branches: List all branches of a repository.
• create_branch: Create a new branch.
• delete_branch: Delete a specified branch.
• protect_branch: Protect a specified branch (prevent it from being overridden).
• unprotect_branch: Unprotect a specified branch.

Commit-Related Tools

• commit_file: Commit file changes.
• get_commit_diff: Get the difference view of a specific commit.
• compare_commits: Compare the changes between two commits or branches.
• create_commit_comment: Add a comment to a specific commit.
• delete_commit_comment: Delete a comment on a specified commit.

Search-Related Tools

• search_code: Search for code snippets in multiple repositories.
• search_users: Search for GitHub users.
• search_teams: Search for GitHub organizations or teams.

Release

This project follows Semantic Versioning (SemVer). When a new tag is pushed, it will be automatically built and released to the GitHub Releases page.

For detailed instructions on creating a new release, see RELEASE.md.

Development

Testing

The project uses the table-driven testing method and combines go-vcr to record HTTP interactions:

go test ./...

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.