set-topic-permission

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

While the description implies mutation (set), it does not disclose whether permissions are replaced or merged, or whether existing permissions are affected. Annotations indicate readOnlyHint=false and openWorldHint=true, but the description adds no behavioral detail beyond the verb.

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, which is too brief to be effective. It omits essential information that could be included without significant length increase.

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?

The tool has 5 required parameters with no descriptions, no output schema, and a generic description. The agent cannot determine valid inputs for 'write' and 'read', making the definition incomplete for correct invocation.

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?

With 0% schema description coverage, the description must explain parameters. It only names 'user' and 'vhost' via template but does not clarify 'write' and 'read' parameters (expected regex patterns). No value is added beyond parameter names.

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 states the verb 'set' and the resource 'topic permissions', and distinguishes it from sibling 'set-permission' by specifying 'topic'. However, it does not explain what topic permissions control (e.g., routing key patterns).

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 vs alternatives like 'set-permission' or 'delete-topic-permission'. No context on prerequisites or best practices.

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