list_portals

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

The description claims to list 'all' configurations, but the openWorldHint annotation indicates the tool may not return the complete set. This is a contradiction. Additionally, no details on pagination or default behavior beyond the schema are provided.

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?

Single, front-loaded sentence with no extraneous words. Efficient and to the point.

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?

For a simple list tool with optional params and an output-free schema, the description is minimally adequate. However, it omits mention of defaults or response format, which could be helpful given the lack of output schema.

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?

The description does not elaborate on the parameters (limit and query). Since schema coverage is 100%, the description adds no extra value; the agent must rely solely on 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 lists all Service Portal configurations. It uses specific verb and resource, and distinguishes from sibling tools like list_portal_pages or list_portal_themes by focusing on configurations themselves.

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?

No explicit guidance on when to use this tool versus alternatives such as get_portal or list_portal_pages. The description does not mention any prerequisites or exclusions.

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