Swagger: Create Table Of Contents

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

Annotations already declare readOnlyHint=false and destructiveHint=false, and the description's 'Create' is consistent. It adds concrete effects: title 'will be displayed in navigation,' slug 'must be unique within the section,' and type 'copy' duplicates an existing item, which goes beyond the structured 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?

The main purpose is front-loaded in the first sentence, which is good. However, the entire parameter list is repeated, duplicating the input schema and adding bulk without new information. It is structured but not as lean as it could be.

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 complex nested content object and existing output schema, the description supplies essential context: what a TOC item is, where it lives, what content types are allowed, and the roles of each parameter. It does not explain the 'copy' source mechanics or nested conditional rules, but the input schema covers those constraints.

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 100%, so the baseline is 3. The description's parameter list closely mirrors the schema descriptions—e.g., slug uniqueness and title length—without introducing new meaning beyond what the schema already provides.

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 opens with a specific verb-object pair: 'Create a new table of contents item in a portal product section,' which clearly distinguishes it from siblings like swagger_list_table_of_contents and swagger_delete_table_of_contents. It also names the supported content types (API references, HTML, Markdown), making the resource scope explicit.

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 phrase 'in a portal product section' and the Toolset label convey the intended context. Content-type support clarifies capability, though the description does not explicitly state when to prefer this over swagger_create_documentation_page or mention exclusions.

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