rabbitmq_broker_get_shovel_info

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 indicates a read operation (get) but does not disclose safety profile (e.g., read-only), potential side effects, or authentication requirements. The description is not misleading but lacks explicit behavioral context.

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 of 18 words, front-loaded with the key action and target. It is concise with no redundant information, making it easy to parse.

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 simple tool with 2 parameters and no output schema, the description is mostly complete. It identifies what the tool returns (detailed information) and the parameters. It could hint at the fields returned (e.g., configuration, status), but the current wording is sufficient for a basic understanding.

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 the description must compensate. It explains both parameters: 'by name' (the 'name' parameter) and 'in a selected virtual host' (the 'vhost' parameter). This adds necessary meaning beyond the schema, though it does not mention the default value for vhost.

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 action ('Get'), the resource ('detailed information about specific shovel'), and the context ('by name that is in a selected virtual host'). This distinguishes it from sibling tools like rabbitmq_broker_list_shovels, which lists all shovels without details.

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 when to use: when you need detailed info for a known shovel by name. It contrasts with list_shovels (list all) and other get_* tools. However, it does not explicitly mention alternatives or when not to use, but the purpose is clear enough.

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