mcpField
P
plane-api

plane-api

github.com/montagao生产力353 次安装8 周前更新
代码仓库

关于 plane-api

plane-api 是用于操作 Plane 工作项的内部 Skill,通过统一的 JSON 接口创建、列出和更新条目,适合需要以结构化方式管理 Plane 项目的调用方。

主要功能

  1. 01创建带元数据的工作项
  2. 02按条件筛选并搜索条目
  3. 03更新字段与标签
  4. 04返回结构化 JSON

适用场景

  1. 01根据请求创建 Plane 条目
  2. 02按状态、标签或日期查找条目
  3. 03修改条目的优先级或描述

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/montagao/skills --skill plane-api

安装后在 Claude Code 中输入/plane-api确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

biome.json
bun.lock
package.json
plane.js
tsconfig.json
tests/
plane.test.js

详细介绍

plane-api(内部)

Plane 的统一、一致接口。

配置

此技能从密钥/环境变量读取 Plane 连接设置(不进行提示):

  • PLANE_BASE_URL(优先)或 PLANE_API_URL
  • PLANE_WORKSPACE_SLUG
  • PLANE_PROJECT_ID
  • PLANE_API_KEY

(可选:如果已配置,则支持多个配置档案,例如 profile: "personal"|"business"。)

输入约定

调用方提供一个 JSON 对象:

创建

{ "action": "create", "title": "...", "description": "...(可选)", "due": "YYYY-MM-DD(可选)", "priority": "urgent|high|medium|low|none(可选)", "labels": ["claw_inbox", "..."](可选) }

列表

{ "action": "list", "limit": 20, "filters": { "labels": ["claw_inbox"](可选), "dueFrom": "YYYY-MM-DD"(可选), "dueTo": "YYYY-MM-DD"(可选), "state": "..."(可选), "search": "..."(可选) } }

更新

{ "action": "update", "id": "work_item_id", "patch": { "title": "...(可选)", "description": "...(可选)", "due": "YYYY-MM-DD(可选)", "priority": "urgent|high|medium|low|none(可选)", "state": "...(可选)", "labels": ["..."](可选) } }

行为

  • 从不向用户提问(由调用方处理)。
  • 如果平台提供传入消息 ID,则尽力确保幂等性。
  • 仅返回结构化 JSON。
  • 返回工作项 URL 时,使用规范的 Web 路由:
    • https://<plane-domain>/<workspaceSlug>/browse/<PROJECT_IDENTIFIER>-<SEQUENCE_ID>
  • 绝不生成 /projects/<project>/issues/<issue> 等旧版链接,因为这些链接可能不正确或重定向不理想。
  • 如果无法安全地解析面向用户的议题键,则省略 url,不要猜测。

输出(始终为 JSON)

成功示例: { "ok": true, "action": "create", "id": "...", "issue_key": "TMOM-461", "url": "https://todo.translate.mom/translatemom/browse/TMOM-461", "title": "..." }

失败示例: { "ok": false, "action": "create", "error": "...", "status": 401 }

评论

支持 Markdown