get_record

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

No annotations are provided, so the description carries full burden. It discloses that sensitive fields are redacted unless enabled, which is a behavioral trait. However, it does not mention other aspects like permissions, rate limits, or side effects.

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 concise, with two short paragraphs. The first sentence clearly states the purpose, and the second adds context for the key parameter. It is front-loaded but could benefit from more structure.

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 4 parameters and an existing output schema, the description covers the key, expand, and redaction behavior. However, it omits explanations for the 'fields' and 'resource' parameters, leaving gaps. The redaction note adds useful context.

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%, requiring the description to compensate. Only the 'key' parameter is explained with an example. The 'expand' parameter is vaguely mentioned ('optionally expanding child collections'), and 'fields' and 'resource' are not explained at all.

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 'Fetch a single record by its key, optionally expanding child collections.' It provides a specific verb and resource, and includes an example for the key parameter (e.g., PersonId for workers), distinguishing it from siblings like list_resources.

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 implies usage for fetching a single record but does not explicitly state when to use this tool versus alternatives like query_resource or list_resources. No guidance on prerequisites or exclusion conditions is provided.

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