MCP Github Project Manager

🚀 GitHub 項目管理 MCP 服務器

該項目實現了 Model Context Protocol (MCP) 服務器，藉助標準化工具和資源來提供 GitHub Projects 功能。LLM 客戶端可通過 MCP 接口對 GitHub 項目進行編程式管理，極大提升了項目管理的便捷性和效率。

🚀 快速開始

此服務器實現了 Model Context Protocol，旨在向 LLM 客戶端暴露 GitHub Projects 功能。它提供了一系列工具，可通過 GitHub 的 GraphQL API 管理項目、里程碑、衝刺和指標，同時依據 MCP 規範維護狀態並處理錯誤。

啟動服務器，對於使用 npm 的用戶：

npm start

對於使用 Yarn 的用戶：

yarn start

示例命令：獲取用戶信息

curl http://localhost:3000/api/users

✨ 主要特性

• 項目管理

  • 創建和管理 GitHub Projects (v2)
  • 處理項目設置和配置
  • 管理項目可見性和訪問權限

• 項目資源

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

• MCP 實現

  • 完整的 MCP 規範合規性
  • 標準化工具定義與 Zod 驗證
  • 資源狀態管理
  • 進度式響應處理
  • 全面錯誤處理

• GitHub 集成

  • 帶分頁支持的 GraphQL API 集成
  • 智能訪問令牌
  • 帶自動重試和斷路器的穩健 HTTP 客戶端
  • 資源速率限制和排隊

📦 安裝指南

安裝依賴項

使用包管理工具安裝項目依賴，對於 npm 用戶：

npm install

對於 Yarn 用戶：

yarn install

配置

創建 config.json 文件並添加以下內容：

{
  "github": {
    "clientId": "YOUR_GITHUB_CLIENT_ID",
    "clientSecret": "YOUR_GITHUB_CLIENT_SECRET"
  }
}

🔧 技術細節

• 分層架構：擁有清晰的分層結構，便於系統的維護和擴展。
• 模塊化設計：將核心功能分解為獨立模塊，提高了代碼的複用性。
• 依賴注入：通過依賴注入實現松耦合組件。

📚 詳細文檔

當前狀態分析

已實現的功能

待辦事項

文檔鏈接

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

交互式文檔

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

開發相關

測試

# 單元測試
npm test

# 集成測試
npm run test:integration

# 端到端測試
npm run test:e2e

代碼質量

# 格式化代碼
npm run lint

# 類型檢查
npm run type-check

# 編碼格式化
npm run format

貢獻指南

我們歡迎對 GitHub Project Manager MCP Server 的貢獻！請參考我們的 貢獻指南 瞭解詳細信息：

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

📄 許可證

MIT