Pygithub MCP Server

🚀 PyGithub 使用說明

本項目是關於 PyGithub 的使用說明文檔，涵蓋了安裝、使用、開發等方面的內容，幫助用戶快速上手並使用 PyGithub 進行相關開發。

🚀 快速開始

要使用 PyGithub，你可以按照以下步驟進行快速部署：

1. 安裝 PyGithub 及其依賴項。
2. 激活虛擬環境並運行服務器。
3. 根據需求進行工具組配置。

📦 安裝指南

要安裝 PyGithub，請使用以下命令：

uv add pygithub-mcp-server
uv install

依賴項

• Python 3.10+ 版本
• MCP Python SDK
• Pydantic
• PyGithub
• UV 包管理器

💻 使用示例

初始化與運行

要使用 PyGithub，請按照以下步驟操作：

1. 激活虛擬環境：

source .venv/bin/activate

2. 運行服務器：

uv run pygithub-mcp-server

配置說明

工具組配置

默認情況下，只有 issues 工具組是啟用的。你可以通過以下兩種方式來配置工具組：

1. 配置文件：創建並指定配置文件：

export PYGITHUB_MCP_CONFIG=/path/to/pygithub_mcp_config.json

示例內容如下：

{
  "tool_groups": {
    "issues": true,
    "repositories": true,
    "pull_requests": false,
    "discussions": false,
    "search": true
  }
}

2. 環境變量：直接設置工具組狀態：

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 環境變量是否正確設置，或確保默認配置文件存在。

如需進一步幫助，請聯繫支持團隊或查閱項目文檔。