Update Records

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

No annotations are provided, so the description carries full burden. It discloses that certain fields cannot be updated, which is helpful. However, it does not mention authentication, rate limits, or partial update behavior. The revision field for optimistic locking is in the schema but not highlighted in the description.

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?

Two sentences: first clearly states purpose, second provides crucial guidance and limitations. No unnecessary words, information is front-loaded and 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?

Given the tool's simplicity (2 params, output schema present), the description covers the core usage and important constraints. The schema handles parameter details thoroughly. Could mention that updates are atomic per record, but not essential.

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 baseline is 3. The description adds value by recommending using kintone-get-form-fields to discover field codes and formats, which is crucial for constructing the 'records' parameter. It also lists non-updatable fields, aiding parameter construction.

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 'Update multiple records in a kintone app' with a specific verb and resource. It distinguishes from sibling tools like kintone-add-records and kintone-delete-records by focusing on update.

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?

It instructs to use kintone-get-form-fields first, providing a prerequisite. It also lists field types that cannot be updated (LOOKUP copies, STATUS, etc.), guiding when not to use this tool. However, it does not explicitly suggest alternative tools for those cases, like kintone-update-statuses for status updates.

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