金大哥 - planka-mcp MCP 详情

article

README

🚀 PLANKA MCP 服务器

这是一个专为 PLANKA 看板打造的模型上下文协议（MCP）服务器，专为 Claude 及其他 AI 智能体设计。

🚀 快速开始

PLANKA MCP 服务器是一个为 PLANKA 看板服务的 MCP 服务器，可与 Claude 等 AI 智能体协同工作。你可以按照以下步骤进行安装和配置。

✨ 主要特性

全面支持 PLANKA 2.0 API。
通过 Zod 验证实现类型安全。
针对智能体工作流程进行优化（支持组合操作，提供合理默认值）。
拥有涵盖卡片、任务、标签、评论和列表的 13 种工具。

📦 安装指南

你可以使用以下命令安装 PLANKA MCP 服务器：

npm install @gogogadgetbytes/planka-mcp

或者直接运行：

npx @gogogadgetbytes/planka-mcp

📚 详细文档

配置

环境变量

| 变量 | 是否必需 | 描述 | |------|----------|-------------| | PLANKA_BASE_URL | 是 | 你的 PLANKA 服务器 URL | | PLANKA_AGENT_EMAIL | 是 | 智能体用户邮箱 | | PLANKA_AGENT_PASSWORD | 是 | 智能体用户密码 |

Claude 桌面版

在 ~/Library/Application Support/Claude/claude_desktop_config.json 中添加以下内容：

{
  "mcpServers": {
    "planka": {
      "command": "npx",
      "args": ["@gogogadgetbytes/planka-mcp"],
      "env": {
        "PLANKA_BASE_URL": "https://planka.example.com",
        "PLANKA_AGENT_EMAIL": "agent@example.com",
        "PLANKA_AGENT_PASSWORD": "your-password"
      }
    }
  }
}

Claude 代码版

在 ~/.claude.json 中添加以下内容：

{
  "mcpServers": {
    "planka": {
      "command": "npx",
      "args": ["@gogogadgetbytes/planka-mcp"],
      "env": {
        "PLANKA_BASE_URL": "https://planka.example.com",
        "PLANKA_AGENT_EMAIL": "agent@example.com",
        "PLANKA_AGENT_PASSWORD": "your-password"
      }
    }
  }
}

可用工具

卡片

| 工具 | 描述 | |------|-------------| | planka_create_card | 创建卡片（可选添加任务） | | planka_update_card | 更新卡片属性 | | planka_move_card | 将卡片移动到不同列表/位置 | | planka_get_card | 获取包含任务/评论的卡片详情 | | planka_delete_card | 删除卡片 |

任务

| 工具 | 描述 | |------|-------------| | planka_create_tasks | 向卡片添加任务（待办事项） | | planka_update_task | 更新任务名称或完成状态 | | planka_delete_task | 删除任务 |

列表

| 工具 | 描述 | |------|-------------| | planka_manage_lists | 创建/更新/删除列表 |

PLANKA 2.0 兼容性

此服务器专为 PLANKA 2.0 设计，可处理与 1.x 版本的 API 差异：

卡片创建包含必需的 type 字段。
标签端点使用 /card-labels 路径。
可优雅处理可选字段。

开发

# 克隆仓库
git clone https://github.com/gogogadgetbytes/planka-mcp.git
cd planka-mcp

# 安装依赖
npm install

# 构建项目
npm run build

# 运行测试
npm test

💻 使用示例

获取看板结构

使用 planka_get_structure 查看所有项目和看板

创建带任务的卡片

使用 planka_create_card 并提供以下参数：
- listId: "abc123"
- name: "实现功能 X"
- tasks: ["研究", "设计", "实现", "测试"]

在工作流中移动卡片

使用 planka_move_card 将卡片从“待办”移动到“进行中”

📄 许可证

本项目采用 MIT 许可证。

🔗 链接

PLANKA - 看板工具
MCP SDK - 模型上下文协议
设计文档 - 技术设计细节

planka-mcp