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.

Prerequisite: UiPath skills CLI

The UiPlan plan/implement flow routes through the official UiPath skills (uipath-planner, uipath-project-discovery-agent, and specialist skills), delivered by the @uipath/cli npm package. Install it once (needs Node.js):

npm install -g @uipath/cli

uiplan check reports whether node, npm, and uip are available; uiplan init warns if the UiPath CLI is missing.

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.2.tar.gz (121.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.2-py3-none-any.whl (138.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: uiplan-0.2.2.tar.gz
  • Upload date:
  • Size: 121.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.2.tar.gz
Algorithm Hash digest
SHA256 a6e36ef7ae62d3abe4860e7f785a1c79a3a2cdb0f81161faab7ec3ef46016e74
MD5 d3304ab37c59fbb21a5d8dcf3d034298
BLAKE2b-256 925ff9665f2d48065b42f7d88e109e3c1e56ed51ce9ac1bd3bc267a2cc41e837

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uiplan-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 138.8 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 671b643b994d8c8c6ca8c0d335113e42faf48a4b885b38e5ddc29a426035b40c
MD5 12f744fdffa94de6233c6ba8b72056a6
BLAKE2b-256 d7092c57a237d4ab1feb36d77fdefb6b6c5ed6ee384bdcdc61d602fc09920a05

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