zia_get_vpn_credential

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

The 'read-only' annotation and parenthetical in the description confirm safety. The annotations already provide the readOnlyHint, so the description adds minimal additional behavioral context. It does not disclose any other behavioral traits such as rate limits or error handling.

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 a single concise sentence that accurately conveys the tool's purpose. No unnecessary words or repetitions.

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?

The description, combined with the input schema, annotations, and presence of an output schema, provides sufficient context for an AI agent to use the tool correctly. It could optionally mention the behavior when the ID is not found, but this is not critical.

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 the schema already documents both parameters thoroughly. The description adds no additional meaning or context beyond what is provided in the schema. Baseline score of 3 is appropriate.

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 retrieves a specific ZIA VPN credential by ID. It uses a specific verb 'Get' and resource 'VPN credential', distinguishing it from sibling tools like 'zia_list_vpn_credentials' which lists all credentials.

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?

While the description is straightforward, it lacks explicit guidance on when to use this tool versus alternatives. However, the purpose is clear, and the context of a specific ID retrieval is implied. No exclusions or prerequisites are mentioned, but for a simple get-by-ID tool, this is acceptable.

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