Swagger: List Portals

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the description's job is reduced. It adds the behavioral trait that only portals with designer role are returned, which is useful context beyond the annotations, but does not detail any other side effects or limitations.

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 extremely concise: two sentences that front-load the core purpose and a key constraint. Every word adds value with no fluff or redundancy.

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 zero parameters and annotations that confirm safety (read-only, idempotent, non-destructive), the description is sufficient. It states the purpose and a critical authorization constraint. While no output schema is present, for a list tool this is generally acceptable.

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?

There are zero parameters, and schema description coverage is 100%. The description mentions no parameters, so it does not add meaning beyond the schema. Baseline score of 3 applies as the schema already covers the parameter information.

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 uses the specific verb 'List' and resource 'portals', clearly stating it searches for available portals within Swagger. It distinguishes itself from sibling tools like swagger_get_portal (single portal) and swagger_create_portal (creation) by focusing on listing all accessible portals.

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 provides clear context by specifying the role requirement (designer role at product or organization level). It does not explicitly state when not to use it or mention alternatives, but the role constraint gives practical guidance for appropriate use.

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