zia_get_vpn_credential

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

The annotations already indicate read-only behavior (readOnlyHint: true) and no side effects (openWorldHint: false). The description is consistent with these annotations and does not contradict them, so it provides adequate transparency without adding extra detail.

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 conveys the essential information without any unnecessary elaboration. It is well-structured and easy to parse.

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 get operation with a single ID parameter, the description is sufficiently complete. It does not detail the return value, but the absence of an output schema and the straightforward nature of the operation mean that no additional context is needed.

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 schema provides the parameter name 'credential_id' and type string. The description does not add further meaning about the parameter format, constraints, or source, but the parameter is self-explanatory. Baseline of 3 is appropriate due to high schema coverage.

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 action (Get), the resource (single ZIA VPN credential), and the method (by ID). This distinguishes it from potential list operations and unambiguously defines the tool's purpose.

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 does not explicitly mention when to use this tool over alternatives (e.g., a list tool). However, the 'by ID' phrasing implicitly suggests it is for retrieving a specific credential when its ID is known, but this is not made explicit.

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