pbs_datastore_get

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

Describes operation as read-only and lists typical return fields (path, gc-schedule). With no annotations, the description appropriately updates the agent's expectations, though it could mention that no side effects occur.

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?

Two concise sentences; first establishes purpose, second provides guidance and prerequisite. No wasted words, front-loaded with key information.

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 tool with a full input schema and existing output schema, the description covers purpose, usage differentiation, and environmental requirements. No gaps remain for an agent to misuse 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 coverage is 100%, so the baseline is 3. The description adds minor context (prerequisite for target) but does not significantly enhance understanding beyond the schema's own descriptions.

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?

Clear verb ('Get'), resource ('full config of one PBS datastore'), and identification method ('by name'). Distinguishes from siblings like pbs_datastore_list and pbs_datastore_status by specifying scope and return content. Includes read-only hint.

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?

Explicitly states an alternative tool for runtime usage stats (pbs_datastore_status) and a prerequisite (PROXIMO_PBS_* config), giving the agent clear context for when to choose this tool.

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