Skip to main content
Glama

Update an Artifact

update_artifact

Change an Artifact you own or edit. Pass content to publish a new Version of the page at the same URL (the whole document, not a diff; earlier Versions stay in the history). Pass title, description, icon, or icon_image to change those. Any combination in one call. With content the call waits for the new Version to be live before returning. The new Version keeps the base Version's capabilities and state rules unless you pass capabilities or state.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
iconNonull clears it.
stateNoWho may read and write which paths of the page's data, by the minimum role: viewer (can open), contributor (a data grant, separate from editing the page), owner. Absent means: everyone who can open reads, contributors and the owner write. Example poll: [{path:'votes',read:'viewer',write:'owner'},{path:'votes/{self}',write:'viewer'}].
titleNo
contentNoThe complete new document, same type as before.
icon_imageNoThe page's own icon: the favicon in the browser tab and the icon a phone puts on its Home Screen. A data URL: an SVG (data:image/svg+xml,<svg …>) or a base64 PNG, JPEG, WebP, or GIF, at most 512 KB, cropped to a square. An SVG must be self-contained (no links to other files, fonts, or stylesheets); draw shapes rather than text. Without one the page shows the Bisque icon. null goes back to the Bisque icon.
artifact_idYesThe Artifact id (art_…).
descriptionNonull clears it.
capabilitiesNoWhat the page may do at run time. state.read and state.write give it JSON documents at window.bisque.state (get, patch, list, subscribe); viewer.identity tells it who is viewing (window.bisque.viewer); events.emit lets it record typed Events. Omit for a page that only shows things.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe viewer page.
iconNo
typeYes
titleYes
group_idNo
created_atNo
updated_atNo
version_idNoThe Version this call authored.
artifact_idYes
descriptionNo
audience_modeYesWho can open it: owner, users, org, or public.
icon_image_urlNoThe page icon set with icon_image; null for the Bisque icon.
version_numberNo
discoverabilityYes
organization_idNo
latest_version_idNo
publication_errorNo
publication_statusNoready means the URL serves this content now. queued or processing means it is still being prepared; call get_artifact to check. failed carries publication_error.
viewer_version_modeNo
published_version_idYesThe Version viewers see; null until a publication is ready.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • addedInput schema / properties / icon_image
      Added value: +{
      +  "description": "The page's own icon: the favicon in the browser tab and the icon a phone puts on its Home Screen. A data URL: an SVG (data:image/svg+xml,<svg …>) or a base64 PNG, JPEG, WebP, or GIF, at most 512 KB, cropped to a square. An SVG must be self-contained (no links to other files, fonts, or stylesheets); draw shapes rather than text. Without one the page shows the Bisque icon. null goes back to the Bisque icon.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / icon_image_url
      Added value: +{
      +  "description": "The page icon set with icon_image; null for the Bisque icon.",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
  2. Changed2 schema fields changed
    • addedInput schema / properties / capabilities
      Added value: +{
      +  "description": "What the page may do at run time. state.read and state.write give it JSON documents at window.bisque.state (get, patch, list, subscribe); viewer.identity tells it who is viewing (window.bisque.viewer); events.emit lets it record typed Events. Omit for a page that only shows things.",
      +  "items": {
      +    "enum": [
      +      "state.read",
      +      "state.write",
      +      "events.emit",
      +      "viewer.identity"
      +    ],
      +    "type": "string"
      +  },
      +  "type": "array",
      +  "uniqueItems": true
      +}
    • addedInput schema / properties / state
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Who may read and write which paths of the page's data, by the minimum role: viewer (can open), contributor (a data grant, separate from editing the page), owner. Absent means: everyone who can open reads, contributors and the owner write. Example poll: [{path:'votes',read:'viewer',write:'owner'},{path:'votes/{self}',write:'viewer'}].",
      +  "properties": {
      +    "rules": {
      +      "items": {
      +        "additionalProperties": false,
      +        "properties": {
      +          "path": {
      +            "description": "A slash path the rule covers, and everything below it; '' is the root. A trailing {self} names each person's own document under the prefix.",
      +            "type": "string"
      +          },
      +          "read": {
      +            "enum": [
      +              "anyone",
      +              "viewer",
      +              "contributor",
      +              "owner"
      +            ],
      +            "type": "string"
      +          },
      +          "write": {
      +            "enum": [
      +              "viewer",
      +              "contributor",
      +              "owner"
      +            ],
      +            "type": "string"
      +          }
      +        },
      +        "required": [
      +          "path"
      +        ],
      +        "type": "object"
      +      },
      +      "type": "array"
      +    }
      +  },
      +  "type": "object"
      +}
  3. Added

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only state readOnlyHint=false and destructiveHint=false, so the description carries the burden of behavioral nuance. It explains the versioning behavior (whole document, not a diff; earlier Versions stay), the synchronous wait for new Version to be live, and the inheritance of capabilities and state unless overridden. These details go far beyond annotations and are crucial for safe invocation.

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?

The description is a compact three sentences with no filler. It front-loads the primary purpose, then delves into the versioning nuance and inheritance behavior. Every sentence conveys essential information, making it efficient and easy to parse for an agent.

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?

Given the tool's complexity (8 parameters, nested state rules, capabilities array) and the presence of an output schema, the description is sufficient. It covers the critical behavioral aspects (versioning, waiting, inheritance) that the schema does not express, while the schema handles detailed parameter constraints. No critical information is missing for an agent to call the tool correctly.

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 high at 88%, so the schema already documents each parameter. The description adds meaningful semantics beyond the schema: it clarifies that content is the entire new document (not a diff), that metadata fields are independent, and that capabilities/state are inherited unless explicitly passed. This enriches parameter understanding without redundancy.

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 clear verb and resource: 'Change an Artifact you own or edit.' It explicitly distinguishes the tool from creation by stating it publishes a new Version of the page at the same URL, and it clarifies the scope of changes (content vs. metadata). This unambiguous purpose prevents confusion with create_artifact or other siblings.

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?

The description implicitly gives usage context: it is for owned/editable artifacts, and it explains that content updates wait for the version to be live. It does not explicitly name alternatives or state when not to use it, but the clear scoping makes the appropriate use case evident. The addition of 'Any combination in one call' is practical guidance.

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