跳到主要内容
TypeScript · API v1 + v2 · MCP · CLI

从头到尾都有类型的 Plane API

一个面向 Plane API 的 TypeScript SDK,内置了一个 MCP 服务器和一个 CLI。可以在代码中使用它、从 AI 代理中使用它,或者在终端中使用它:三者共享同一个客户端。

$ npm install @hoyasumii/plane
@hoyasumii/plane

SDK

一个覆盖 API v1 和整个 v2 表面的类型化客户端:90 个资源,在编译期缩小返回类型的字段列表,以及可以导航到其子项的已加载行。

const eng = await client.v2.workspaces.projects.retrieve("acme", "ENG");
await eng.workItems.create({ name: "Fix login bug", state: "Todo" });
plane-mcp

MCP 服务器

面向 Claude Code、Codex、OpenCode 或任意 MCP 客户端的 Plane:按键和按名称工作的任务工具,加上三个可以访问所有 v2 方法的通用工具。

npx plane mcp config
npx plane mcp install
plane

CLI

每个 MCP 工具都是一条终端命令,另外还有 plane mcp 用于在后台运行服务器、在登录时启动它,并将它注册到你的客户端中。

npx plane get-issue --key ACME-14
npx plane list-my-issues --project ACME