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

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_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/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

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. Changed1 schema field changed
    • changedInput schema / properties / artifact_id / description
      Previous value: -"The Artifact id (art_…)."New value: +"The Artifact id (art_…): the last part of its link, as in bisque.cloud/documents/art_…, /pages/art_… or /artifacts/art_…."
  2. 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"
      +  ]
      +}
  3. 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"
      +}
  4. Added

TDQS

A4.3/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing that content replaces the entire document rather than a diff, that earlier Versions persist in history, that the call blocks until the new Version is live, and that capabilities/state rules are inherited from the base Version unless overridden. These are exactly the mutation-side effects (what is destroyed, what is preserved, timing) that readOnlyHint=false and destructiveHint=false cannot convey.

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?

Five short sentences, front-loaded with the ownership constraint and the content-vs-metadata split, then the inheritance caveat. No filler and nothing repeated from the schema verbatim.

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?

With an output schema present the return values need no explanation, and the description covers the mutation semantics, blocking behavior, and inheritance defaults. It stops short of failure modes — permission denial, missing artifact, or what happens on concurrent content updates.

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 already 88%, so the baseline is 3, but the description adds real meaning: content is the whole document of the same type, and capabilities/state default to inheriting the base Version's rules when omitted. That defaulting behavior is not stated in the schema and is the most likely source of a wrong call.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb+resource ('Change an Artifact') and immediately bounds scope with the ownership/editing precondition. It also clarifies that the tool serves both metadata edits and whole-document republication, which is what separates it from create_artifact and delete_artifact, though no sibling is named explicitly.

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?

'Change an Artifact you own or edit' establishes a clear precondition and 'Any combination in one call' explains that updates should be batched rather than split. It gives no explicit exclusions or pointers to alternatives like delete_artifact or create_artifact for the cases where this tool is the wrong choice.

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