describe_addon

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

The readOnlyHint annotation already establishes the safety profile. The description adds useful behavioral context beyond that: it says the result includes actions, settings, current values, allowed ranges, and per-item `lists` structure. It does not cover auth, errors, or rate limits, but it contributes meaningful detail beyond the annotation.

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 short and front-loaded, with the core purpose in the first sentence. The second paragraph adds relevant information about `lists`, though the sentence about setting values is slightly awkward for a read-only describe tool.

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?

There is no output schema and no schema description for the only parameter, so the description carries more burden. It explains the general return concepts and the `lists` structure, but it does not specify how to identify the addon or fully describe the response shape.

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?

There is one required parameter, `addon`, with 0% schema description coverage, so the description needs to compensate. It refers to 'one addon' but never explains the expected identifier format, accepted values, or how to obtain a valid addon name, leaving the parameter largely undocumented.

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?

The description uses a specific verb ('Show') and resource ('one addon's actions and settings'), and it states the scope includes current values and allowed ranges. It implies a single-addon lookup versus the sibling list_addons, but it does not explicitly name or differentiate against siblings.

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?

The description implies this is for inspecting an addon's settings and allowed values, and it explains how per-item settings appear under `lists`. However, it gives no explicit when-to-use guidance, no exclusions, and no comparison to list_addons or run_addon.

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