Pygithub

🚀 PyGithub MCP Server

PyGithub MCP Server is a Python-based GitHub API operation framework. It aims to provide developers with convenient interfaces to interact with the GitHub platform. The project uses a modular design, supports various GitHub functions, and comes with detailed documentation and test suites to ensure its stability and reliability.

🚀 Quick Start

This section will guide you through the installation, configuration, and basic usage of PyGithub MCP Server.

✨ Features

• Based on Python, providing a convenient way to interact with the GitHub API.
• Modular design, supporting various GitHub functions.
• Comes with detailed documentation and test suites for stability and reliability.

📦 Installation

Install using the MCP Package Manager

uv add pygithub-mcp-server

Compile and Install from Source Code

1. Clone the repository:

   git clone https://github.com/your-username/pygithub-mcp-server.git
   cd pygithub-mcp-server
   

2. Install dependencies:

   uv install
   

💻 Usage Examples

Configure the GitHub Token

1. Set the environment variable:

   export GITHUB_PERSONAL_ACCESS_TOKEN=your-token-here
   

2. Use the token in the code:

   from pygithub_mcp_server.client import GithubClient
   
   client = GithubClient()
   

📚 Documentation

The project documentation is hosted on GitHub Pages, which includes detailed API documentation and usage guides.

🔧 Technical Details

Development Guide

Configuration

Configure using the MCP Package Manager

1. Start the development environment:

   uv run pygithub-mcp-server
   

2. Access the Web interface for tool registration and testing.

Manual Configuration

1. Create and activate a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # Use .venv\Scripts\activate on Windows
   

2. Install dependencies:

   pip install -r requirements.txt
   

Register a Tool

1. Create a new tool file:

   # src/pygithub_mcp_server/tools/my_tool.py
   from pygithub_mcp_server.tools import Tool
   
   class MyTool(Tool):
       pass
   

2. Register the tool in __init__.py:

   # src/pygithub_mcp_server/tools/__init__.py
   from .my_tool import MyTool
   

Troubleshooting

1. Server fails to start:
   • Check if the virtual environment path in the MCP settings is correct.
   • Ensure that all dependencies are installed in the current environment.
2. Build errors:
   • Run the build command with the --no-build-isolation flag.
3. GitHub API errors:
   • Verify the validity and permission settings of the token.

Project Structure

tests/
├── unit/                # Unit tests, no external dependencies
│   ├── config/          # Configuration-related tests
│   └── tools/           # Tool registration tests
└── integration/         # Integration tests, using the real GitHub API
    └── issues/          # Issue handling tool tests

src/
├── pygithub_mcp_server/
│   ├── __init__.py
│   ├── server.py        # Server factory (create the server)
│   ├── version.py       # Version information
│   ├── config/          # Configuration system
│   │   └── settings.py  # Global configuration
│   ├── client/          # GitHub client interface
│   │   └── github.py    # Main implementation file
│   └── tools/           # Tool extension directory
│       └── __init__.py  # Tool registration file
└── requirements.txt     # Project dependency list

📄 License

This project is licensed under the MIT License. For specific terms, see LICENSE.

Thank you for choosing PyGithub MCP Server! If you need help or feedback, please visit our GitHub repository or contact the maintenance team.