Skip to main content
Glama
ply-ui-ng

Ply UI

Official

Diff installed Ply components

diff_components
Read-onlyIdempotent

Compare tracked Ply component files against the registry and return drifted paths and statuses without writing changes.

Instructions

Compare each tracked Ply component file with the registry and return drifted paths and statuses. Writes nothing. update_components applies those upstream changes. doctor checks project setup, not file contents.

Input Schema

NameRequiredDescriptionDefault
cwdNoProject root containing ply-ui.json (defaults to MCP process cwd / PLY_CWD)
namesNoTracked component names to diff. Omit or pass [] to check every component in ply-ui-lock.json.

Output Schema

NameRequiredDescriptionDefault
okYes
filesYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.1.1
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": {},
      +  "properties": {
      +    "files": {
      +      "items": {
      +        "additionalProperties": {},
      +        "properties": {
      +          "component": {
      +            "type": "string"
      +          },
      +          "path": {
      +            "type": "string"
      +          },
      +          "status": {
      +            "enum": [
      +              "upstream-changed",
      +              "locally-modified",
      +              "conflict",
      +              "new-upstream",
      +              "removed-upstream",
      +              "missing-locally"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "component",
      +          "path",
      +          "status"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    },
      +    "ok": {
      +      "type": "boolean"
      +    }
      +  },
      +  "required": [
      +    "ok",
      +    "files"
      +  ],
      +  "type": "object"
      +}
  2. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint and idempotentHint, so the safety profile is covered; the description reinforces it with 'Writes nothing' and clarifies the handoff boundary to update_components. It adds little about result shape beyond naming drifted paths and statuses, which is partly carried by the output schema, so it stops short of 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?

Three short sentences: what it does, its side-effect-free nature, and how it differs from two siblings. Front-loaded and waste-free.

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

Completeness5/5

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

With full schema coverage, an output schema, and annotations covering safety, the description supplies exactly the missing pieces — the read-only guarantee and sibling routing. An agent has everything needed to call it correctly.

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 description coverage is 100%, so cwd and names are already fully documented, including the omit-or-empty behavior. The description adds no parameter-level detail, which is the correct baseline when the schema does the work.

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?

States a specific verb and object — comparing tracked Ply component files against the registry — plus the result shape (drifted paths and statuses). It explicitly distinguishes itself from update_components and doctor, so an agent can pick it without inspecting schemas.

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?

Gives the positive case (diff tracked files against the registry) and two explicit alternatives with the condition that selects them: update_components for applying changes, doctor for project setup rather than file contents. Nothing is left to inference.

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