Zerops MCP

🚀 GitHub MCP Server

The GitHub MCP (Model Context Protocol) Server offers functionalities to interact with the GitHub platform, supporting the following operations:

• Code Search: Search for code based on conditions such as language, path, and file extension.
• Issue Tracking: View and manage issues and pull requests.
• Repository Management: Create, delete, and manage repositories.
• Team Collaboration: Collaborate with team members, manage teams, and set permissions.
• Activity Monitoring: Monitor the commit history and activity records of repositories.

Use Cases

• Development Assistance: Quickly find code snippets or functional implementations.
• Project Management: Track the status of issues and pull requests.
• Automated Workflows: Integrate into CI/CD workflows for automated testing and deployment.
• Team Collaboration: Efficiently manage and assign tasks within the team.

🚀 Quick Start

Install Dependencies

Run the following command to install the necessary dependencies:

npm install @github/mcp-server --save

Initialize the Server

Create and run the following configuration file mcp-config.json:

{
  "servers": {
    "github": {
      "url": "https://api.github.com",
      "token": "your-personal-access-token"
    }
  }
}

✨ Features

Code Search

You can achieve precise code search using the following syntax:

• language:javascript: Filter by programming language.
• repo:owner/name: Specify the repository scope.
• path:app/src: Filter by file path.
• extension:js: Filter by file extension.
• Example: q: "import express" language:typescript path:src/

Issue Search

Search for issues and pull requests using the following syntax:

• 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

Search for users or organizations using the following syntax:

• 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

Detailed Search Syntax

Please refer to the GitHub official documentation.

📦 Installation

Personal Access Token

Create a GitHub personal access token:

• Log in to GitHub Account Settings.
• Select the repositories that require permissions (public, all, or specified).
• Create a token with repo permission (it is recommended to use public_repo permission for public repositories).

Integrate into Claude Desktop

Add the following configuration to claude_desktop_config.json:

Docker Method:

{
  "mcpServers": {
    "github": {
      "type": "docker",
      "containerName": "github-mcp-server",
      "imageName": "ghcr.io/your-org/github-mcp:latest"
    }
  }
}

Direct Configuration Method:

{
  "mcpServers": {
    "github": {
      "type": "direct",
      "endpoint": "http://localhost:3000",
      "token": "your-personal-access-token"
    }
  }
}

💻 Usage Examples

Command - Line Tool

Install the Tool

Install using the npm package manager:

npm install -g @github/mcp-cli

Usage Examples

1. Log in to your GitHub account:

   mcp login --token your-personal-access-token
   

2. Search for code snippets:

   mcp search "node.js" --language=typescript
   

3. Create a new repository:

   mcp create-repo my-new-repo
   

📚 Documentation

Frequently Asked Questions

1. How to obtain a personal access token?

• Log in to your GitHub account and go to Account Settings.
• Click the "Generate new token" button.
• Generate the token after configuring the permissions.

2. How to solve authentication issues?

• Ensure that the token has the correct permissions (at least repo permission is required).
• Check if the token has expired or been revoked.

Development Guide

Extend Functionality

• Custom Commands: Develop new CLI commands to extend functionality.
• Plugin System: Create plug - and - play components to extend server functionality.
• Hook Mechanism: Implement pre - processing and post - processing logic.

Contribute Code

1. Fork the project repository.
2. Create a feature branch.
3. Submit your code and initiate a Pull Request.

📄 License

This project follows the MIT License. The specific content is as follows:

MIT License
Copyright (c) [Year] [Author's Name]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Contributors

• [Your Name] - Initial development
• [Other Contributors' Names] - Feature expansion

With the above guide, you can easily integrate the GitHub MCP Server into your development process and improve team collaboration efficiency.