Update Vendor Project Roles

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

Annotations (readOnlyHint=false, etc.) indicate mutation. The description adds key behavior: 'Will remove any vendors associated with the role if they are not included in the vendor_ids parameter' – a critical detail about replacement semantics. Also notes 'returns the modified object on success'. No contradictions.

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 contains four sentences, each contributing unique information: purpose, behavior, update semantics, required params, and endpoint. Slightly verbose but still clear and well-structured.

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?

Given no output schema, the description mentions the return value ('returns the modified object on success'). It covers purpose, required parameters, endpoint, and side effect. Missing details on errors or auth are acceptable for this simple update tool.

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?

All three parameters have schema descriptions (100% coverage). The description reiterates their names and adds endpoint info, but does not provide additional semantics beyond what the schema already offers. Baseline score applies.

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 the tool's purpose: 'Set which Vendors are associated with a specific Project Role.' It also specifies that vendors not included in vendor_ids will be removed, which distinguishes it from similar tools like 'update_user_project_roles'.

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 tells to use this for updating existing project records and lists required parameters, but does not explicitly contrast with alternatives like bulk updates or other role-related tools. Provides context but no exclusion criteria.

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