Update roles

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

The annotations declare openWorldHint and idempotentHint, which cover side-effect potential and idempotency, but the description adds no additional behavioral context such as permissions required, what properties are editable, or consequences of updating roles. It largely restates the tool's name with no extra detail.

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 description is very short ('Edit user roles.'), which is not concise but under-specified. It offers minimal information beyond the title and fails to include essential usage or parameter details.

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?

Even though the tool is simple (1 param, no output schema), the description is insufficient to invoke it correctly. It does not explain the required structure of the roles array or how updates are applied. The combination of a generic schema and a terse description leaves the agent without adequate 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?

The input schema has a single 'roles' array parameter with no defined object structure (propertyNames and additionalProperties are generic). The description provides zero parameter information, leaving the agent without knowledge of what each role object should contain (e.g., ID, name, permissions). With 0% schema coverage, this is a critical gap.

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 states a clear action ('Edit') and a resource ('user roles'), but the phrase 'user roles' is ambiguous—it could mean editing role definitions or editing roles assigned to users. It distinguishes from siblings by operation (update vs create/delete), but the vagueness of the target resource reduces clarity.

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 use this tool versus kommo_roles_create/list/delete, nor any prerequisites or context. The description does not mention alternatives or exclusions.

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