Skip to main content
Glama

Create an Artifact

create_artifact

Publish an HTML page or a Markdown document as a Bisque Artifact: a persistent, versioned page at a stable URL that people can open, comment on, and that you can update later with update_artifact. Pass the whole document as content. The call waits for the page to be ready and returns its URL. It is private to you unless you pass audience or share_with. A page that should remember what people do on it (a checklist, a poll, a sign-up sheet) declares capabilities ['state.read','state.write'] and, when some paths need different access, state.rules; it then reads and writes JSON documents through window.bisque.state. For a narrated presentation use create_presentation instead.

Input Schema

NameRequiredDescriptionDefault
iconNoAn emoji that stands for the page, e.g. ๐Ÿ“Š. The tab and Home Screen show icon_image, not this.
typeNoDefault html.
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'}].
titleYesA short name, the way a document or app is named.
listedNoShow it in listings (the company library, public discovery) rather than link-only. Default true for a company audience (audience org with organization_id), false otherwise.
contentYesThe full document. For html: a complete page in a sandboxed frame. Styles, scripts and images are inline, except libraries from cdnjs.cloudflare.com, cdn.jsdelivr.net/npm/, cdn.tailwindcss.com, code.jquery.com or unpkg.com and typefaces from Google Fonts; pin each library to an exact version in its URL (chart.js@4.4.1, never @latest), so the page renders the same for as long as it is published. Nothing else loads, and fetch reaches nowhere. For markdown: the Markdown source.
audienceNoWho can open the link. owner: only you. users: the people in share_with. public: anyone with the link.
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.
share_withNoPeople to grant access by email (or uid), with a role. [{ "email": "ana@acme.com", "role": "viewer" }]. viewer opens it; editor can also publish new content. Implies audience "users" when audience is omitted.
descriptionNoOne sentence saying what the page is; shown in listings.
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_idYesThe 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_statusYesready 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 / listed / description
      Previous value: -"Show it in listings (the org library, public discovery) rather than link-only. Default false."New value: +"Show it in listings (the company library, public discovery) rather than link-only. Default true for a company audience (audience org with organization_id), false otherwise."
  2. Changed1 schema field changed
    • changedInput schema / properties / content / description
      Previous value: -"The full document. For html: a complete page (styles and scripts inline; it runs in a sandboxed frame with no network). For markdown: the Markdown source."New value: +"The full document. For html: a complete page in a sandboxed frame. Styles, scripts and images are inline, except libraries from cdnjs.cloudflare.com, cdn.jsdelivr.net/npm/, cdn.tailwindcss.com, code.jquery.com or unpkg.com and typefaces from Google Fonts; pin each library to an exact version in its URL (chart.js@4.4.1, never @latest), so the page renders the same for as long as it is published. Nothing else loads, and fetch reaches nowhere. For markdown: the Markdown source."
  3. Changed3 schema fields changed
    • changedInput schema / properties / icon / description
      Previous value: -"An emoji for the tab and listing, e.g. ๐Ÿ“Š."New value: +"An emoji that stands for the page, e.g. ๐Ÿ“Š. The tab and Home Screen show icon_image, not this."
    • 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.",
      +  "type": "string"
      +}
    • 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.6/5.0
Behavior5/5

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

Beyond the annotations (readOnly=false, destructive=false, idempotent=false) it discloses the things an agent actually needs: the call blocks until the page is ready, it returns the URL, the default visibility is private to the caller, sandbox restrictions on external resources, and the run-time capability model. It also clarifies that scripts cannot fetch anywhere and libraries must be version-pinned, which prevents a whole class of failed publications.

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-loads what the tool produces and the privacy default, then layers the interactive-page case and the alternative. Dense but every sentence carries information; some sentences are long and the state/capabilities discussion could be split for scannability, so not a 5.

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 an 11-parameter, nested-schema, capability-bearing creation tool with an output schema, the description covers the decision-relevant surface: default visibility, blocking-then-URL semantics, content sandbox rules, the state/capabilities model, and the sibling alternative. Return values are documented by the output schema, so leaving them to it is appropriate.

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 schema already carries the heavy lifting and a 3 is the baseline; the description earns an increment by explaining the intent behind capabilities and state.rules (a page that must remember a checklist/poll/sign-up) and by stating 'Pass the whole document as content'. That usage-level framing adds meaning the property descriptions alone don't convey, though the per-field detail remains in the schema.

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?

Opens with a specific verb and resource ('Publish an HTML page or a Markdown document as a Bisque Artifact') and immediately defines the resulting object as a persistent, versioned page at a stable URL. It also names the sibling to use instead when the goal is a narrated deck (create_presentation), so an agent can discriminate it from neighbors without reading schemas.

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 positive usage context (whole document as content, update later with update_artifact, declare capabilities only for interactive pages) and one explicit alternative ('For a narrated presentation use create_presentation instead'). It stops short of full when-not guidance โ€” e.g., it never says when to use share_artifact or create_artifact_thread instead of folding sharing into this call โ€” but the routing it does provide is concrete.

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