add_show_folder

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

No annotations are provided, so the description carries the full burden. It adds one important behavioral requirement (the folder must contain xlights_rgbeffects.xml), but does not describe side effects, permissions, or what happens on success/failure—critical for a mutation tool.

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

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

The description is front-loaded with purpose, then usage, then prerequisite, then parameter details. Every sentence earns its place; no waste or redundancy.

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

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

For a simple two-parameter tool with no output schema, the description covers purpose, usage, prerequisite, and parameter semantics. It could mention whether adding a folder switches to it or persists immediately, but the essentials are present.

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

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

Schema description coverage is 0%, but the description fully compensates by explaining both parameters: 'path: Full filesystem path to the xLights show folder' and 'name: Optional display name for the show (derived from folder name if omitted).' This gives clear meaning beyond the bare schema.

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

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

States a specific verb and resource: 'Add an xLights show folder by path.' Clear what the tool does, but it does not explicitly differentiate from sibling tools like switch_show or list_shows, so it falls short of a 5.

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

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

Provides clear when-to-use guidance: 'Use this to confirm a detected show folder or provide a custom path.' It also states a prerequisite (folder must contain xlights_rgbeffects.xml). However, no explicit alternatives or exclusions are mentioned, keeping it at a 4.

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