code_workspace_update_collaborator

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

With no annotations, the description must fully disclose behavioral traits. It only states the action without detailing side effects, permission requirements, idempotency, or behavior for invalid roles. The mutation nature is implied but not elaborated.

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 a single sentence that efficiently conveys the core action. It is front-loaded and free of unnecessary words, though it sacrifices completeness for brevity.

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 the tool has three required parameters, no parameter descriptions, and no behavioral annotations, the description is insufficiently informative. An output schema exists but the description does not leverage or reference it. The agent lacks key details to use the tool effectively.

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 0% and the tool description adds no information about the three parameters. For example, the 'role' parameter lacks valid values or format. The agent gets no guidance on parameter semantics beyond their 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 'Change a collaborator's role.' uses a specific verb ('change') and clearly identifies the resource (collaborator's role). It distinguishes from sibling tools like 'code_workspace_add_collaborator' and 'code_workspace_remove_collaborator' by focusing on role modification.

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 alternatives (add/remove collaborator). There is no mention of prerequisites, context, or situations that warrant a role change versus other operations.

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