pbs_remote_get

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

Declares READ-ONLY, notes return type (dict) and that password is not returned. With no annotations, these disclosures add value. Lacks mention of error conditions or rate limits, but adequate for a simple read tool.

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?

Three sentences, each with a distinct purpose: purpose/read-only, return info, sibling guidance and prerequisite. No fluff, front-loaded.

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?

Covers what, return shape, what it omits, related tools, and config requirement. Output schema exists, so return details are covered. Complete for a get operation.

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 coverage is 100% so baseline is 3. Description does not add new information about parameters beyond what is in 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?

Clearly states the action ('get') and resource ('config of one PBS remote sync-source by name'). Differentiates from siblings by explicitly mentioning pbs_remotes_list for listing all and pbs_remote_update for changing.

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?

Specifies when to use (get config of one remote by name) and provides alternative tools for listing and updating. Mentions prerequisite PROXIMO_PBS_* config, guiding proper usage.

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