Swagger: Create or Update API

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

Description states the tool creates or updates (mutational behavior), but annotations declare readOnlyHint=true, which contradicts. This is a serious inconsistency. The description also lacks disclosure of auth requirements or side effects beyond what annotations provide. Score 1 due to annotation contradiction.

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 is well-structured with toolset and parameter sections. However, there is slight redundancy (fixed values mentioned twice). It is not overly verbose, earning a 4.

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 no output schema, description does explain response codes and 'operation' field, which is good. However, the annotation contradiction leaves the agent uncertain about true behavioral safety. The tool is a mutation, but readOnlyHint=true misleads. This incompleteness reduces score.

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% (baseline 3). Description adds value by explaining auto-detection of format, fixed values like version 1.0.0, private visibility, and automock disabled. This enriches understanding beyond the schema descriptions.

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 the tool creates or updates an API in SwaggerHub Registry, with specific verb+resource. It mentions auto-detection of spec type. However, it does not explicitly differentiate from the sibling 'swagger_create_api_from_prompt', though the 'from definition' angle provides indirect distinction.

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?

Description implies usage context (creating/updating APIs from definition content) but provides no explicit guidance on when not to use this tool or alternatives like 'swagger_create_api_from_prompt'. No exclusion criteria are given.

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