Swagger: Delete Table Of Contents

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

Annotations indicate destructive (destructiveHint=true) and idempotent (idempotentHint=true). Description adds value by specifying 'soft-delete', implying reversibility, and 'supports recursive deletion', which goes beyond annotation hints. No contradiction with annotations.

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?

Description has 3 sentences plus a toolset header and parameter list. The 'Toolset: Table Of Contents' is redundant given the title. Parameter details duplicate schema. Could be trimmed without losing essential information.

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?

Output schema exists, so return value explanation is not required. However, description lacks context on preconditions (e.g., what if entry doesn't exist), side effects beyond soft-delete, or behavior when recursive flag is false. Acceptable but not fully complete.

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 has 100% description coverage. Description repeats parameter info (including format) but adds no new meaning beyond the schema. Baseline 3 is appropriate as schema already documents parameters adequately.

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?

Description clearly states 'Delete table of contents entry' with action verb and resource. It distinguishes from siblings like swagger_create_table_of_contents and swagger_list_table_of_contents. Mentions soft-delete and recursive deletion, adding specificity.

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 explicit guidance on when to use this tool versus alternatives. It implies use for deleting TOC entries but does not provide context like when to prefer over other deletion methods or prerequisites. The 'Toolset: Table Of Contents' line is a category label, not usage advice.

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