Skip to main content

Lightweight UiPlan kit with MCP plan tools and scaffolding

Project description

UiPlan Light Kit

Lightweight distribution of UiPlan planning tools and helper files.

Install and initialize

uvx --from uiplan uiplan init --ai cursor

For immediate local use from this repository (before publish):

uv run --project packages/uiplan-kit uiplan init --here --ai cursor --engine

Options:

  • --ai cursor|claude|copilot|all selects command/skill wrappers to scaffold.
  • --engine (default) writes .cursor/mcp.json entry for uiplan-mcp.
  • --static scaffolds docs/templates only, without MCP server wiring.
  • --from-release <tag> pulls assets from uiplan-kit-<tag>.zip.
  • --force overwrites existing scaffolded files.

Commands

  • uiplan init [PATH]
  • uiplan check
  • uiplan version
  • uiplan-mcp (stdio MCP server exposing uipath_plan_* tools)

Using it (after install)

uiplan init scaffolds files and registers the MCP server; it does not generate a plan by itself. Reopen your editor so the uiplan MCP server in .cursor/mcp.json is picked up, then drive the spec-kit-style lifecycle from chat:

/uiplan-constitution        project guardrails (once per repo)
/uiplan-ground <topic>      gather context
/uiplan-specify <title> --intent "<goal>"   (alias: /uiplan-spec)
/uiplan-clarify <slug>      resolve open questions
/uiplan-plan <slug>
/uiplan-tasks <slug>
/uiplan-analyze <slug>      cross-artifact consistency gate (read-only)
/uiplan-review <slug> all
/uiplan-implement <slug>    execution handoff (run analyze first)

Bundles are written to .cursor/plans/<slug>/ as spec.md, plan.md, and tasks.md. No PyPI login is needed to use the kit; tokens are only for publishing (see RELEASING.md).

What gets installed

  • templates/uiplan/
  • docs/uiplan/
  • docs/plans/constitution.md (seeded if missing)
  • .cursor/skills/uiplan*/SKILL.md (for Cursor mode)
  • optional .claude/commands/ and .github/copilot/ wrappers

Uninstall

Delete scaffolded files and remove uiplan server from .cursor/mcp.json.

Releasing a new version

See RELEASING.md for the version bump, clean-room test, and publish steps.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

uiplan-0.2.1.tar.gz (120.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

uiplan-0.2.1-py3-none-any.whl (138.0 kB view details)

Uploaded Python 3

File details

Details for the file uiplan-0.2.1.tar.gz.

File metadata

  • Download URL: uiplan-0.2.1.tar.gz
  • Upload date:
  • Size: 120.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for uiplan-0.2.1.tar.gz
Algorithm Hash digest
SHA256 9c2a07a20223c79d38946567d99ac04f1fe95fc5be7c05de516968ae75d43b1a
MD5 bc0ca8999bfa699a83bfdb2f04b2c3e5
BLAKE2b-256 25e06486ae0be13dcc09f8619bb975fd10137d8b827361c96f02fa9215cebc0c

See more details on using hashes here.

File details

Details for the file uiplan-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: uiplan-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 138.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.10

File hashes

Hashes for uiplan-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3d756178cde53ed0cd2b3b154c532cdee6358f86e7a9674a7d7ac70d44e6fd6e
MD5 7a465cd1eaf72635d5be7b8731e883a3
BLAKE2b-256 46d3c9f52a37b41b9f2fd546cf7db1e0c6ab2010e3e19b334da2353e3a594d7a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page