get_middleware_info

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

No annotations are present, so description carries the burden. It mentions retrieving all information but does not specify read-only nature, required permissions, or potential cost. The description is somewhat vague about 'all information'.

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?

Single sentence that is concise and front-loaded, conveying the core purpose without excess.

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 tool with one param and no output schema, the description is adequate but vague. It hints at return content (configs, nodes) but doesn't guarantee coverage of all possible fields. Could be more specific.

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 coverage is 0%, so description must add meaning. It implies the parameter identifies the instance (middleware_instance_name), but does not clarify format or origin. Basic but functional.

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 clearly states the tool retrieves all information of a middleware instance, including configs and nodes. It distinguishes from siblings like get_middleware_status (status only) and list_middleware_instances (list of instances) by indicating full detail retrieval.

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?

No guidance on when to use this tool versus alternatives like list_middleware_instance_nodes or get_middleware_status. The sibling list is extensive but no exclusions or context are provided.

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