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
uip skills install --agent cursor   # fetch the UiPath skill catalog (refresh: uip skills update)

uiplan check reports whether node, npm, and uip are available; uiplan init warns if the UiPath CLI is missing. UiPlan grounding then discovers the installed skills dynamically (from .cursor/rules/ for Cursor or .claude/skills/ for Claude) and routes the generated plan only to skills that actually exist.

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.3.0.tar.gz (123.8 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.3.0-py3-none-any.whl (140.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for uiplan-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d84a4ced777574c4f3e8cac4f746ae34f1ceaf98e414fc4ea3cda04870f2a6ca
MD5 5c45bcc50026749c8570b7eef60f0344
BLAKE2b-256 0b057053deb90eba510592f34df20c4fb82c120d8a787b37074f74cf235372ef

See more details on using hashes here.

File details

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

File metadata

  • Download URL: uiplan-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 140.3 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 cbb6ab2bd72db26b0af7a6daf25c100c2a026139216e0508e600f2d446b0ebe3
MD5 0d803768f7dd302f53a1763cee46b32c
BLAKE2b-256 462a8016b84536f8215a66d7accbe8a196cdb50f26e3b218fde9a9a88cd71f14

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