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 提交。