使用说明

项目简介

Kanban MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现，旨在桥接 Planka 看板应用和支持 MCP 协议的客户端，例如 Cursor 编辑器。通过此服务器，你可以使用 AI 助手（如 Claude）直接管理 Planka 看板中的项目、任务和工作流程，提升工作效率和协作体验。

主要功能点

项目与看板管理：创建、查看和管理 Planka 中的项目和看板。
列表与卡片管理：在看板中创建、组织和管理列表和卡片，支持卡片的创建、更新、移动、复制和删除等操作。
任务管理：在卡片中创建和管理任务，跟踪任务完成状态。
评论与标签：为卡片添加评论进行讨论，使用标签进行分类和标记。
时间追踪：启动、停止和重置卡片上的计时器，跟踪任务耗时。

安装步骤

克隆仓库

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

安装依赖并构建

npm install
npm run build

启动 Planka 看板 (可选，如果已有 Planka 环境可跳过)
```
npm run up
```
这将使用 Docker 启动 Planka 看板和 PostgreSQL 数据库。

启动 MCP 服务器

npm run start-node

或者，你也可以直接运行编译后的 JavaScript 文件：

node dist/index.js

服务器配置

要将 Kanban MCP Server 连接到 MCP 客户端（例如 Cursor），你需要在客户端中配置 MCP 服务器信息。以下是 Cursor 编辑器所需的配置示例：

{
  "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"
      }
    }
  }
}

'"kanban"': 服务器名称，可以自定义。
'"command": "node"': 启动服务器的命令，这里使用 Node.js 运行 JavaScript 文件。
'"args": ["/path/to/kanban-mcp/dist/index.js"]': 启动命令的参数，指向 Kanban MCP Server 编译后的入口文件 'index.js' 的绝对路径。请将 '/path/to/kanban-mcp' 替换为你本地仓库的实际路径。
'"env"': 环境变量配置，用于连接到 Planka 看板实例。
- '"PLANKA_BASE_URL": "http://localhost:3333"': Planka 看板的访问地址。如果使用 'npm run up' 启动，默认地址为 'http://localhost:3333'。
- '"PLANKA_AGENT_EMAIL": "[email protected]"': 用于访问 Planka 看板的代理用户邮箱，需在 Planka 中预先创建。
- '"PLANKA_AGENT_PASSWORD": "demo"': 代理用户的密码。

基本使用方法

配置完成后，在 MCP 客户端中，你可以通过自然语言指令调用 Kanban MCP Server 提供的工具，例如：

"列出我的看板项目"
"在 ‘待办’ 列表中创建一个名为 ‘设计用户界面’ 的卡片"
"将 ‘开发功能X’ 卡片移动到 ‘进行中’ 列表"
"为 ‘修复Bug Y’ 卡片添加评论 ‘已完成初步修复，待测试’"

具体的使用指令和功能取决于 MCP 客户端的实现和支持的工具。请参考仓库文档和客户端的使用说明了解更多信息。

关键词

使用说明

信息