Skip to main content
Glama
ply-ui-ng

Ply UI

Official

Initialize Ply in a project

init_project
Destructive

Creates missing Ply setup files only when absent: ply-ui.json, ply-ui.css, icon sprites, @source, and design skills. Runs non-interactively and leaves existing project files untouched.

Instructions

Create missing Ply setup files (ply-ui-cli init --yes): ply-ui.json, ply-ui.css, icon sprites, @source, and the design skill in .cursor/skills and .agents/skills, and only when those files are absent. Existing project files stay. refreshEditorKit is the only replacement: it overwrites an editor kit that is already there. add_components installs named components once ply-ui.json exists; update_components refreshes tracked copies. Always non-interactive.

Input Schema

NameRequiredDescriptionDefault
cwdNoProject root to initialize (defaults to MCP process cwd / PLY_CWD). Always non-interactive (`init --yes`).
refreshEditorKitNoReplace an editor kit that is already there (Cursor rule, snippets, and the design skill in .cursor/skills and .agents/skills). Maps to `init --refresh-editor-kit`.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.4/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already flag destructiveHint=true and idempotentHint=false; the description adds real value by scoping the destruction to one flag (refreshEditorKit overwrites an existing editor kit) and asserting existing project files are preserved, plus the non-interactive guarantee. It stops short of describing failure behavior or what the call returns, so not a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The action and its file list are front-loaded, followed by the preservation rule, the single exception, and the routing to siblings. Dense but every clause carries a distinct constraint; nothing is redundant.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a zero-required-param, no-output-schema mutation tool, the description covers scope, preservation, the sole destructive path, and interactivity. The remaining gap is outcome reporting (what success looks like, behavior on partial failure), which matters for a non-idempotent writer.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameter descriptions already cover the cwd default and the `--refresh-editor-kit` mapping. The description reinforces refreshEditorKit's semantics ("the only replacement: it overwrites an editor kit that is already there") but adds little syntax or format detail beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and resource (create missing Ply setup files, via `ply-ui-cli init --yes`) and enumerates exactly which artifacts are produced (ply-ui.json, ply-ui.css, icon sprites, @source, design skill dirs). It also explicitly demarcates itself from siblings by naming add_components and update_components as later steps.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

States the precondition clearly ("only when those files are absent", "once ply-ui.json exists" for add_components), names the alternatives and the one exception path (refreshEditorKit is the only replacement), and closes with "Always non-interactive." An agent knows both when to call it and when to call something else.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.