Skip to main content
Glama

write_app_artifact

Save an ARTIFACT into an app: the app's own output or saved state, owned by you. An artifact is what get_app_artifact reads back later | a Plotly chart specification, a saved report configuration, a board, a screener view, a table of World Bank or SEC figures the app computed. Give type (your own label, e.g. "chart", "report", "board"), a title, and spec and/or data as JSON. Pass artifact_id to patch one you already wrote instead of creating another. Use it right after create_app to seed the app with something real, or whenever a user asks you to save a view. You may write into any app you can open; someone else's private app answers "not found".

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoOptional inline data belonging to the artifact.
specNoThe saved view/configuration as JSON (e.g. a Plotly spec, a filter set).
typeNoYour own label for the kind of artifact, e.g. "chart", "report", "board". Required when creating.
titleNoHuman title shown in the app and in get_app_artifact.
app_idYesThe app the artifact belongs to.
visibilityNoWho may read the artifact. Default private.
artifact_idNoOmit to CREATE. Give an existing artifact id to PATCH that one.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only carry negative hints (readOnly=false, idempotent=false, destructive=false), so the description carries the behavioral burden. It discloses ownership ('owned by you'), access behavior ('someone else's private app answers not found'), persistence (read back later via get_app_artifact), and create-vs-patch semantics. This is exactly the kind of context beyond annotations that an agent needs.

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?

The description is dense and front-loaded with the core definition, then moves to parameters, usage, and permissions. Every sentence carries information, though the inline '|' separator and the list of examples make it slightly less polished than it could be.

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 7-parameter write tool with no output schema, the description explains the artifact concept, when to create vs patch, and permission behavior. It does not state the return value of the write call, and the 'required when creating' nuance for type is only in the schema, not the description, leaving a small gap.

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 the baseline is 3. The description adds meaningful parameter semantics: type is a free-form label with examples, spec and/or data may be supplied, and artifact_id toggles create vs patch. It does not add details for visibility or app_id, but the schema already documents those.

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 description opens with a specific verb and resource ('Save an ARTIFACT into an app') and then defines what counts as an artifact with concrete examples (Plotly spec, saved report, board, screener view). It also names the read-side counterpart get_app_artifact, so an agent can distinguish writing from reading without opening 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?

It gives explicit when-to-use context: 'Use it right after create_app to seed the app with something real, or whenever a user asks you to save a view.' It also distinguishes create vs patch via artifact_id. It does not enumerate exclusions against other write-like siblings such as create_chart_from_spec or write_rows, but the primary selection context is clear.

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