pbs_user_token_get

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

With no annotations provided, the description carries full burden. It clearly labels the operation as READ-ONLY, specifies what is and is not returned, and notes config requirements. It does not mention error cases or additional behavioral details, but for a simple metadata retrieval this is adequate.

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 two sentences, each providing essential information: first sentence states the operation and return fields; second gives prerequisite and config. No unnecessary words.

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?

Given the low complexity, full schema coverage, and presence of an output schema, the description covers all essential aspects: read-only nature, return fields, prerequisite, and config requirement. It is complete for an agent to correctly invoke this tool.

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 baseline is 3. The description adds value by listing the returned fields and emphasizing that the secret is not included, which helps understand parameter purpose. It also explains token_name as 'the part after '!' in the full tokenid', aligning with 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 clearly states it is a read-only operation to get one PBS API token's metadata, lists specific fields returned (comment, expiry, enabled flag, token-name, tokenid), and explicitly notes that the secret is NOT returned. It distinguishes from the sibling pbs_user_tokens_list which enumerates tokens.

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 advises using pbs_user_tokens_list first to enumerate tokens, provides a prerequisite step. It also mentions the config requirement (Needs PROXIMO_PBS_* config). However, it does not explicitly state when not to use this tool (e.g., if you need the secret) or other alternative tools.

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