Github MCP Server S7g

🚀 GitHub MCP Server

The GitHub MCP (Model Context Protocol) server offers a series of functions for interacting with the GitHub platform, including code search, issue management, user information query, and workflow operations. Here are the main features of this server:

✨ Features

API Methods

Repository and Pull Request Operations

• Create/Update an Issue or Pull Request: Publish or update an issue or pull request.
• Comment on an Issue or Pull Request: Post a comment on a specified issue or pull request.
• Get Detailed Information of an Issue or Pull Request: View the complete information of an issue or pull request, including the title, description, and status.
• Get the History of an Issue or Pull Request: View the historical modification records of an issue or pull request.

Code Search

• Search for Code Snippets: Search for code snippets in a specific repository based on conditions such as language, path, and file extension.

Workflow Operations

• Trigger a Workflow Run: Trigger the execution of a GitHub Actions workflow.
• Get the Workflow Run Status: Check the status and results of a workflow run.

User and Organization Information Query

• Get User or Organization Information: Retrieve the profile information of a specific user or detailed information about an organization.

Search Syntax

Code Search

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

Issue Search

• is:issue or is:pr: Filter by type (issue or pull request).
• 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 geographical location.
• Example: q: "fullstack developer" location:London followers:>100

For detailed search syntax, please refer to GitHub's Search Documentation.

📦 Installation

Personal Access Token

Create a GitHub personal access token to gain full control over repositories:

1. Visit Personal access tokens (in GitHub Settings > Developer settings).
2. Select the required repository access permissions (public, all, or specified).
3. Create a token with the repo permission (if you only deal with public repositories, you can choose the public_repo permission).
4. Copy the generated token.

Usage Instructions

Docker Configuration

Add the following configuration to ~/.cursor/mcp_config.json or ~/.windsurf/mcp_config.json:

{
  "mcpServers": {
    "github": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "GITHUB_PERSONAL_ACCESS_TOKEN",
        "mcp/github"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

NPX Configuration

{
  "mcpServers": {
    "github": {
      "command": "node",
      "args": [
        "-e",
        "const mcp = require('mcp'); mcp.start();"
      ],
      "env": {
        "GITHUB_PERSONAL_ACCESS_TOKEN": "<YOUR_TOKEN>"
      }
    }
  }
}

💻 Usage Examples

Create an Issue

{
  "Title": "New Feature Request",
  "Description": "Please implement a new feature...",
  "Status": "Open"
}

Trigger a Workflow Run

{
  "Repository Owner": "username",
  "Repository Name": "repo-name",
  "Branch": "main",
  "Commit Message": "Trigger the workflow"
}

Recommended Build Command

docker build -t mcp/github .

📄 License

This project is licensed under the MIT License. For detailed information, please refer to the LICENSE file.

Environment Variable Configuration

The following environment variables are required to run the GitHub MCP server:

• GITHUB_PERSONAL_ACCESS_TOKEN: Must be set to your GitHub personal access token.
• PORT (optional): Set the port for the service to listen on. The default is 3000.