Swagger: Publish Portal Product

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

Adds value beyond annotations by explaining return structure (publication status, URLs, warning) and clarifying that a warning does not indicate publish failure. Annotations already indicate destructive and idempotent, but description enhances transparency.

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?

Well-structured with clear sections (purpose, toolset, parameters). Brief yet comprehensive, no unnecessary words. Front-loaded with the core action.

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 output schema exists (context indicates yes), the description covers purpose, mode, parameters, and return details fully. Enables correct agent decision-making without additional context.

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 baseline 3. Description adds semantics like how tableOfContentsId resolves the URL path and that preview defaults to false, providing context beyond the schema.

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 tool publishes a product's content to make it live or as a preview. It specifies the verb 'publish' and resource 'product content', distinguishing it from sibling tools like create, update, or delete portal products.

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?

Provides clear guidance on using preview mode to test before going live. Implies publishing follows creation/updating. Lacks explicit alternatives or when not to use, but the context of sibling tools (create/update/delete) makes usage clear.

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