Api cwes retrieve

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

Annotations already cover the safety profile (readOnly, idempotent, non-destructive). The description adds genuinely useful behavior beyond them: related fields are masked for unauthorized users. However, it does not explain what 'unauthorized' means, what triggers masking, or whether the masked response is still usable.

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?

A single sentence with no waste, but it front-loads nothing useful — the resource identity and identifier semantics are omitted where they should lead.

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 single-object retrieval with an undocumented parameter and no output schema, the description leaves the agent guessing what entity is fetched and what identifier to supply. Only the masking behavior is communicated.

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?

The schema has one parameter with 0% description coverage, so the description must carry the burden. It never mentions the id parameter, its format, or what kind of identifier (CWE number vs. internal PK) is expected.

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?

Says only 'Return a single object', which restates the retrieve semantics without naming the resource (CWE). An agent cannot distinguish it from sibling cwes_object_retrieve or cwes_list based on the description text alone.

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?

No indication of when to use this versus cwes_list, cwes_object_retrieve, or cwes_autocomplete_retrieve. Usage is only inferable from the tool name and the required id parameter.

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