🔄 Kanban MCP

🔄 看板 MCP

欢迎使用 Kanban MCP 项目！🎉 本项目将 Planka 看板与 Cursor 的 Machine Control Protocol（MCP）集成，让 Claude 等 AI 助手能够管理你的看板。

🤔 什么是 Kanban MCP？

Kanban MCP 是 Planka（一款开源看板）与 Cursor 的 Machine Control Protocol 之间的桥梁。它让 Claude 等 AI 助手能够：

• 📋 查看和管理项目、看板、列表及卡片
• ✅ 创建和更新任务
• 💬 为卡片添加评论
• 🔄 在列表之间移动卡片
• ⏱️ 追踪任务耗时
• 🚀 还有更多功能！

此集成提供流畅的工作流，你可以让 Claude 帮助管理开发任务、追踪进度并整理工作。

🚦 快速开始

📋 前置条件

• 🐳 用于运行 Planka 的 Docker
• 🔄 用于克隆代码库的 Git
• 🟢 用于开发的 Node.js（版本 18 或更高版本）和 npm

📥 安装

1. 克隆此代码库：

git clone https://github.com/bradrisse/kanban-mcp.git
cd kanban-mcp

2. 安装依赖并构建 TypeScript 代码：

npm install
npm run build

3. 启动 Planka 容器：

npm run up

4. 访问 Planka 看板：

   • 默认 URL：http://localhost:3333
   • 默认凭据：
     • 邮箱：[email protected]
     • 密码：demo

5. 配置 Cursor 以使用 MCP 服务：

   • 在 Cursor 中，前往 Settings > Features > MCP
   • 添加一个新的 MCP 服务，并使用以下配置：

   {
     "mcpServers": {
       "kanban": {
         "command": "node",
         "args": ["/path/to/kanban-mcp/dist/index.js"],
         "env": {
           "PLANKA_BASE_URL": "http://localhost:3333",
           "PLANKA_AGENT_EMAIL": "[email protected]",
           "PLANKA_AGENT_PASSWORD": "demo"
         }
       }
     }
   }
   

   • 将 /path/to/kanban-mcp 替换为你的 kanban-mcp 目录的实际绝对路径

或者，你也可以在项目根目录中创建 .cursor/mcp.json 文件，并使用相同配置，进行项目专属配置。

有关基于 Docker 的部署和其他高级选项，请参阅安装指南。

📚 文档

面向用户

• 🛠️ 安装指南：如何安装和配置 Kanban MCP
• 📝 使用指南：如何将 Kanban MCP 与 Claude 配合使用
• 💡 功能与策略：详细介绍 MCP 服务的功能以及与大模型交互的策略
• ⚠️ 故障排除：常见问题的解决方案

面向开发者

• 👨‍💻 开发者指南：为希望参与贡献或修改 Kanban MCP 的开发者提供的信息
• 📖 API 参考：MCP 命令和 Planka API 集成的详细文档

✨ 功能

Kanban MCP 提供全面的功能集，帮助你管理看板：

📂 项目管理

• 创建和查看项目
• 管理项目设置和成员

📊 看板管理

• 在项目中创建和查看看板
• 自定义看板设置

📋 列表管理

• 在看板中创建和整理列表
• 根据需要调整列表顺序

🗂️ 卡片管理

• 创建、更新和删除卡片
• 在列表之间移动卡片
• 添加描述、截止日期和标签
• 复制卡片以创建模板

⏱️ 时间追踪

• 启动、停止和重置秒表
• 追踪单个任务的耗时
• 分析时间使用模式

✅ 任务管理

• 在卡片中创建和管理任务
• 将任务标记为已完成或未完成

💬 评论管理

• 为卡片添加评论以便讨论
• 查看评论历史

🤖 大模型交互策略

MCP Kanban 支持多种大模型与人类协作的工作流策略：

1. 🤝 大模型驱动开发，由人类审核：大模型执行任务，人类审核并提供反馈
2. 👥 人类驱动开发，由大模型提供支持：人类执行任务，大模型提供分析和建议
3. 🧠 协作梳理与规划：人类和大模型共同规划和组织任务

有关这些策略的更多详情，请参阅 Capabilities and Strategies wiki 页面。

📦 可用的 npm 脚本

• npm run build：构建 TypeScript 代码
• npm run build-docker：构建 TypeScript 代码并创建 Docker 镜像
• npm run up：启动 Planka 容器（kanban 和 postgres）
• npm run down：停止所有容器
• npm run restart：重启 Planka 容器
• npm run start-node：直接使用 Node 启动 MCP 服务（用于在 Cursor 之外进行测试）
• npm run qc：运行质量检查（lint 和类型检查）

🤝 参与贡献

欢迎为 Kanban MCP 贡献！如果你想参与贡献：

1. 查看 Developer Guide，了解项目结构和开发工作流
2. 查看未解决的问题，寻找需要帮助处理的任务
3. 提交包含更改的 pull request

🆘 支持

如果你在使用 Kanban MCP 时需要帮助：

1. 查看 Troubleshooting 页面，寻找常见问题的解决方案
2. 搜索 GitHub 问题，查看是否有人报告过你的问题
3. 如果找不到解决方案，请新建一个 issue

📜 许可证

Kanban MCP 是采用 MIT License 许可的开源软件。详情请参阅 LICENSE 文件。