PyGithub

🚀 PyGithub MCP 服务器

PyGithub MCP 服务器是一个基于 Python 的 GitHub API 操作框架，它为开发者提供了便捷的接口，可轻松与 GitHub 平台进行交互。该项目采用模块化设计，支持多种 GitHub 功能，同时提供了详细的文档和测试套件，以确保其稳定性和可靠性。

🚀 快速开始

本项目提供了便捷的方式让你快速上手，无论是使用 MCP 包管理器安装，还是从源码编译安装，都能轻松开启项目之旅。

✨ 主要特性

• 基于 Python 开发，提供便捷的 GitHub API 操作接口。
• 模块化设计，支持多种 GitHub 功能。
• 具备详细的文档和测试套件，保障项目的稳定性和可靠性。

📦 安装指南

使用 MCP 包管理器安装

uv add pygithub-mcp-server

从源码编译安装

1. 克隆仓库：

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

2. 安装依赖项：

   uv install
   

💻 使用示例

基础用法

配置 GitHub 令牌

1. 设置环境变量：

   export GITHUB_PERSONAL_ACCESS_TOKEN=your-token-here
   

2. 在代码中使用令牌：

   from pygithub_mcp_server.client import GithubClient
   
   client = GithubClient()
   

高级用法

注册工具

1. 创建新工具文件：

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

2. 在 __init__.py 中注册工具：

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

📚 详细文档

项目文档托管在 GitHub Pages 上，包含详细的 API 文档和使用指南。

🔧 技术细节

开发指南

配置

使用 MCP 包管理器配置

1. 启动开发环境：

   uv run pygithub-mcp-server
   

2. 访问 Web 界面进行工具注册和测试。

手动配置

1. 创建虚拟环境并激活：

   python -m venv .venv
   source .venv/bin/activate  # 在 Windows 上使用 .venv\Scripts\activate
   

2. 安装依赖项：

   pip install -r requirements.txt
   

项目结构

tests/
├── unit/                # 单元测试，无外部依赖
│   ├── config/          # 配置相关测试
│   └── tools/           # 工具注册测试
└── integration/         # 集成测试，使用真实 GitHub API
└── issues/          # 问题处理工具测试

src/
├── pygithub_mcp_server/
│   ├── __init__.py
│   ├── server.py        # 服务器工厂（创建服务器）
│   ├── version.py       # 版本信息
│   ├── config/          # 配置系统
│   │   └── settings.py  # 全局配置
│   ├── client/          # GitHub 客户端接口
│   │   └── github.py    # 主要实现文件
│   └── tools/           # 工具扩展目录
│       └── __init__.py  # 工具注册文件
└── requirements.txt     # 项目依赖项清单

问题排查

1. 服务器启动失败：
   • 检查 MCP 设置中的虚拟环境路径是否正确。
   • 确保所有依赖项已安装在当前环境中。
2. 构建错误：
   • 使用 --no-build-isolation 标志运行构建命令。
3. GitHub API 错误：
   • 验证令牌的有效性和权限设置。

📄 许可证

本项目采用 MIT 许可证，具体条款参见 LICENSE。

感谢您选择 PyGithub MCP Server！如需帮助或反馈，请访问我们的 GitHub 仓库 或联系维护团队。