Skip to main content
Glama

Update an Artifact

update_artifact
Destructive

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, and, in a call without content, expires_in_days or expires_at (null keeps it) to set when an Artifact you own is deleted. 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.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "artifact_id": "<artifact_id>"
    },
    "name": "update_artifact"
  }
}

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.
expires_atNoThe same as expires_in_days, as an RFC 3339 moment. Pass one or the other. null cancels the expiry, so the Artifact is kept.
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.
expires_in_daysNoDelete the Artifact this many days from now, as delete_artifact would: it sits in the owner's Trash for 30 days, then its files go. Only when the user asks for it to go away (a scratch page, a one-week poll); leave it out and the Artifact is kept.

Output Schema

NameRequiredDescriptionDefault
urlYesThe viewer page.
iconNo
typeYes
titleYes
group_idNo
created_atNo
expires_atNoWhen it is deleted, as its owner asked; absent when it is kept.
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. Changed3 schema fields changed
    • addedInput schema / properties / expires_at
      Added value: +{
      +  "description": "The same as expires_in_days, as an RFC 3339 moment. Pass one or the other. null cancels the expiry, so the Artifact is kept.",
      +  "format": "date-time",
      +  "type": [
      +    "string",
      +    "null"
      +  ]
      +}
    • addedInput schema / properties / expires_in_days
      Added value: +{
      +  "description": "Delete the Artifact this many days from now, as delete_artifact would: it sits in the owner's Trash for 30 days, then its files go. Only when the user asks for it to go away (a scratch page, a one-week poll); leave it out and the Artifact is kept.",
      +  "maximum": 3650,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedOutput schema / properties / expires_at
      Added value: +{
      +  "description": "When it is deleted, as its owner asked; absent when it is kept.",
      +  "type": "string"
      +}
  2. 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_…."
  3. 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"
      +  ]
      +}
  4. 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"
      +}
  5. Added

TDQS

A4.4/5.0
Behavior4/5

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

Annotations declare destructiveHint=true and idempotentHint=false; the description adds behavior beyond that: content is a whole-document replacement, prior Versions remain in history, the call blocks until the new Version is live, and new Versions inherit the base Version's capabilities and state rules. It does not state permission failure modes or what happens to fields omitted in a metadata-only call.

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-loaded with the core action and a dense but purposeful enumeration; each sentence carries distinct information. The single long paragraph is slightly hard to scan and repeats some field detail already present in schema descriptions.

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 10-parameter mutation tool with an output schema and full annotations, the description covers versioning semantics, blocking behavior, conditional parameters, and inheritance rules — everything an agent needs to call it correctly without guessing.

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 90%, so the baseline is 3; the description raises it by explaining cross-parameter semantics the schema cannot express — mutual exclusion of expires_in_days/expires_at with content, open-ended combinations in a single call, and capability/state inheritance when omitted.

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?

Specific verb (change/update) plus resource (an Artifact), scoped by ownership/edit rights, and it immediately breaks down the distinct modes (content for a new Version, metadata fields, expiry). An agent can tell this apart from create_artifact, delete_artifact, or get_artifact without opening a 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?

Gives clear conditional guidance: pass content to publish, pass title/description/icon to change metadata, use expires_in_days or expires_at only in a call without content, and 'Any combination in one call'. It does not name sibling tools as alternatives for the delete/expire case or for read-only inspection.

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