Skip to main content
Glama

Update a letter

update_letter

Change a letter. Only the fields you send change (lang, style… are kept). Links keep working. guests replaces the list but keeps each existing guest's id and link (matched by id, then by name); addGuests appends without touching anyone else.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYes
langNoLanguage guests read the letter in
sealNoWax seal mark: "" none, "_" plain, "icon:<id>", "ini:ABC", "duo:A|J"
styleNoLook of the letter and envelope (see catalog.styles)
blocksNoLetter blocks, top to bottom. Replaces all blocks. Use {name} in text to address each guest.
customNoOverrides on top of the style: accent/paper/ink/envelope colours, head/body fonts
guestsNoThe full guest list. Guests keep their id and link when matched by id or, failing that, by name.
presetNoStart from an occasion preset (pre-filled blocks). On update it only changes the occasion.
editKeyYes
envelopeNoEnvelope slot blocks, partial like letter blocks (see catalog.envelope for each slot's block type)
addGuestsNoGuests to append; existing guests and links are untouched.
sealShapeNo
nameFallbackNoWhat {name} reads as without a guest (default: "Dear Guest" in the letter language)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.8/5.0
Behavior4/5

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

With no annotations, the description must carry the behavioral burden, and it delivers the non-obvious traits: patch semantics (unsent fields are kept), link stability ('Links keep working'), and the critical replace-vs-append distinction between `guests` and `addGuests` with the id-then-name matching rule. It stops short of stating auth requirements (editKey) or failure/idempotency behavior, so it is strong but not complete.

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

Conciseness5/5

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

Four compact sentences, the core action front-loaded ('Change a letter'), then the highest-risk behaviors. Every sentence conveys a distinct, decision-relevant fact with no filler.

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?

For a 13-parameter nested tool with no output schema, the description covers the highest-confusion areas: partial-update behavior, link persistence, and guest replace-vs-append. The block/envelope/custom/font details are left to the rich schema, which is reasonable given 77% schema coverage, though a note on required `id`/`editKey` context would round it out.

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

Parameters3/5

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

Schema description coverage is 77%, so the schema largely documents parameters already, and the description's guest-matching and addGuests details closely echo the schema descriptions. It reinforces the patch semantics implied by the optional 'lang, style' fields but adds little syntax or constraint information beyond the schema, warranting the baseline 3.

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

Purpose4/5

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

'Change a letter' gives a clear verb+resource, and the following sentences clarify it is a partial (patch) update. It does not explicitly distinguish itself from siblings like create_letter or get_letter, but the update framing against the title makes the purpose unambiguous.

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

Usage Guidelines3/5

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

The description implies usage by explaining patch semantics ('Only the fields you send change'), which tells the agent this is an edit-an-existing-letter tool. However there is no explicit when-to-use or when-not-to-use guidance, nor any reference to create_letter/delete_letter as alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.