ha_addon_info

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

The description indicates a read operation but provides no information about side effects, permissions, rate limits, or error behavior. With no annotations, the description carries the full burden but adds minimal context beyond the schema.

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 a single sentence that is front-loaded with the purpose. No extraneous words or repetition.

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?

Given the lack of output schema, the description does not specify what 'detailed information' includes (e.g., state, version, config). While adequate for a simple info retrieval, it could be more informative about the return format.

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?

The parameter 'slug' is fully described in schema with 100% coverage. The description adds useful context by noting that slugs come from ha_list_addons, helping the agent understand the parameter's source and dependency.

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 ('Get') and resource ('detailed information about a specific add-on'), clearly distinguishing it from siblings like ha_list_addons (which lists add-ons) and ha_addon_options (which likely returns configuration options). The parameter description further clarifies the slug source.

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 parameter description hints at a workflow ('Get slugs from ha_list_addons') but does not explicitly state when to use this tool versus alternatives such as ha_addon_options or ha_list_addons. No usage conditions or exclusions are provided.

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