使用说明
Planka MCP服务器🚀
AI代理和Planka v2之间最强大、最去中心化的桥梁。
这个高性能的MCP服务器将您的Planka实例转换为AI助手(Claude、Cursor等)的结构化知识库。
🌟 主要特点
- 渐进式发现:我们没有用60多种工具压倒你的人工智能,而是使用 动态资源 (
planka://hub,planka://projects)指导代理人。它只在需要的时候看到它需要什么。 - “上帝中心”:从以下内容开始
planka://hub查看整个Planka实例的全局概览——项目、用户和未读通知一目了然。 - 去中心化通知:自定义
Notification Services支持。非管理员用户现在可以通过反向代理(frp)将Planka事件桥接到本地接收器来构建自己的自动化流程。 - 无状态&安全:服务器端无持久性。代理根据请求注入凭据,确保绝对隐私和多租户支持。
- 原生C++20性能:内置
coke和wfrest,利用高并发协程实现零延迟交互。 - 档案感知:每块板都暴露
archiveListId在其总结中。要存档卡片,请将其移动到该列表中--isArchived/isClosed不要在卡片上做任何事情,也不应该被使用。
🛠 可用工具
此MCP服务器提供了一套精简的5个核心工具。它遵循a 资源优先 大多数工具通过基于URI的发现与Planka交互。
| 工具 | 说明 |
|---|---|
planka_explore |
岩芯发现工具。 用于通过URI探索Planka资源(例如。, planka://hub, planka://projects).这充当了不支持本机MCP资源的客户端的兼容性桥梁。 |
planka_create |
创建任何Planka实体:项目、板、列表、卡片、任务列表、任务、标签、注释、Webhook等。 |
planka_update |
更新现有实体的属性(例如,卡描述、板名称或将卡移动到另一个列表)。 |
planka_delete |
安全地从系统中删除实体。 |
planka_action |
专业操作:复制卡片、移动列表中的所有卡片、管理董事会/卡片成员和标签。 |
Planka MCP通过三种主要操作模式适应您的环境:
- 💻 本地二进制(Stdio):与桌面AI客户端(Cursor、Claude desktop)直接集成。
- 🌐 后台服务(HTTP/SSE):主机即持久web服务(支持Systemd)。
- 🐳 容器化网关(Docker):生产级,多平台部署。
🚀 安装和快速启动
选项A:来自Docker Hub(推荐)
最简单的开始方式。无需本地构建。
docker pull tenire/planka-mcp:latest
作为无状态HTTP/SSE网关运行:
# Recommended for IPv6 stability and proper signal handling
docker run -d --name planka-mcp \
--network host \
--init \
--restart always \
tenire/planka-mcp:latest --http --port 7526
选项B:从源代码构建
要求: Linux(Ubuntu 24.04),C++20编译器。
-
安装xmake:
curl -fsSL https://xmake.io/shget.text | bash -
克隆和构建:
git clone https://github.com/Tenicrab/planka-mcp.git cd planka-mcp xmake f -m release --yes xmake build planka-mcp xmake install -o ./dist planka-mcp二进制位置:
./dist/bin/planka-mcp.
作为持久HTTP/SSE服务运行:
./dist/bin/planka-mcp --http --port 7526
(您也可以使用 systemd 将其作为后台服务进行管理)。
选项C:手动Docker构建
如果你想在本地建立自己的形象:
docker build -t planka-mcp:latest -f deploy/Dockerfile .
⚙️ 配置(mcpServers.json)
1.标准模式(CLI驱动)
理想选择 克劳德桌面版 或 光标。凭证注入是通过参数处理的。
{
"mcpServers": {
"planka": {
"command": "/usr/local/bin/planka-mcp",
"args": [
"--stdio",
"--url", "https://your-planka-instance.top:8080",
"--api-key", "HwQsvOKO_YOUR_SECRET_KEY"
]
}
}
}
2.SSE模式(网关驱动)
理想选择 码头工人 或云部署。服务器充当无状态网桥。
{
"mcpServers": {
"planka": {
"url": "http://your-gateway-ip:7526/",
"headers": {
"X-Planka-Url": "https://your-planka-instance.top:8080",
"X-Planka-Api-Key": "HwQsvOKO_YOUR_SECRET_KEY"
}
}
}
}
或
“url”:“http://your-gateway-ip:7526/mcp" “url”:“http://your-gateway-ip:7526/sse"
🔒 无状态安全
- 代理驱动:此服务器遵循 Agent控制配置原理。它不会保存凭据。
- 多租户技术:通过为每个客户端连接使用单独的标头,单个服务器实例可以安全地为具有不同Planka后端的多个用户提供服务。
- 精确度:强制执行基于字符串的雪花ID处理,以防止LLM交互中的精度损失。
⚠️ 网络说明
在Docker中运行并将事件转发回本地代理时,请使用 http://host.docker.internal:PORT 以桥接容器隔离。
