aap_get_credential

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

Beyond the readOnlyHint annotation, the description discloses that secrets are masked by AAP and appear as '$encrypted$', and that the return is a JSON string. This provides meaningful behavioral context without contradicting annotations.

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 compact, with a clear intro and structured Args/Returns sections. Every sentence contributes to understanding the tool's behavior without unnecessary verbosity.

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 single-parameter read operation, the description adequately covers the return format and secret-masking behavior. It doesn't discuss error cases or ID validation, but given the simplicity and read-only nature, this is a minor gap.

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 merely restates the parameter name and type from the schema ('credential_id (int): Credential ID'), adding no new semantic meaning. With schema description coverage at 0%, it fails to compensate by explaining the parameter's role or constraints 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 uses a specific verb ('Get') and resource ('credential details') with an added detail about secret masking, clearly distinguishing it from sibling list/delete/update tools. It unambiguously states the operation's scope (fetching a single credential).

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 implies usage for fetching individual credential details but provides no explicit guidance on when to use it compared to alternatives like aap_list_credentials. No exclusions or when-not-to-use scenarios are mentioned.

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