@openpets/plane
v1.0.0
Published
Manage projects, issues, cycles, and modules in Plane.so - an open-source project tracking tool
Maintainers
Readme
Plane.so Plugin
Manage projects, work items (issues), cycles, and modules in Plane - an open-source project tracking tool.
Setup
1. Get Your API Key
- Go to your Plane workspace settings
- Navigate to API Tokens
- Create a new token with the required permissions
2. Configure Environment Variables
Create a .env file in this directory:
# Required
PLANE_API_KEY=your-api-key-here
PLANE_WORKSPACE_SLUG=your-workspace-slug
# Optional (for self-hosted instances)
PLANE_BASE_URL=https://api.plane.soYour workspace slug is found in your Plane URL: https://app.plane.so/your-workspace-slug
3. Install & Run
pnpm install
pnpm run quickstartAvailable Tools
Connection
plane-test-connection- Test connection and get user/workspace infoplane-get-current-user- Get current user detailsplane-get-workspace-members- List workspace members
Projects
plane-get-projects- List all projectsplane-get-project- Get project details with membersplane-create-project- Create a new projectplane-update-project- Update project settings
Work Items (Issues)
plane-get-work-items- List work items in a projectplane-get-work-item- Get work item details by IDplane-get-work-item-by-identifier- Get by identifier (e.g., PROJ-123)plane-create-work-item- Create a new work itemplane-update-work-item- Update a work itemplane-delete-work-item- Delete a work itemplane-search-work-items- Search work items by text
States & Labels
plane-get-states- Get workflow states for a projectplane-create-state- Create a new workflow stateplane-get-labels- Get project labelsplane-create-label- Create a new label
Cycles (Sprints)
plane-get-cycles- List cycles in a projectplane-get-cycle- Get cycle detailsplane-create-cycle- Create a new cycleplane-update-cycle- Update cycle settingsplane-get-cycle-work-items- List work items in a cycleplane-add-work-items-to-cycle- Add work items to a cycleplane-remove-work-item-from-cycle- Remove work item from cycle
Modules
plane-get-modules- List modules in a projectplane-get-module- Get module detailsplane-create-module- Create a new moduleplane-update-module- Update module settingsplane-get-module-work-items- List work items in a moduleplane-add-work-items-to-module- Add work items to a moduleplane-remove-work-item-from-module- Remove work item from module
Comments
plane-get-work-item-comments- Get comments on a work itemplane-add-comment- Add a comment to a work item
Example Queries
"list all projects in Plane"
"create a new issue called 'Fix login bug' in project X"
"show work items in the current sprint"
"add issue PROJ-123 to the Q4 module"
"what's the status of PROJ-456?"Self-Hosted Plane
For self-hosted Plane instances, set the PLANE_BASE_URL environment variable to your API endpoint:
PLANE_BASE_URL=https://your-plane-api.example.com