Github Project Manager

🚀 GitHub 項目管理 MCP 服務器

這是一個實現模型上下文協議（MCP）的服務器，藉助標準化工具和資源提供 GitHub 項目的相關功能。LLM 客戶端可通過 MCP 接口以程序化的方式管理 GitHub 項目。

🚀 快速開始

此服務器實現了 Model Context Protocol，旨在將 GitHub 項目的功能開放給 LLM 客戶端。它提供了一系列工具用於管理和處理項目、里程碑、sprint 以及指標，藉助 GitHub 的 GraphQL API 維護狀態，並依據 MCP 規範處理錯誤。

✨ 主要特性

• 項目管理

  • 創建並管理 GitHub 項目（v2）
  • 處理項目設置與配置
  • 管理項目的可見性和訪問權限

• 項目資源

  • 管理問題和里程碑
  • 規劃和跟蹤 Sprint
  • 自定義字段和視圖
  • 進行資源版本控制和鎖定

• MCP 實現

  • 完全符合 MCP 規範
  • 採用 Zod 驗證進行標準化工具定義
  • 管理資源狀態
  • 處理進行式響應
  • 全面處理錯誤

• GitHub 集成

  • 集成 GraphQL API 並使用 Zod 驗證
  • 批量查詢相關資源
  • 具備背景刷新功能

📦 安裝指南

安裝依賴

npm install mcp-server express graphql axios dotenv

環境變量

在項目根目錄創建 .env 文件：

PORT=3000
DATABASE_URL=jdbc:mysql://localhost:3306/gpm_mcp?user=root&password=example
GRAPHQL_ENDPOINT=https://api.github.com/graphql

💻 使用示例

基礎用法

啟動服務器

node index.js

API 調用示例

使用 curl 或 Postman 發送 POST 請求到 http://localhost:3000/api：

{
  "tool": {
    "id": "github-projects",
    "name": "GitHub Projects Manager"
  },
  "command": "listProjects",
  "args": {
    "username": "your_github_username",
    "token": "your_github_token"
  }
}

📚 詳細文檔

系統架構

分層架構

1. 表現層：負責處理用戶請求和響應。
2. 業務邏輯層：實現核心功能，如項目管理、數據處理。
3. 數據訪問層：與數據庫和外部 API（如 GitHub）進行交互。

關鍵組件

• MCPServer：處理 HTTP 請求並解析工具指令。
• ProjectManager：負責與 GitHub 項目相關的所有操作。
• DatabaseAdapter：提供數據庫連接和查詢功能。
• GraphQLClient：封裝對 GitHub GraphQL API 的調用。

系統現狀

已實現的功能

• 基於 MCP 協議的工具定義與執行。
• 支持多租戶，通過用戶標識符隔離數據。
• 詳細的審計日誌記錄，默認啟用。

待辦事項

1. 實現指標和數據分析功能。
2. 添加可視化報告生成器。
3. 優化性能，引入查詢批處理。

文檔鏈接

• 用戶指南 - 詳細使用說明
• API 參考 - 全面工具文檔
• 教程 - 分步指導
• 示例 - 常見任務代碼示例
• 架構 - 系統架構與設計
• 貢獻指南 - 開發規範

交互式文檔

在瀏覽器中打開 API 探索器 進行交互式 API 探索。

開發相關

測試

# 單元測試
npm test

# 集成測試
npm run test:integration

# 端到端測試
npm run test:e2e

代碼質量

# 格式化代碼
npm run format

# 類型檢查
npm run type-check

# 編碼規範檢查
npm run lint

貢獻說明

我們歡迎對 GitHub 項目管理 MCP 服務器的貢獻！請查閱我們的 貢獻指南 瞭解詳細信息，包括：

• 開發流程
• 編碼標準
• 測試規範
• 文檔編寫指南

📄 許可證

MIT