pbs_remote_get

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

No annotations are provided, so the description carries the full burden. It discloses the read-only nature, password exclusion, and config requirement. However, it does not mention error behavior or other traits like idempotency.

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 with no extraneous words. It front-loads the purpose and immediately adds important constraints, making it very concise.

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 presence of an output schema, the description need not detail return values. It covers the core purpose, read nature, config requirement, and password exclusion. It is mostly complete but could briefly mention that the tool returns the config object.

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 50%. The description adds context by indicating 'by name' for the required parameter, but does not elaborate on parameter formats or constraints beyond what the schema already provides for 'proximo_target'.

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 explicitly states 'Get the config of one PBS remote sync-source by name (read)', which clearly identifies the verb, resource, and scope. It distinguishes from siblings like pbs_remote_create, pbs_remote_delete, etc., by specifying it's a read operation.

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 provides clear context: it's a read operation, no password returned, and requires PROXIMO_PBS_* config. However, it does not explicitly state when to use this tool vs alternatives (e.g., pbs_remotes_list for listing all).

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