Api risk matrices partial update

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

Annotations already declare readOnlyHint=false, destructiveHint=false, and idempotentHint=false. The description adds no behavioral context beyond generic boilerplate and does not explain partial-update semantics, payload handling, or what happens to unspecified fields.

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 it is not bloated. However, the brevity reflects under-specification rather than a front-loaded, information-rich statement.

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 partial-update mutation with two parameters, no output schema, and zero schema description coverage, the description is completely inadequate. It omits the partial-update contract, body expectations, and any permission or error 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%, and the description never mentions the required id or the optional body payload. Both parameters are left entirely undocumented in the description, forcing the agent to infer their meaning from the raw 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?

The description only says the endpoint allows risk matrices to be 'viewed or edited,' which is generic viewset boilerplate. It does not specify that this tool performs a partial update (PATCH) or distinguish it from sibling retrieve, list, and update endpoints.

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 guidance is provided on when to choose this partial update over the sibling retrieve, list, update, or create_draft tools. Saying the endpoint allows risk matrices to be 'viewed' is misleading for a mutation tool and could cause an agent to select it for a read operation.

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