Help Center: List all portals in an account

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

Annotations already declare readOnly, idempotent and non-destructive, so the safety profile is covered; the description adds value by naming the required auth mechanism (User API key in the api-access-token header) and noting text/digit encoding behavior. It does not, however, mention pagination or result limits, which is the main remaining gap for a list endpoint.

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?

Purpose is front-loaded, followed by endpoint and auth in a compact block. The trailing locale/digit sentence is generic boilerplate that adds length without much benefit for a read-only listing call.

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 single-parameter read tool with no output schema, the description covers what it does, the endpoint and auth. Nothing required to invoke it is missing, though a hint about what a portal record contains would round it out.

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 description coverage is 100%, so account_id is already documented as the numeric account ID. The locale note about Persian/Arabic-Indic digits could apply to the identifier's formatting, but it is generic rather than parameter-specific, so the baseline 3 holds.

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?

States a specific verb and resource ('List help center portals in the account'), with the endpoint path confirming the shape of the call. The verb clearly separates it from the sibling mutation tools gapify_add_portal and gapify_update_portal.

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?

Usage is implied by the list-verb and the account scoping, but there is no explicit guidance on when to reach for this versus other read tools or any prerequisites beyond the account_id. Adequate but nothing routing-oriented is stated.

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