PATCH Company Role

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

Adds 'only the supplied fields are changed' (partial update) and 'returns the modified object on success', which go beyond annotations. However, lacks details on permissions, rate limits, or other behaviors. Annotations already indicate not read-only and not destructive.

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?

Concise, with essential information like endpoint and partial update semantics. Could be slightly streamlined but is appropriately sized.

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?

Covers the key aspects: update operation, return value, required parameters, and endpoint. With no output schema, the description provides sufficient context for an agent to call the tool correctly.

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 description explicitly lists 'Required parameters: company_id, id' while the schema only marks company_id as required, adding clarity. The schema already has detailed descriptions for all parameters, so the description provides marginal additional value.

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?

Clearly states it updates an existing Company Settings (Company Role) via PATCH, with partial update semantics. Minor inconsistency between 'Role' and 'Settings' but purpose is discernible. Distinguishes from sibling create/delete/reorder tools implicitly.

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?

Only states 'Use this to update an existing Company Settings' without specifying when to use versus alternatives like create or delete. No exclusion criteria or context about when not to use.

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