Skip to main content
Glama

Update Artifact

lyzr_update_artifact
Idempotent

Update an existing artifact by specifying its ID and optional new fields like name, description, content, metadata, or format, scoped to a user and session.

Instructions

Update fields on an existing artifact, scoped to a user and session.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataNoNew artifact payload/content
nameNoNew name
user_idYesUser id
metadataNoNew metadata (replaces existing)
session_idYesSession id
artifact_idYesArtifact id to update
descriptionNoNew description
format_typeNoNew format type
Behavior3/5

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

Annotations already convey safety profile (not read-only, not destructive, idempotent). The description adds the scoping constraint (user/session) but doesn't disclose behavioral details such as whether fields are fully replaced or merged, beyond what the schema already states. No contradiction with annotations.

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?

A single, front-loaded sentence that efficiently states the operation and scope. No fluff, every word contributes to understanding the tool's purpose.

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?

Given 8 optional fields, 3 required params, and no output schema, the description provides enough context for an update operation: it identifies the entity, the action, and the scope. It doesn't mention return values, but the schema and annotations fill in most gaps. Slightly more detail about merging/overriding semantics could improve it.

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 description coverage is 100%, so the description doesn't need to add parameter meaning. The description's mention of 'fields' is generic; all parameter details are already in the schema. Baseline 3 is appropriate.

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?

The description uses a specific verb ('Update') and resource ('fields on an existing artifact'), clearly distinguishing it from create/get/delete/list siblings. Adding 'scoped to a user and session' further clarifies the intended operation.

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?

The phrase 'existing artifact' implies it should be used when the artifact already exists and needs modification, not for creation or retrieval. It provides clear context but does not explicitly name exclusions or alternatives like 'use create_artifact for new artifacts'.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/nandanNM/lyzr-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server