Skip to main content
Glama

Edit artifact details

artifact_patch
DestructiveIdempotent

Patch artifact details, visibility, folder or history (how many earlier versions its whole-file updates keep: off, all or a count; null follows its folder, then its workspace; not on a table) without creating a version; name at least one. Workspace artifacts need why (except a patch of visibility alone), and expectedWorkspaceRevision when description or metadata is sent (the patch was composed from what you read); with only title, alias, folder, visibility or history it is optional and refuses (CONFLICT) if the artifact changed since. visibility on a workspace artifact is private or link (anyone with the URL reads it, without signing in), set by its editors. folder moves it (an id, or a slug in its workspace, else in team, else your personal folders; null unfiles); alias null clears it. A link exposes every version it keeps. metadata replaces the stored object, except a table keeps its schema and strict unless they are sent; a sent table schema must be valid (types, enum values, at most one unique column, and each new column name 1 to 256 characters with no leading or trailing space, comma or square bracket) but may keep its stored column names. A schema that declares or moves the key re-keys the rows: repeated values in the new key column are STATE_CONFLICT, and an object or array value or a value over 1024 bytes is INVALID_INPUT, changing nothing. Returns a bounded receipt.

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": {
      "artifactId": "<artifactId>"
    },
    "name": "artifact_patch"
  }
}

Input Schema

NameRequiredDescriptionDefault
whyNoRequired for workspace items: one sentence on what the person is trying to accomplish, in their terms, not a description of this edit. Every workspace write takes one; sessions and summaries record themselves from it. Not needed to change only visibility; recorded when sent. At most 300 characters.
teamNoWith a folder slug: the team the folder belongs to.
aliasNoA new URL alias, or null to clear it.
titleNo
folderNoMove it: a folder id, or a slug (in its workspace, else in team, else your personal folders); null unfiles it.
historyNoHow many earlier versions its whole-file updates keep: off, all, or a number from 1 to 100; null follows its folder, then its workspace (default off). Takes effect at the next write; deletes nothing now.
metadataNoReplaces the stored metadata (null clears it); a table keeps its schema and strict unless they are sent.
artifactIdYesThe artifact: its id, its alias (bare, ~agent/alias or _team/alias), or its page URL.
visibilityNoWho beyond its home reads it. Standalone: private, link or public (listed). Workspace: private or link (anyone with the URL), set by editors. A patch of visibility alone needs no why.
descriptionNo
expectedWorkspaceRevisionNoThe artifact's workspaceRevision as you read it: required with description or metadata on a workspace artifact, else optional (a stale one is CONFLICT).

Output Schema

NameRequiredDescriptionDefault
artifactYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • removedInput schema / properties / audience
      Removed value: -{
      -  "description": "Workspace audience: internal (the default for internal members) or shared (external members see it too; the only choice for external editors).",
      -  "enum": [
      -    "internal",
      -    "shared"
      -  ],
      -  "type": "string"
      -}
    • changedInput schema / properties / visibility / description
      Previous value: -"Who beyond its home reads it. Standalone: private, link or public (listed). Workspace: private or link (anyone with the URL), set by internal editors; link on an internal artifact makes it shared, and audience internal turns link off. A patch of visibility alone needs no why."New value: +"Who beyond its home reads it. Standalone: private, link or public (listed). Workspace: private or link (anyone with the URL), set by editors. A patch of visibility alone needs no why."
    • removedOutput schema / properties / artifact / properties / audience
      Removed value: -{
      -  "enum": [
      -    "internal",
      -    "shared"
      -  ],
      -  "type": "string"
      -}
  2. Changed3 schema fields changed
    • addedInput schema / properties / history
      Added value: +{
      +  "anyOf": [
      +    {
      +      "anyOf": [
      +        {
      +          "enum": [
      +            "off",
      +            "all"
      +          ],
      +          "type": "string"
      +        },
      +        {
      +          "maximum": 100,
      +          "minimum": 1,
      +          "type": "integer"
      +        }
      +      ]
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "How many earlier versions its whole-file updates keep: off, all, or a number from 1 to 100; null follows its folder, then its workspace (default off). Takes effect at the next write; deletes nothing now."
      +}
    • addedOutput schema / properties / artifact / properties / history
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "from": {
      +          "enum": [
      +            "file",
      +            "folder",
      +            "workspace",
      +            "default"
      +          ],
      +          "type": "string"
      +        },
      +        "value": {
      +          "anyOf": [
      +            {
      +              "enum": [
      +                "off",
      +                "all"
      +              ],
      +              "type": "string"
      +            },
      +            {
      +              "maximum": 100,
      +              "minimum": 1,
      +              "type": "integer"
      +            }
      +          ]
      +        }
      +      },
      +      "required": [
      +        "value",
      +        "from"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / artifact / required
      Previous value: -[
      -  "id",
      -  "url",
      -  "rawUrl",
      -  "type",
      -  "currentVersionId",
      -  "alias",
      -  "title",
      -  "folder"
      -]New value: +[
      +  "id",
      +  "url",
      +  "rawUrl",
      +  "type",
      +  "currentVersionId",
      +  "alias",
      +  "title",
      +  "folder",
      +  "history"
      +]
  3. Changed5 schema fields changed
    • addedOutput schema / properties / artifact / properties / alias
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / artifact / properties / folder
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "id": {
      +          "format": "uuid",
      +          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      +          "type": "string"
      +        },
      +        "slug": {
      +          "type": "string"
      +        },
      +        "teamSlug": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "slug"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / artifact / properties / rawUrl
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / artifact / properties / title
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / artifact / required
      Previous value: -[
      -  "id",
      -  "url",
      -  "type",
      -  "currentVersionId"
      -]New value: +[
      +  "id",
      +  "url",
      +  "rawUrl",
      +  "type",
      +  "currentVersionId",
      +  "alias",
      +  "title",
      +  "folder"
      +]
  4. First observed

TDQS

A4.2/5.0
Behavior5/5

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

Beyond the annotations, the description discloses important behavior: no version is created, links expose all retained versions, metadata replaces the stored object, table schemas may be preserved, re-keying can produce STATE_CONFLICT or INVALID_INPUT, and a bounded receipt is returned. This is unusually complete behavioral context for a destructive mutation tool.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The content is front-loaded and mostly earns its place, but it is written as a dense run-on paragraph with nested semicolon clauses and parentheticals. The information is valuable, yet the structure makes it harder to scan than it should be for such a complex tool.

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 complexity, the annotations, the 82% schema coverage, and the output schema, the description is complete: it covers constraints, error outcomes, workspace requirements, table-specific behavior, and the non-versioning nature of the operation. An agent has enough context to invoke it 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 already high at 82%, so the schema carries most parameter meaning. The description still adds material semantics beyond the schema, especially conditional requirements for why and expectedWorkspaceRevision, folder resolution order, null-clearing behavior, and schema re-keying consequences.

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?

The description names a specific verb and resource (patch artifact details, visibility, folder, history, metadata, title, alias) and clearly bounds the operation. It does not explicitly distinguish itself from nearby tools such as artifact_update or artifact_move, so it falls short of the sibling-differentiation required for a 5.

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 substantial usage context: at least one field must be named, workspace patches require a why except visibility-only patches, and expectedWorkspaceRevision has conditional requirements. It does not explicitly compare this tool against alternatives, but the conditions for using it are 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.