Api requirement assessments object retrieve

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

Annotations declare readOnlyHint=true, idempotentHint=true, destructiveHint=false, yet the description says the endpoint 'allows requirement assessments to be viewed or edited', implying a write capability this tool does not have. Beyond that it adds no behavior of its own (no auth needs, no scope/side effects), so it actively muddies rather than clarifies the annotation-declared safety profile.

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?

It is a single short sentence, so there is no bloat, but the only content beyond the name ('viewed or edited') is misleading noise rather than useful front-loaded 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?

No output schema exists, so the description should say what a retrieval returns (fields, relationships to compliance assessment/requirement node) and how failures (bad ID, permissions) behave; it provides none of this. For a lookup endpoint in a dense CRUD family the definition is too thin to call correctly.

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% for the single required 'id' parameter, so the description must carry the meaning; it says nothing about what the ID identifies or its format (string vs numeric ref). An agent can only guess that it is the requirement-assessment primary key.

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 restates the tool name ('requirement assessments ... viewed') rather than distinguishing it from the many sibling endpoints (requirement_assessments_list, _retrieve, _result_retrieve, _extended_result_retrieve, _object_retrieve). It never explains what a 'requirement assessment' object is or why 'object_retrieve' differs from plain 'retrieve', so an agent cannot confidently pick it over its near-duplicates.

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?

There is no statement of when to call this versus the ~15 sibling requirement_assessments endpoints, no mention that it fetches a single record by ID, and no prerequisites. The only usage-ish signal ('viewed or edited') is unhelpful and points the wrong way for a retrieve-only tool.

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