🚀 PyGithub 使用说明
本项目是关于 PyGithub 的使用说明文档，涵盖了安装、使用、开发等方面的内容，帮助用户快速上手并使用 PyGithub 进行相关开发。
🚀 快速开始
要使用 PyGithub，你可以按照以下步骤进行快速部署：
- 安装 PyGithub 及其依赖项。
- 激活虚拟环境并运行服务器。
- 根据需求进行工具组配置。
📦 安装指南
要安装 PyGithub，请使用以下命令：
uv add pygithub-mcp-server
uv install
依赖项
- Python 3.10+ 版本
- MCP Python SDK
- Pydantic
- PyGithub
- UV 包管理器
💻 使用示例
初始化与运行
要使用 PyGithub，请按照以下步骤操作：
- 激活虚拟环境：
source .venv/bin/activate
- 运行服务器：
uv run pygithub-mcp-server
配置说明
工具组配置
默认情况下，只有 issues 工具组是启用的。你可以通过以下两种方式来配置工具组：
- 配置文件：创建并指定配置文件：
export PYGITHUB_MCP_CONFIG=/path/to/pygithub_mcp_config.json
示例内容如下：
{
"tool_groups": {
"issues": true,
"repositories": true,
"pull_requests": false,
"discussions": false,
"search": true
}
}
- 环境变量：直接设置工具组状态：
export PYGITHUB_ENABLE_ISSUES=true
export PYGITHUB_ENABLE_REPOSITORIES=true
export PYGITHUB_ENABLE_PULL_REQUESTS=false
配置文件路径
默认配置文件位于 pygithub_mcp_server/settings.py。如需自定义，请参考 README.config.md 获取更多选项。
📚 详细文档
测试方法
项目包含全面的测试套件：
# 运行所有测试
pytest
# 生成覆盖率报告
pytest --cov
# 运行特定测试文件
pytest tests/test_operations/test_issues.py
# 根据模式运行测试
pytest -k "test_create_issue"
注意：当前许多测试无法通过，正在积极修复中。
使用 MCP 检查器进行开发测试
在开发期间，可以使用 MCP 检查器来测试工具：
source .venv/bin/activate # 确保虚拟环境已激活
npx @modelcontextprotocol/inspector -e GITHUB_PERSONAL_ACCESS_TOKEN=your-token-here uv run pygithub-mcp-server
通过 MCP 检查器的 Web UI，你可以：
- 测试可用工具
- 使用真实 GitHub 仓库进行交互
- 验证成功和错误情况
- 文档化有效负载
项目结构
tests/
├── unit/ # 快速测试，无外部依赖
│ ├── config/ # 配置测试
│ ├── tools/ # 工具注册测试
│ └── ... # 其他单元测试
└── integration/ # 使用真实 GitHub API 的测试
├── issues/ # 问题工具测试
└── ... # 其他集成测试
src/
└── pygithub_mcp_server/
├── __init__.py
├── __main__.py
├── server.py # 工厂模式（create_server）
├── version.py
├── config/ # 配置系统
│ ├── __init__.py
│ └── settings.py # 配置管理
├── tools/ # 模块化工具系统
│ ├── __init__.py # 工具注册框架
│ └── issues/ # 问题工具
│ ├── __init__.py
│ └── tools.py # 问题工具实现
├── client/ # GitHub 客户端
│ ├── __init__.py
│ └── client.py # 主要客户端逻辑
├── core/ # 核心功能模块
│ ├── __init__.py
│ └── logic.py # 核心业务逻辑
└── utils/ # 工具和辅助函数
├── __init__.py
└── helper.py # 辅助函数集合
🔧 故障排除与支持
常见问题
- 未找到依赖项：运行
uv install安装所有必要的包。 - 配置文件错误：检查
PYGITHUB_MCP_CONFIG环境变量是否正确设置，或确保默认配置文件存在。
如需进一步帮助，请联系支持团队或查阅项目文档。