productivity
Plane MCP, CLI, and Lua Integration for AI Agents
Plane integration docs for AI agents: MCP gateway setup, Plane CLI commands, Lua API reference, credentials, and function schemas.
33 functions 19 read 14 write API key auth
Plane for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
plane- route_slug
plane- package
plane- auth_strategy
api_keyAPI key- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. Plane CLIHeadless setup and direct function calls. Plane MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
Plane MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for Plane.
Claude Code Plane MCP setup for Claude Code. Cursor Plane MCP setup for Cursor. Codex Plane MCP setup for Codex. OpenAI Agents Plane MCP setup for OpenAI Agents SDK. Claude Agent SDK Plane MCP setup for Claude Agent SDK. Vercel AI SDK Plane MCP setup for Vercel AI SDK. LangChain Plane MCP setup for LangChain. LangGraph Plane MCP setup for LangGraph. CrewAI Plane MCP setup for CrewAI. MCP clients Plane MCP setup for Generic MCP Clients.
Plane CLI Matrix
Use these pages for direct Plane CLI workflows in scripts, CI, cron, and agent wrappers.
CI Plane CLI for CI. Cron Jobs Plane CLI for cron jobs. Shell Scripts Plane CLI for shell scripts. Headless Automation Plane CLI for headless automation. Coding Agents Plane CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
plane.plane_list_workspaces | Read read | 0 | List all Plane.so workspaces the authenticated user belongs to. Returns workspace slug, name, and owner info. Use the slug to reference workspaces in other tools. |
plane.plane_list_projects | Read read | 1 | List all projects in a Plane.so workspace. Returns project ID, name, identifier, description, and status. Use the project ID to reference projects in other tools. |
plane.plane_get_project | Read read | 2 | Get detailed information about a Plane.so project, including name, identifier, description, status, dates, and settings. |
plane.plane_create_project | Write write | 7 | Create a new project in a Plane.so workspace. Requires a name and identifier (short code, e.g., "PROJ"). Optionally set description, cover image, project lead, and default assignee. |
plane.plane_archive_project | Write write | 2 | Archive a Plane.so project. Archived projects are hidden from active views but retain all data. |
plane.plane_list_issues | Read read | 10 | List issues in a Plane.so project. Supports filtering by state, priority, assignee, labels, and more. Returns issue ID, name, sequence ID, state, priority, assignees, labels, start/target dates, and created date. |
plane.plane_search_issues | Read read | 6 | Search issues across all projects in a Plane.so workspace. Provide a search query to find issues by name or description. Optionally filter by project, state, priority, or assignee. |
plane.plane_get_issue | Read read | 3 | Get detailed information about a single Plane.so issue, including description, state, priority, assignees, labels, dates, and relations. The issue_id may be a UUID or an issue reference like KOS-55 on Plane deployments that support it. |
plane.plane_create_issue | Write write | 11 | Create a new issue in a Plane.so project. Requires a title. Optionally set description (HTML), state, priority, assignees, labels, start/target dates, and parent issue. |
plane.plane_update_issue | Write write | 12 | Update an existing Plane.so issue. Provide only the fields you want to change — name, description, state, priority, assignees, labels, dates, or parent. |
plane.plane_delete_issue | Write write | 3 | Delete an issue from a Plane.so project. This action is permanent and cannot be undone. |
plane.plane_create_comment | Write write | 4 | Add a comment to a Plane.so issue. The comment body should be provided in HTML format. |
plane.plane_list_comments | Read read | 3 | List all comments on a Plane.so issue. Returns comment ID, content, author, and timestamps. |
plane.plane_list_cycles | Read read | 2 | List all cycles in a Plane.so project. Returns cycle ID, name, start/end dates, and progress info. |
plane.plane_get_cycle | Read read | 3 | Get detailed information about a Plane.so cycle, including name, description, start/end dates, and status. |
plane.plane_create_cycle | Write write | 6 | Create a new cycle (sprint) in a Plane.so project. Optionally set name, description, and date range. |
plane.plane_add_issue_to_cycle | Write write | 4 | Add an existing issue to a Plane.so cycle. The issue will be tracked within the cycle's sprint/iteration. |
plane.plane_list_modules | Read read | 2 | List all modules in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration"). Returns module ID, name, description, status, and dates. |
plane.plane_get_module | Read read | 3 | Get detailed information about a Plane.so module, including name, description, status, dates, and team. |
plane.plane_create_module | Write write | 7 | Create a new module in a Plane.so project. Modules group related issues together (e.g., "Auth System", "Payment Integration"). Optionally set description, status, and date range. |
plane.plane_add_issue_to_module | Write write | 4 | Add an existing issue to a Plane.so module. Modules group related issues for feature-based organization. |
plane.plane_list_states | Read read | 2 | List all workflow states in a Plane.so project. Returns state UUID, name, group (backlog/unstarted/started/completed/cancelled), and color. Use state UUIDs when creating or updating issues. |
plane.plane_create_state | Write write | 7 | Create a new workflow state in a Plane.so project. States represent issue statuses (e.g., "In Review", "Ready for QA"). Requires a name and group (backlog, unstarted, started, completed, cancelled). Optionally set color and description. |
plane.plane_list_labels | Read read | 2 | List all labels in a Plane.so project. Returns label UUID, name, color, and parent label. Use label UUIDs when creating or updating issues. |
plane.plane_create_label | Write write | 6 | Create a new label in a Plane.so project. Labels categorize issues (e.g., "bug", "feature", "urgent"). Requires a name. Optionally set color (hex) and description. Supports hierarchical labels via parent UUID. |
plane.plane_list_pages | Read read | 2 | List all pages in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation. Returns page ID, name, description, and ownership info. |
plane.plane_get_page | Read read | 3 | Get detailed content of a Plane.so page, including the full HTML description. |
plane.plane_create_page | Write write | 4 | Create a new page in a Plane.so project. Pages are Notion-like documents for notes, specs, and documentation. Requires a name. Optionally set HTML content. |
plane.plane_list_issue_activities | Read read | 3 | List activity/audit events on a Plane.so issue. Returns changes made to the issue (state changes, assignments, updates, comments) with who made them and when. |
plane.plane_create_issue_link | Write write | 5 | Attach an external link to a Plane.so issue. Provide a title and a valid URL. |
plane.plane_list_issue_relations | Read read | 3 | List all relations on a Plane.so issue. Relations describe how issues connect: blocking, blocked_by, duplicate, relates_to, start_before, start_after, finish_before, finish_after. |
plane.plane_list_members | Read read | 2 | List members of a Plane.so workspace or project. If project_id is provided, returns project members only; otherwise returns all workspace members. Returns member ID, display name, email, and role. |
plane.plane_get_current_user | Read read | 0 | Get the currently authenticated Plane.so user. Returns user ID, display name, email, and avatar. Useful for verifying API credentials and identifying the current user context. On some self-hosted Plane deployments where the user endpoint is unavailable, this falls back to verifying workspace-scoped access. |