Skip to main content
Glama

Write release notes

write_release_notes
Destructive

Step 3. Saves the "What's new" notes on the update. English listing languages get the English. Notes you pass per language code are used as written. Other languages are translated from the English in the app's notes format and writing style unless translate is false; languages left untranslated get the English when submitted. Up to 1500 characters per language. For long notes, like a GitHub release or a whole changelog section, pass them as they are with summarize true: StoreFast rewrites them into a short Store version in the app's style (about 1150 characters, so translations fit) and returns the English it used. Calling it again replaces the notes. Then call submit_update.

Input Schema

NameRequiredDescriptionDefault
notesNoOptional notes for specific language codes from finish_upload, used as written.
englishYesThe English release notes, up to 1500 characters, or up to 20000 with summarize.
platformNoWith summarize, drop changes that only concern other platforms, like macOS.
releaseIdYesThe releaseId from start_update.
summarizeNoRewrite the English into a short Store version first, keeping only user-facing changes. Defaults to false.
translateNoTranslate into the other listing languages. Defaults to true.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and idempotentHint=false, and the description usefully explains the destructive mechanic ("Calling it again replaces the notes") plus translation defaults, the 1500-character limit, and that summarize returns the English it used. It does not mention auth requirements or failure modes, but the added behavioral context is substantial.

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-loads the core action and is dense with no filler, though several clauses are run together into long sentences (the notes/translation sentence in particular) which slightly hurts scannability. Size is justified by the number of behaviors being disclosed.

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 6-parameter tool with a nested object and no output schema, the description covers the overwrite semantics, translation behavior, character limits, and what summarize returns. It leaves permission requirements and error behavior unstated, but nothing critical to correct invocation is missing.

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?

Schema coverage is 100%, so baseline is 3, but the description adds real meaning beyond the schema: per-language notes are used as written, untranslated languages fall back to English on submit, and the 1500 vs 20000 character split maps to the summarize flag. This is more than restating field descriptions.

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 and resource ("Saves the 'What's new' notes on the update") and situates itself in a workflow ("Step 3"), which separates it from start_update and submit_update. An agent can tell what it writes and where without opening the schema.

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

Usage Guidelines4/5

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

Gives clear conditional guidance: use summarize true for long notes like a GitHub release or changelog section, use translate false to skip translation, and "Then call submit_update" establishes sequencing. It stops short of an explicit when-not-to-use or naming an alternative sibling, so it is strong context rather than full routing.

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.

Resources