plane-workflow-mcp 0.6.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (23) hide show
  1. plane_workflow_mcp-0.6.0/LICENSE +21 -0
  2. plane_workflow_mcp-0.6.0/PKG-INFO +90 -0
  3. plane_workflow_mcp-0.6.0/README.md +55 -0
  4. plane_workflow_mcp-0.6.0/plane_workflow_mcp/__init__.py +1 -0
  5. plane_workflow_mcp-0.6.0/plane_workflow_mcp/__main__.py +5 -0
  6. plane_workflow_mcp-0.6.0/plane_workflow_mcp/cli.py +603 -0
  7. plane_workflow_mcp-0.6.0/plane_workflow_mcp/configuration.py +273 -0
  8. plane_workflow_mcp-0.6.0/plane_workflow_mcp/profiles.json +54 -0
  9. plane_workflow_mcp-0.6.0/plane_workflow_mcp/reports.py +447 -0
  10. plane_workflow_mcp-0.6.0/plane_workflow_mcp/server.py +3598 -0
  11. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/PKG-INFO +90 -0
  12. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/SOURCES.txt +21 -0
  13. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/dependency_links.txt +1 -0
  14. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/entry_points.txt +2 -0
  15. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/requires.txt +10 -0
  16. plane_workflow_mcp-0.6.0/plane_workflow_mcp.egg-info/top_level.txt +1 -0
  17. plane_workflow_mcp-0.6.0/pyproject.toml +52 -0
  18. plane_workflow_mcp-0.6.0/setup.cfg +4 -0
  19. plane_workflow_mcp-0.6.0/tests/test_active_context.py +140 -0
  20. plane_workflow_mcp-0.6.0/tests/test_cli.py +131 -0
  21. plane_workflow_mcp-0.6.0/tests/test_configuration.py +89 -0
  22. plane_workflow_mcp-0.6.0/tests/test_lifecycle.py +752 -0
  23. plane_workflow_mcp-0.6.0/tests/test_reports.py +83 -0
plane_workflow_mcp-0.6.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Plane Workflow Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
plane_workflow_mcp-0.6.0/PKG-INFO ADDED
@@ -0,0 +1,90 @@
1
+ Metadata-Version: 2.4
2
+ Name: plane-workflow-mcp
3
+ Version: 0.6.0
4
+ Summary: Plane task workflows for coding agents: planning rules, previews, and completion records
5
+ Author: Plane Workflow Contributors
6
+ License-Expression: MIT
7
+ Project-URL: Homepage, https://github.com/amirhosseinkz/plane-workflow-mcp
8
+ Project-URL: Repository, https://github.com/amirhosseinkz/plane-workflow-mcp
9
+ Project-URL: Issues, https://github.com/amirhosseinkz/plane-workflow-mcp/issues
10
+ Project-URL: Changelog, https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/CHANGELOG.md
11
+ Project-URL: Documentation, https://github.com/amirhosseinkz/plane-workflow-mcp/tree/main/docs
12
+ Keywords: mcp,model-context-protocol,plane,plane-so,project-management,workflow,claude-code,codex,ai-agents
13
+ Classifier: Development Status :: 4 - Beta
14
+ Classifier: Environment :: Console
15
+ Classifier: Intended Audience :: Developers
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Programming Language :: Python :: 3
18
+ Classifier: Programming Language :: Python :: 3 :: Only
19
+ Classifier: Programming Language :: Python :: 3.11
20
+ Classifier: Programming Language :: Python :: 3.12
21
+ Classifier: Programming Language :: Python :: 3.13
22
+ Classifier: Topic :: Software Development
23
+ Requires-Python: >=3.11
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ Requires-Dist: fastmcp<4,>=3.2.0
27
+ Requires-Dist: keyring<26,>=25.0
28
+ Requires-Dist: pydantic<3,>=2.11
29
+ Requires-Dist: pypdf>=6.15.0
30
+ Requires-Dist: python-docx>=1.2.0
31
+ Requires-Dist: reportlab>=5.0.0
32
+ Requires-Dist: requests<3,>=2.31
33
+ Requires-Dist: tzdata>=2025.2; platform_system == "Windows"
34
+ Dynamic: license-file
35
+
36
+ # Plane Workflow MCP
37
+
38
+ Keep Plane tasks in sync with your coding agent using configurable team workflows.
39
+ Draft structured tasks, preview changes, record completion evidence, and get
40
+ read-only project briefings or DOCX/PDF reports.
41
+
42
+ ## Install and get your first result
43
+
44
+ Requires Python 3.11+, uv, and a Plane workspace with an API key.
45
+ Install the published GitHub release without cloning:
46
+
47
+ ```bash
48
+ 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
49
+ plane-workflow setup --client claude-code
50
+ plane-workflow project list
51
+ plane-workflow project activate PROJECT_ID
52
+ plane-workflow status
53
+ ```
54
+
55
+ Replace `PROJECT_ID` with a listed ID. Setup also has `--client codex`, `cursor`,
56
+ `claude-desktop`, `opencode`, and `zed` adapters. Restart the client, then ask:
57
+
58
+ > Confirm my active Plane workspace and project, then show overdue and unassigned
59
+ > work. Include identifiers and totals, flag truncated lists, and do not change
60
+ > Plane data.
61
+
62
+ The release command installs v0.6.0. To use an unreleased checkout, run
63
+ `uv tool install ./plugins/plane-workflow` from the repository root instead.
64
+ No PyPI release is advertised yet.
65
+
66
+ ## Workflow behavior
67
+
68
+ - Advisory planning accepts incomplete planning data; strict planning requires
69
+ scope, complexity, assignment, an estimate mapping, dates, and an unstarted state.
70
+ - Project selection guards work-item mutations against conflicting projects.
71
+ - Completion requires a started item, a summary, and verification text; the
72
+ completion record is written before the state transition.
73
+ - API keys are stored in the OS keyring by guided setup. Environment variables
74
+ support headless use.
75
+
76
+ Preview supported writes with `dry_run=true` and ask the agent to wait for approval.
77
+ Some writes default to applying changes. Approval is a client workflow, not a
78
+ server-enforced human approval gate. Updates happen through tool calls, not a
79
+ background code-to-task sync.
80
+
81
+ ## Documentation
82
+
83
+ - [Quick start and official-server comparison](https://github.com/amirhosseinkz/plane-workflow-mcp#readme)
84
+ - [Installation and client compatibility](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/installation.md)
85
+ - [Copyable workflow examples](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/examples.md)
86
+ - [Planning and workflow configuration](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/workflows.md)
87
+ - [Demo](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/demo.md)
88
+ - [Support](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/SUPPORT.md)
89
+
90
+ MIT licensed. Independent community project; not affiliated with Plane.
plane_workflow_mcp-0.6.0/README.md ADDED
@@ -0,0 +1,55 @@
1
+ # Plane Workflow MCP
2
+
3
+ Keep Plane tasks in sync with your coding agent using configurable team workflows.
4
+ Draft structured tasks, preview changes, record completion evidence, and get
5
+ read-only project briefings or DOCX/PDF reports.
6
+
7
+ ## Install and get your first result
8
+
9
+ Requires Python 3.11+, uv, and a Plane workspace with an API key.
10
+ Install the published GitHub release without cloning:
11
+
12
+ ```bash
13
+ 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
14
+ plane-workflow setup --client claude-code
15
+ plane-workflow project list
16
+ plane-workflow project activate PROJECT_ID
17
+ plane-workflow status
18
+ ```
19
+
20
+ Replace `PROJECT_ID` with a listed ID. Setup also has `--client codex`, `cursor`,
21
+ `claude-desktop`, `opencode`, and `zed` adapters. Restart the client, then ask:
22
+
23
+ > Confirm my active Plane workspace and project, then show overdue and unassigned
24
+ > work. Include identifiers and totals, flag truncated lists, and do not change
25
+ > Plane data.
26
+
27
+ The release command installs v0.6.0. To use an unreleased checkout, run
28
+ `uv tool install ./plugins/plane-workflow` from the repository root instead.
29
+ No PyPI release is advertised yet.
30
+
31
+ ## Workflow behavior
32
+
33
+ - Advisory planning accepts incomplete planning data; strict planning requires
34
+ scope, complexity, assignment, an estimate mapping, dates, and an unstarted state.
35
+ - Project selection guards work-item mutations against conflicting projects.
36
+ - Completion requires a started item, a summary, and verification text; the
37
+ completion record is written before the state transition.
38
+ - API keys are stored in the OS keyring by guided setup. Environment variables
39
+ support headless use.
40
+
41
+ Preview supported writes with `dry_run=true` and ask the agent to wait for approval.
42
+ Some writes default to applying changes. Approval is a client workflow, not a
43
+ server-enforced human approval gate. Updates happen through tool calls, not a
44
+ background code-to-task sync.
45
+
46
+ ## Documentation
47
+
48
+ - [Quick start and official-server comparison](https://github.com/amirhosseinkz/plane-workflow-mcp#readme)
49
+ - [Installation and client compatibility](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/installation.md)
50
+ - [Copyable workflow examples](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/examples.md)
51
+ - [Planning and workflow configuration](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/workflows.md)
52
+ - [Demo](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/docs/demo.md)
53
+ - [Support](https://github.com/amirhosseinkz/plane-workflow-mcp/blob/main/SUPPORT.md)
54
+
55
+ MIT licensed. Independent community project; not affiliated with Plane.
plane_workflow_mcp-0.6.0/plane_workflow_mcp/__init__.py ADDED
@@ -0,0 +1 @@
1
+ """Package data for the portable Plane Workflow MCP distribution."""
plane_workflow_mcp-0.6.0/plane_workflow_mcp/__main__.py ADDED
@@ -0,0 +1,5 @@
1
+ """Allow ``python -m plane_workflow_mcp``."""
2
+
3
+ from .cli import main
4
+
5
+ raise SystemExit(main())