Metadata-Version: 2.4
Name: plane-workflow-mcp
Version: 0.6.0
Summary: Plane task workflows for coding agents: planning rules, previews, and completion records
Author: Plane Workflow Contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/amirhosseinkz/plane-workflow-mcp
Project-URL: Repository, https://github.com/amirhosseinkz/plane-workflow-mcp
Project-URL: Issues, https://github.com/amirhosseinkz/plane-workflow-mcp/issues
Project-URL: Changelog, https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/amirhosseinkz/plane-workflow-mcp/tree/main/docs
Keywords: mcp,model-context-protocol,plane,plane-so,project-management,workflow,claude-code,codex,ai-agents
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastmcp<4,>=3.2.0
Requires-Dist: keyring<26,>=25.0
Requires-Dist: pydantic<3,>=2.11
Requires-Dist: pypdf>=6.15.0
Requires-Dist: python-docx>=1.2.0
Requires-Dist: reportlab>=5.0.0
Requires-Dist: requests<3,>=2.31
Requires-Dist: tzdata>=2025.2; platform_system == "Windows"
Dynamic: license-file

# Plane Workflow MCP

Keep Plane tasks in sync with your coding agent using configurable team workflows.
Draft structured tasks, preview changes, record completion evidence, and get
read-only project briefings or DOCX/PDF reports.

## Install and get your first result

Requires Python 3.11+, uv, and a Plane workspace with an API key.
Install the published GitHub release without cloning:

```bash
uv tool install https://github.com/amirhosseinkz/plane-workflow-mcp/releases/download/v0.6.0/plane_workflow_mcp-0.6.0-py3-none-any.whl
plane-workflow setup --client claude-code
plane-workflow project list
plane-workflow project activate PROJECT_ID
plane-workflow status
```

Replace `PROJECT_ID` with a listed ID. Setup also has `--client codex`, `cursor`,
`claude-desktop`, `opencode`, and `zed` adapters. Restart the client, then ask:

> Confirm my active Plane workspace and project, then show overdue and unassigned
> work. Include identifiers and totals, flag truncated lists, and do not change
> Plane data.

The release command installs v0.6.0. To use an unreleased checkout, run
`uv tool install ./plugins/plane-workflow` from the repository root instead.
No PyPI release is advertised yet.

## Workflow behavior

- Advisory planning accepts incomplete planning data; strict planning requires
  scope, complexity, assignment, an estimate mapping, dates, and an unstarted state.
- Project selection guards work-item mutations against conflicting projects.
- Completion requires a started item, a summary, and verification text; the
  completion record is written before the state transition.
- API keys are stored in the OS keyring by guided setup. Environment variables
  support headless use.

Preview supported writes with `dry_run=true` and ask the agent to wait for approval.
Some writes default to applying changes. Approval is a client workflow, not a
server-enforced human approval gate. Updates happen through tool calls, not a
background code-to-task sync.

## Documentation

- [Quick start and official-server comparison](https://github.com/amirhosseinkz/plane-workflow-mcp#readme)
- [Installation and client compatibility](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/installation.md)
- [Copyable workflow examples](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/examples.md)
- [Planning and workflow configuration](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/workflows.md)
- [Demo](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/demo.md)
- [Support](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/SUPPORT.md)

MIT licensed. Independent community project; not affiliated with Plane.
