Pygithub

🚀 PyGithub MCP 服務器

PyGithub MCP 服務器是一個基於 Python 的 GitHub API 操作框架，它為開發者提供了便捷的接口，方便與 GitHub 平臺進行交互。該項目採用模塊化設計，支持多種 GitHub 功能，還配備了詳細的文檔和測試套件，確保了項目的穩定性和可靠性。

🚀 快速開始

PyGithub MCP Server 是一個強大的工具，能讓你輕鬆與 GitHub 平臺交互。下面將為你介紹如何快速開啟使用之旅。

✨ 主要特性

• 基於 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
   

註冊工具

創建新工具文件並在 __init__.py 中進行註冊，具體代碼示例見上文使用示例部分。

問題排查

1. 服務器啟動失敗：
   • 檢查 MCP 設置中的虛擬環境路徑是否正確。
   • 確保所有依賴項已安裝在當前環境中。
2. 構建錯誤：
   • 使用 --no-build-isolation 標誌運行構建命令。
3. GitHub API 錯誤：
   • 驗證令牌的有效性和權限設置。

項目結構

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     # 項目依賴項清單

📄 許可證

本項目採用 MIT 許可證，具體條款參見 LICENSE。

感謝您選擇 PyGithub MCP Server！如需幫助或反饋，請訪問我們的 GitHub 倉庫 或聯繫維護團隊。