Skip to main content
Glama

Suggest changes to some writing

suggest_edits

Propose judgment-call edits to a person's writing so they can accept or decline each change, keeping their voice instead of editing it directly.

Instructions

Suggest changes to a person's writing instead of making them; they accept or decline each on its page. Judge each case: a plain command (fix the spelling) you just do with update_record; suggest when the changes are judgement calls on their words. Do only the help asked for, keep their voice, small changes, at most 15. Feedback on structure is said in words, not suggested. Copy each passage exactly from get_record, long enough to occur once.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe record's id.
typeYesThe record's content type, such as note.
editsYes
fieldNoThe field; its main text when left out.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only supply the safety profile (not read-only, not destructive, not idempotent); the description supplies the behavior that actually matters — edits are proposed and gated on human accept/decline on the record's page, so nothing is applied on this call. It also discloses the cap of 15 edits and the dependency on a prior get_record read ('Copy each passage exactly from get_record, long enough to occur once'), which is a real prerequisite an agent must satisfy. No contradiction with the annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loaded with the core behavior and kept to four dense sentences with no filler; the routing rule, constraints, and prerequisite all appear. Phrasing is telegraphic in places ('Feedback on structure is said in words, not suggested'), which costs a little clarity but not much space.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

There is no output schema, but the description explains the return mechanism — each suggestion surfaces on the page for accept/decline — so an agent understands what happens after the call. Combined with the prerequisite read and the 15-edit cap, the definition is complete enough to invoke correctly; only failure behavior when a passage does not match is left unstated.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

With 75% schema coverage the baseline is 3, but the description adds meaning the schema lacks: passages must be copied verbatim from get_record and be long enough to be unique, and the structure kind is constrained by the rule that structural feedback is given in prose rather than as a suggestion. It does not explain the meaning of the 'meaning' boolean or the field default beyond what the schema already says.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb+resource with its defining constraint: it proposes edits to writing rather than applying them, and the person accepts or declines each. It explicitly distinguishes itself from the sibling update_record, which handles plain commands, so an agent can route correctly without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives an explicit decision rule ('a plain command (fix the spelling) you just do with update_record; suggest when the changes are judgement calls on their words') naming both the alternative and the selecting condition. It adds exclusions and scope limits ('Do only the help asked for, keep their voice, small changes, at most 15') and rules out one category entirely ('Feedback on structure is said in words, not suggested').

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