Swagger: Delete Table Of Contents

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

Annotations already declare destructiveHint=true and idempotentHint=true, and the description adds meaningful behavioral context by stating this is a soft-delete and supports recursive deletion of nested items. It does not contradict annotations, and the added soft-delete detail is valuable beyond the structured fields.

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 concise, front-loaded with the core action, and includes useful details like soft-delete and recursion. The parameter list duplicates schema content but is brief and aids quick scanning, so it is not wasteful.

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?

With an output schema present and full parameter coverage, the description covers the essential behavior: soft-delete, recursive support, and identifier format. It lacks deeper caveats like recoverability or permission requirements, but for a two-parameter tool this is reasonably 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 description coverage is 100%, so the schema fully documents both parameters. The description repeats the parameter meanings without adding extra nuance, which meets the baseline but does not elevate beyond it.

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 opens with the direct verb 'Delete' and the precise resource 'table of contents entry', then clarifies the soft-delete nature. This is specific enough to distinguish from sibling tools like swagger_list_table_of_contents and swagger_create_table_of_contents.

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 clearly implies this tool is for deleting TOC entries and mentions recursive deletion as an option, but it does not state when to choose this over alternatives or provide exclusions. The soft-delete and recursive behavior give context, but no explicit when/when-not guidance is present.

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