Skip to main content
Glama

Update artifact

update_artifact
Destructive

Replace parts of an existing artifact with content you wrote, keeping its folder ID, link and sharing. If the artifact is shared by link, the change is visible to anyone with that link, including people outside the workspace; get_file_sharing shows who can open it. Only what is sent changes: each listed file is written (null deletes it), each edit replaces one exact match of its find text in an existing text file, description replaces the card text, and title renames it; every other file is kept. Prefer edits for small changes to a large file. Read the current files with list_files and read_file first. Call show_artifact afterwards so the user sees the change. Requires write permission; deleting a file also needs delete permission, which API keys don't have. Checks run before anything is written; if storage fails partway, files already saved stay, so re-read before retrying, and re-sending the same files is safe. To have Replo's agent revise it from a request in words, use generate_artifact with fileId.

Input Schema

NameRequiredDescriptionDefault
editsNoTargeted replacements in existing text files, applied in order, so a small change doesn't resend the whole file. If any edit fails to match exactly once, nothing is saved. A path can't appear in both files and edits.
filesNoFiles to write, keyed by relative path; null deletes that file. Files not listed are kept. index.html is the page. Link sibling files with relative URLs; scripts may load only from the artifact, cdnjs, jsDelivr /npm/, unpkg, the Tailwind CDN and the jQuery CDN, and other outbound requests are blocked. Each *.insights.json file is an Insights report document (version "2.0", the shape get_insights_report returns) whose saved queries run live for each viewer; embed one with <replo-report src="./sales.insights.json"></replo-report>. report.insights.json is the artifact's main report, the one the Insights report tools read, and without index.html Replo renders the page around it.
titleNoRenames the artifact.
fileIdYesThe .artifact folder ID, including for Insights artifacts; never an embedded report file ID.
projectIdYes
descriptionNoThe one-line summary shown on the artifact's card.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.8/5.0
Behavior5/5

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

It goes well beyond the annotations by disclosing consequences the hints cannot express: shared-by-link changes are visible outside the workspace, deletion requires a permission API keys lack, validation happens before any write, and a mid-flight storage failure leaves earlier files saved. The retry note ('re-sending the same files is safe') is correctly scoped to whole-file resends rather than to edits, so it does not conflict with idempotentHint=false.

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?

It is long, but front-loaded with purpose and then ordered by concern: sharing visibility, mutation semantics, workflow, permissions, failure behavior, alternative tool. A few clauses (CDN/request policy, insights report embedding) read as schema-adjacent detail, but nothing is redundant filler.

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?

For a six-parameter, nested-object mutation tool with no output schema, it covers everything an agent needs: permissions, atomicity and partial-failure recovery, cross-tool sequencing, and the difference between edits and full file rewrites. There is no material question left open before calling it.

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 83% schema coverage the schema already carries most parameter meaning, but the description still adds semantic rules: null deletes a file, unlisted files are kept, edits must match exactly once and are applied in order, description targets the card text, and title renames. It also explains the insights.json and index.html file conventions, which no property description fully spells out.

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?

The opening sentence gives a specific verb and resource plus the key invariant: partial replacement that preserves folder ID, link and sharing. That immediately separates it from create_artifact, update_file and generate_artifact without needing schema inspection.

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?

It prescribes the surrounding workflow explicitly (read with list_files and read_file first, call show_artifact afterwards), states a preference rule (use edits for small changes to large files), and names a substitute with its trigger (generate_artifact with fileId for natural-language revisions). This is when/when-not guidance at the level an agent can act on.

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