Get a JobBOSS2 record

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

Annotations already convey readOnly and idempotent behavior. The description adds useful context beyond that: the required key names are resource-specific and must be looked up, which is a meaningful behavioral nuance for calling this tool correctly.

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 short sentences with no filler. The core action is front-loaded and the lookup hint earns its place as essential usage guidance.

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 readOnly and idempotent annotations, an output schema, and the resource enum in the input schema, the description covers the main ambiguity: mutable resource-specific key names. It could still mention the 'fields' parameter, but the overall tool behavior is adequately contextualized.

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 0%, so the description has the burden of explaining parameters. It partially compensates by explaining that 'keys' must contain the exact key names for the chosen resource. However, it does not explain the 'fields' parameter or clarify its role in selecting returned data.

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 says 'Get one JobBOSS2 record', which names a specific verb, resource, and singular scope. This clearly distinguishes it from jobboss2_list and jobboss2_get_report without needing to inspect the schema.

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?

It gives an explicit practical instruction: use jobboss2_describe_resource to find the exact key names required by the resource. The 'one record' phrasing implies when to choose this over list, though it does not explicitly state exclusions or name the alternatives.

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