Api users partial update

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

Annotations already declare readOnlyHint=false, idempotentHint=false, openWorldHint=true and destructiveHint=false, so the description has a lower burden, but it adds nothing: no mention of which user fields are mutable, whether changes are partial/merged, permission requirements, or side effects. "Viewed or edited" also blurs the read/write boundary that annotations set.

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 single sentence is short but is filler boilerplate rather than front-loaded signal. Brevity here comes from under-specification, not efficiency.

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?

With no output schema, 0% schema coverage, and only generic annotations, the description must carry the load — and it does not. An agent lacks the identity format, the mutation semantics of the body, and any notion of partial-vs-full update.

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% across 2 parameters: the required id and an opaque free-form body object are entirely undocumented. The description contributes nothing about how to identify the user or what the body should contain, leaving the agent with no semantic anchor 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 is Django REST boilerplate: "API endpoint that allows users to be viewed or edited" restates the resource name and adds only the generic verbs "viewed or edited." It never says this is a partial update (PATCH) of an existing user, so an agent cannot distinguish it from ciso_assistant_api_users_update, users_retrieve, or users_partial_update siblings.

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?

"Viewed or edited" hints at read/write but gives no when-to-use guidance, no distinction from the full-update or retrieve siblings, and no prerequisite or permission context. An agent must guess which of the many users_* tools to pick.

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