delete-topic-permission

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

The description repeats 'Delete' which is already implied by the annotation 'readOnlyHint: false'. It does not disclose any additional behavioral aspects (e.g., idempotency, error handling, side effects, or permission requirements). Annotations already convey the write nature, and the description adds minimal value.

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, straightforward sentence of 11 words with no redundant information. It is efficiently front-loaded.

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 schema (2 required string params, no output schema) and the presence of many sibling tools related to topic permissions, the description lacks essential context. It does not explain what topic permissions are, how deletion affects the system, or prerequisites. The agent may not understand the purpose or effect of this operation.

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 description coverage is 0%, so the description must compensate. It mentions 'for a user in a vhost', but does not explain what 'vhost' or 'user' refer to, or provide any formatting constraints beyond the schema. The description adds little semantic value to the bare 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 clearly states the action ('Delete'), the resource ('topic permissions'), and the scope ('for a user in a vhost'). It distinguishes this tool from siblings like 'delete-permission' or 'set-topic-permission'.

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 is provided on when to use this tool versus alternatives such as 'set-topic-permission' or 'delete-permission'. The agent receives no help in selecting this tool over similar sibling tools.

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