Update An Equipment Model

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

Discloses partial update (only supplied fields changed), return of modified object on success, and endpoint. Annotations already indicate mutation (readOnlyHint false), and description adds useful context beyond them.

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?

Three concise sentences covering purpose, behavior, and required parameters. Minor repetition about 'Field Productivity records' but still efficient.

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 purpose, partial update behavior, return value, and API endpoint. No output schema, but description compensates by stating return of modified object. Adequate for agent use.

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 6 parameters have schema descriptions (100% coverage), so baseline is 3. Description only lists required parameters, adding no extra meaning beyond 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?

The description clearly states the tool updates a specified equipment model, explicitly mentions partial update behavior (only supplied fields changed), and provides the Procore API section and endpoint. It is distinct from sibling create and bulk update tools by singular reference.

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 when-to-use or when-not-to-use guidance relative to siblings like bulk_update or create. Lists required parameters but does not advise on selection context.

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