article
README
🚀 GitHub 问题看板 MCP 服务器
GitHub 问题看板 MCP 服务器是一个基于 GitHub 问题的看板管理工具,结合大语言模型(LLM)实现任务自动化管理,能有效提升项目管理效率。
🚀 快速开始
GitHub 问题看板 MCP 服务器是一个结合了 GitHub 问题与大语言模型(LLM)的工具,可实现高效的任务自动化管理。以下是快速开始的步骤:
# 克隆仓库
git clone https://github.com/sunwood-ai-labs/github-kanban-mcp-server.git
cd github-kanban-mcp-server
# 安装依赖
npm install
# 启动服务
npm start
✨ 主要特性
- 🔄 以看板形式管理 GitHub 问题,直观展示任务状态。
- 🤖 借助 LLM 实现任务自动化处理,提高工作效率。
- 📊 可视化项目进展,方便跟踪任务进度。
- 💡 支持评论交互,便于团队成员沟通协作。
- 🔧 可灵活配置多状态和标签,满足不同项目需求。
📦 安装指南
- 确保已安装 Node.js 和 npm,版本要求为 Node.js >=14,npm >=6。
- 克隆仓库:
git clone https://github.com/sunwood-ai-labs/github-kanban-mcp-server.git cd github-kanban-mcp-server - 安装依赖:
npm install - 启动服务:
npm start
📚 详细文档
🎮 设置说明
在 config.json 中添加 MCP 服务器配置:
{
"mcpServer": {
"host": "localhost",
"port": 3000,
"githubToken": "your_github_token"
}
}
🤝 可用工具
1. 列出问题
- 命令:
list_issues - 参数:
repo:目标仓库名(必填)state:过滤状态(open/closed)(可选,默认:all)
2. 创建新问题
- 命令:
create_issue - 参数:
repo:仓库名(必填)title:问题标题(必填)body:问题描述(可选)labels:标签列表(可选)
3. 更新现有问题
- 命令:
update_issue - 参数:
repo:仓库名(必填)issue_number:问题编号(必填)title:新标题(可选)body:新描述(可选)state:新状态(open/closed)(可选)labels:新标签列表(可选)
4. 添加评论
- 命令:
add_comment - 参数:
repo:仓库名(必填)issue_number:问题编号(必填)body:评论内容(必填,支持 Markdown 格式)state:更新状态(open/closed)(可选)
🔧 技术细节
项目架构如下:
├── src/
│ ├── index.ts # 入口文件
│ ├── server.ts # 服务器核心逻辑
│ ├── services/
│ ├── githubService.ts # GitHub API 调用处理
│ └── mcpService.ts # MCP 协议接口实现
├── interfaces/
│ ├── issue.ts # 问题接口定义
│ └── comment.ts # 评论接口定义
└── package.json # 项目依赖管理
📄 许可证
本项目采用 MIT 许可证。详情请参见 LICENSE 文件。
🤑 贡献指南
- Fork 该项目仓库。
- 创建功能分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m '✨ 新增: 简单明了的功能描述')。 - 推送到远程分支 (
git push origin feature/amazing-feature)。 - 提交 Pull Request。
📬 反馈
如遇问题或有任何建议,请通过 Issues 提交。
微信扫一扫