Update A WBS Code

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

Annotations already indicate readOnlyHint=false and destructiveHint=false. Description adds that only supplied fields are changed and returns modified object. No contradiction, but does not disclose additional traits like side effects or authorization needs beyond 'Procore API' reference.

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 and well-structured. Front-loaded with the action and resource. Includes relevant API details. No unnecessary sentences.

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?

Completeness is good given the tool's simplicity. No output schema, but description mentions returns modified object. Covers what is updated, how (partial), and outcome. Could mention error handling but not critical.

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 coverage is 100%, so parameters are fully described. Description mentions 'new custom description or status', which matches two parameters, but adds no extra meaning beyond the schema.

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 a WBS Code with new description or status. It specifies the resource (Work Breakdown Structure records) and action (update). However, it does not explicitly distinguish from sibling tools like bulk_update_wbs_codes or create_a_wbs_code.

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?

Provides basic usage guidance: 'Use this to update an existing Work Breakdown Structure records' and notes required parameters. Does not mention when to avoid using it or alternatives such as bulk operations.

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