Github Kanban

🚀 GitHub 問題看板 MCP 服務器

GitHub 問題看板 MCP 服務器是一款強大的看板管理工具，它依託 GitHub 問題展開工作。藉助大語言模型（LLM），該工具能夠實現自動化任務管理，還能為項目進度提供直觀的可視化支持。它是 Model Context Protocol (MCP) 的一個具體實現。

🚀 快速開始

GitHub 問題看板 MCP 服務器是一款基於 GitHub 問題的看板管理工具，支持通過大語言模型（LLM）實現自動化任務管理，併為項目進度提供可視化支持。它是 Model Context Protocol (MCP) 的一個實現。

✨ 主要特性

• 🔄 以看板形式直觀展示 GitHub 問題。
• 🤖 藉助大語言模型輔助完成自動任務管理。
• 📊 對項目進展進行可視化呈現。
• 🔗 可完全集成至 GitHub 生態系統。
• 💬 支持在問題上添加評論。

📦 安裝指南

1. 克隆倉庫：

git clone https://github.com/sunwood-ai-labs/github-kanban-mcp-server.git
cd github-kanban-mcp-server

2. 安裝依賴：

npm install

3. 啟動服務：

node src/index.ts

📚 詳細文檔

🎮 設置說明

在 config.json 文件中添加以下配置：

{
  "github": {
    "token": "your_github_token", // 替換為你的 GitHub 訪問令牌
    "owner": "your_owner_name"   // 替換為你倉庫的擁有者名稱
  },
  "mcp": {
    "endpoint": "http://localhost:3000" // MCP 服務的端點地址
  }
}

🛠️ 工具說明

1. 列出問題 (list_issues)

列出指定倉庫中的所有問題。 命令：

node list-issues.js [owner] [repo]

示例：

node list-issues.js sunwood-ai-labs github-kanban-mcp-server

2. 創建新問題 (create_issue)

新建一個問題並指定標題和內容。 命令：

node create-issue.js [owner] [repo] --title "問題標題" --body "問題描述"

示例：

node create-issue.js sunwood-ai-labs github-kanban-mcp-server --title "新功能請求" --body "請實現特性X。"

3. 更新現有問題 (update_issue)

更新指定問題的狀態、標題和內容。 命令：

node update-issue.js [owner] [repo] [issue_number] [--state open|closed|--title 新標題 |--body 新內容]

示例：

node update-issue.js sunwood-ai-labs github-kanban-mcp-server 1 --state closed

4. 添加評論 (add_comment)

向指定問題添加新的評論。 命令：

node add-comment.js [owner] [repo] [issue_number] [--body "評論內容" --state open|closed]

示例：

node add-comment.js sunwood-ai-labs github-kanban-mcp-server 1 --body "這個功能很好！"

🔧 技術細節

項目結構

kanban-server/
├── src/                    # 源代碼目錄
│   ├── handlers/          # 請求處理程序
│   │   ├── comment-handlers.ts  # 處理評論請求的模塊
│   │   ├── issue-handlers.ts    # 處理問題請求的模塊
│   │   └── state-handlers.ts   # 處理狀態請求的模塊
│   ├── models/            # 數據模型定義
│   │   └── Issue.ts      # 定義問題數據結構
│   ├── routes/           # API 路由配置
│   │   └── routes.ts     # 定義所有 API 路由
│   └── utils/            # 工具函數集合
│       └── validator.ts  # 數據驗證工具
├── package.json          # 項目依賴和腳本定義
└── README.md             # 項目說明文檔

📄 許可證

本項目採用 MIT 許可證，詳細信息請查看 LICENSE 文件。

🤝 貢獻指南

1. Fork 此倉庫。
2. 創建新分支：git checkout -b feature/your-feature-name
3. 提交更改：git commit -m 'feat: 新增功能描述'
4. 推送到分支：git push origin feature/your-feature-name
5. 提交 Pull Request。

📮 反饋

若你在使用過程中遇到問題或有任何建議，請通過 GitHub Issues 提交。