update_role

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

No annotations are provided, so the description carries the full burden. It mentions 'partial update,' which indicates that only provided fields are modified, but it does not disclose idempotency, required permissions, error behavior, or consequences of missing 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?

A single, efficient sentence that conveys the core purpose without extraneous words. Every part of the description is relevant.

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?

The description is too minimal for a mutation tool with 4 parameters, no output schema, and no annotations. It lacks details about required fields beyond id, the response format, and error conditions. Sibling tools with similar complexity likely have richer descriptions.

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 only 25% (only 'id' has a description). The description adds no additional meaning to the other parameters (name, isDefault, description). With low coverage, the description should compensate, but it only restates the schema's parameter names.

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 clearly states 'Update a Logto role by ID (partial update).' It identifies the verb (update), resource (role), and method (partial update via ID), distinguishing it from siblings like create_role, delete_role, and get_role.

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 on when to use this tool versus alternatives (e.g., create_role for new roles, or full update vs. partial). The description only implies the need for a role ID but does not specify prerequisites or exclusions.

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