Skip to main content
Glama

Read artifact

artifact_read
Read-onlyIdempotent

Read artifact metadata and complete immutable file content. Tables return a typed direction to table_get_rows.

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_read"
  }
}

Input Schema

NameRequiredDescriptionDefault
versionIdNoOne version's content (default: the current one).
artifactIdYesThe artifact: its id, its alias (bare, ~agent/alias or _team/alias), or its page URL.

Output Schema

NameRequiredDescriptionDefault
contentNo
artifactYes
tableToolNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedOutput schema / properties / artifact / properties / audience
      Removed value: -{
      -  "enum": [
      -    "internal",
      -    "shared"
      -  ],
      -  "type": "string"
      -}
  2. Changed3 schema fields changed
    • addedOutput schema / properties / artifact / properties / currentVersionNumber
      Added value: +{
      +  "anyOf": [
      +    {
      +      "exclusiveMinimum": 0,
      +      "maximum": 9007199254740991,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ]
      +}
    • 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",
      -  "visibility",
      -  "mimeType",
      -  "sizeBytes",
      -  "versionCount",
      -  "ownerId",
      -  "parentArtifactId",
      -  "publicAsset",
      -  "createdAt",
      -  "updatedAt"
      -]New value: +[
      +  "id",
      +  "url",
      +  "rawUrl",
      +  "type",
      +  "currentVersionId",
      +  "alias",
      +  "title",
      +  "folder",
      +  "visibility",
      +  "mimeType",
      +  "sizeBytes",
      +  "versionCount",
      +  "currentVersionNumber",
      +  "ownerId",
      +  "parentArtifactId",
      +  "publicAsset",
      +  "history",
      +  "createdAt",
      +  "updatedAt"
      +]
  3. Changed3 schema fields changed
    • 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"
      +    }
      +  ]
      +}
    • changedOutput schema / properties / artifact / required
      Previous value: -[
      -  "id",
      -  "url",
      -  "type",
      -  "currentVersionId",
      -  "visibility",
      -  "alias",
      -  "title",
      -  "mimeType",
      -  "sizeBytes",
      -  "versionCount",
      -  "ownerId",
      -  "parentArtifactId",
      -  "publicAsset",
      -  "createdAt",
      -  "updatedAt"
      -]New value: +[
      +  "id",
      +  "url",
      +  "rawUrl",
      +  "type",
      +  "currentVersionId",
      +  "alias",
      +  "title",
      +  "folder",
      +  "visibility",
      +  "mimeType",
      +  "sizeBytes",
      +  "versionCount",
      +  "ownerId",
      +  "parentArtifactId",
      +  "publicAsset",
      +  "createdAt",
      +  "updatedAt"
      +]
  4. First observed

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already declare readOnly, idempotent, non-destructive, and closed-world behavior. On top of that, the description discloses that the returned content is 'complete' and 'immutable', which tells the agent there is no truncation or mutation risk, and it explains the table-passthrough behavior. Slight gap: it does not address large-file or size limits.

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?

Two sentences, front-loaded with what is returned, followed by the one exception case. No filler wording.

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?

A read tool with only 2 fully documented parameters, an output schema, and rich annotations. The description covers purpose and the tabular exception, so it is nearly sufficient. The only omission is how it relates to the similar artifact_get and artifact_get_content siblings.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, and the schema itself documents that artifactId accepts an id, alias, or page URL, and that versionId defaults to the current version. The description adds nothing beyond that, which is acceptable when the schema already carries the full semantics.

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?

States a specific verb and object pair: 'Read artifact metadata and complete immutable file content.' That is clearly distinct from mutation siblings such as artifact_append or artifact_delete, though it does not differentiate itself from the close-looking artifact_get and artifact_get_content names.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

One explicit routing rule is given: tables should go to table_get_rows and get back a typed direction instead of raw rows. The description offers no guidance on when to choose this tool over artifact_get or artifact_get_content, so an agent must infer those boundaries.

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.