delete_grist_records

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

No annotations provided, so description fully shoulders the burden. It states it deletes records (destructive) and returns a status/confirmation. Could mention irreversibility or authorization, but the deletion behavior is fairly transparent.

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?

Well-structured with sections: main description, prerequisites, workflow, args, returns. Front-loaded with purpose. Concise without superfluous text.

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 simplicity (3 params, no nested objects, output schema present), the description fully covers prerequisites and workflow, enabling correct tool invocation.

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 has 0% coverage, so description must compensate. It lists each arg with a brief explanation: doc_id as document ID, table_id as table ID, record_ids as list of IDs to delete. This adds meaning beyond the bare schema types.

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 it deletes records from a Grist table, using a specific verb and resource. It is distinct from sibling tools like add_grist_records, update_grist_records, etc.

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?

Explicitly provides prerequisites (list_records to obtain IDs) and a typical workflow (list then delete). This gives clear guidance on when to use this tool and its dependency.

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