discord_edit_role

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

The description adds critical behavioral context beyond annotations: 'Only provided fields change; passing permissions REPLACES the role's full permission set.' This is not indicated by annotations. It also clarifies permission requirements and role hierarchy constraints, which are essential for safe usage.

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 two sentences, front-loaded with the core function, followed by critical details. Every sentence earns its place with no redundancy or fluff.

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 covers the main purpose, behavioral nuances, and prerequisites. However, it does not mention the return value or error conditions (e.g., role not found), which would be helpful for a mutation tool with no output schema.

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 already has 100% parameter description coverage. The description summarizes the modifiable fields (name, color, etc.) but does not add new semantic details beyond what the schema provides. The baseline of 3 is appropriate.

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 explicitly states 'Update an existing role's name, color, permissions, hoist, or mentionable flag.' This clearly identifies the tool as an editing operation, distinguishing it from siblings like discord_create_role, discord_delete_role, and discord_set_role_permission.

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?

The description provides context for when to use the tool: 'Requires the Manage Roles permission, and the role must be below the bot's highest role.' It also warns about the replacement behavior of the permissions field. However, it does not explicitly mention when to use alternatives like discord_set_role_permission instead.

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