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

Goes beyond the readOnlyHint annotation by disclosing that payroll/private fields are omitted and that the underlying API is v3preview1, which hints at preview-level stability. The required permission scope is also stated. It stops short of describing the returned shape, but the omissions notice is genuinely valuable for a 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?

Four tight clauses, each carrying distinct information: capability, key format, permission requirement, field omissions, and API version. Nothing is padded and the core purpose leads.

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 one-parameter read tool with annotations covering the safety profile and no output schema, the description supplies the important surrounding context (auth scope, field redaction, API version). A brief indication of what the agreement metadata contains would close the remaining gap.

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% and the pattern already constrains the id to digits or the xrefId: prefix form. The description's "internal numeric ID or documented external reference" restates rather than extends that, offering no format or example detail beyond 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?

States a specific verb and resource ("Read operational agreement metadata") and the lookup key (internal numeric ID or external reference). It clearly implies singular retrieval, which distinguishes it from quinyx_list_agreements, though the sibling is never named explicitly.

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 required scope hr:agreements:read gives a usable precondition, and "by internal numeric ID" implies direct lookup. However, there is no explicit guidance on when to use this versus quinyx_list_agreements for discovery or search, leaving the choice to inference.

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