List trunk credentials

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

Annotations already mark the tool read-only and open-world, but the description adds meaningful behavioral context beyond them: passwords are never shown, stateless pagination requires passing page/per_page or limit/offset on every call, nothing is saved between calls, and password resets happen in the Vobiz console.

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 front-loaded with the core purpose and then adds usage, pagination, privacy and management details in compact sentences. Every sentence serves a purpose and there is no redundant or filler text.

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 read-only list tool with no output schema and two optional parameters, the description covers what is returned, how to use the credential id, how pagination works, and what is intentionally hidden. It gives the agent enough to call and interpret the tool correctly.

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?

With only 50% schema description coverage, the description meaningfully compensates by explaining stateless pagination, requiring pagination parameters on every call, and mentioning the page/per_page alternative alongside limit/offset. It does not define offset semantics in detail, but it adds substantial usage meaning 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 gives a specific verb and resource: list SIP digest credentials for this account, along with the returned fields username, realm and enabled state. It clearly distinguishes this tool from list_sip_trunks and create/update/delete_trunk_credential by focusing on the credential records 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?

The description gives clear context by explaining that the credential id is used as credential_uuid on a trunk, and it covers pagination behavior. It does not explicitly state when-not to use the tool or name alternative sibling tools, so it falls short of full when/when-not guidance.

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