Skip to main content
Glama

Write a version's notes

version_notes_update
DestructiveIdempotent

Replace a version's notes with Markdown (the whole text; null or empty clears them). For a NEW upload, pass notes with the upload call instead (upload_file_start, upload_file_complete, upload_video): the version then shows them from the start. Write notes on every revision you upload, so any agent can continue from the Flask link alone: what changed and why (which feedback it answers), how to continue (the tool and versions used, the commands to render), and which file holds the source (its file block goes first). Same Markdown as feedback: Flask links become references. Up to 20,000 characters of text. Needs full_access (edit access) to the asset: any version's notes, not only ones you uploaded. Returns the stored markdown and any warnings (references that were dropped).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
asset_idYesThe version (an upload's asset_id / version_id), or an asset id (its current version)
markdownYesThe notes, in Markdown; null clears them

Schema Changelog

Changes observed during successful MCP inspections.

No schema history has been recorded yet.

TDQS

A4.6/5.0
Behavior4/5

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

Goes well beyond the annotations (destructiveHint/idempotentHint) by disclosing replace-not-merge semantics, the 20,000 character cap, the full_access requirement, that access extends to any version and not just your own uploads, and the return payload (stored markdown plus warnings about dropped references). Missing only pagination-style operational edge cases, which are irrelevant here.

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 semantics before branching into the new-upload alternative and the guidance block. Dense and mostly earned, though the style guidance ('what changed and why ... how to continue') is advisory padding that a shorter pointer would have covered.

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

Completeness5/5

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

No output schema, yet the description still names the return value and its warning case. With permissions, character limits, the alternative upload flow, and access scope all covered, an agent has everything needed to call this correctly on the first try.

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: the 20,000-character limit on markdown is a constraint absent from the schema, null/empty both clear, and Flask links are converted to references. It also explains that asset_id may be a version id or an asset id (its current version).

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 (replace a version's notes) plus the exact replace semantics ('the whole text; null or empty clears them'). It is immediately distinguishable from version_notes_get (read) and from the upload_* siblings it explicitly routes away from.

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 when-not plus the alternative: 'For a NEW upload, pass notes with the upload call instead (upload_file_start, upload_file_complete, upload_video)'. It also states the standing condition for use ('Write notes on every revision you upload') and the access prerequisite.

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.