Update an existing SmartSuite record by specifying only the fields to change. Requires readwrite or admin mode.
Update an existing record. Requires readwrite or admin mode. Only supply fields you want to change.
| Name | Required | Description | Default |
|---|---|---|---|
| fields | Yes | Fields to update, keyed by slug | |
| recordId | Yes | The record ID to update | |
| applicationId | Yes | The application ID |
Changes observed during successful MCP inspections.
v0.9.8Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Behavior is consistent with annotations (readOnlyHint=false indicates mutation). The description adds context about required access mode and partial update behavior, which annotations do not cover. No contradiction.
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, front-loaded with core purpose, no unnecessary words. Every sentence provides value.
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?
For an update tool with no output schema, the description covers mode requirement and partial update best practice. It does not specify return value, but this is not critical given lack of output schema. Adequate for the complexity.
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% with descriptions for all three parameters. The description does not add new parameter information beyond what the schema already provides, so baseline 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 'Update an existing record,' which is a specific verb+resource combination. This distinguishes it from sibling tools like create_record, list_records, and delete_records.
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 provides explicit usage context: 'Requires readwrite or admin mode' and advises 'Only supply fields you want to change,' which implies partial updates. However, it does not explicitly mention when not to use or alternatives.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.