Skip to main content
Glama
zenml-io

ZenML MCP Server

Official
by zenml-io

get_snapshot

Retrieve detailed information about a specific pipeline snapshot, including configuration, stack, build, schedule, and tags, to understand exactly what ran or is deployed.

Instructions

Get detailed information about a specific snapshot.

Snapshots are frozen pipeline configurations that link pipeline + stack + build
+ schedule + tags together. They represent "what exactly ran/is deployed" and
are the modern replacement for Run Templates.

Args:
    name_id_or_prefix: The name, ID or prefix of the snapshot to retrieve
    pipeline_name_or_id: Optional pipeline context to narrow the search
    project: Optional project scope (defaults to active project)
    include_config_schema: Whether to include the config schema in the response
        (can produce large payloads)
    hydrate: Whether to hydrate the response with additional details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
name_id_or_prefixYes
pipeline_name_or_idNo
projectNo
include_config_schemaNo
hydrateNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior3/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It does add some useful context: it explains what snapshots are (frozen pipeline configurations) and mentions that include_config_schema 'can produce large payloads.' However, it doesn't cover important behavioral aspects like authentication requirements, rate limits, error responses, or whether this is a read-only operation (though 'get' implies it).

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?

The description is well-structured and appropriately sized. It starts with the core purpose, provides conceptual context about snapshots, then lists parameters with helpful explanations. Every sentence adds value, though the conceptual explanation could be slightly more concise. The parameter explanations are particularly efficient and informative.

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 the tool's complexity (5 parameters, no annotations, but with output schema), the description is quite complete. It explains the tool's purpose, provides conceptual background about snapshots, and thoroughly documents all parameters. The presence of an output schema means the description doesn't need to explain return values. The main gap is lack of usage guidance relative to sibling tools.

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?

The description provides excellent parameter documentation beyond the 0% schema coverage. It explains what each parameter does: 'name_id_or_prefix' identifies the snapshot, 'pipeline_name_or_id' narrows search, 'project' sets scope, 'include_config_schema' affects payload size, and 'hydrate' adds details. This fully compensates for the lack of schema descriptions and adds meaningful context about parameter behavior.

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 clearly states the tool's purpose: 'Get detailed information about a specific snapshot.' It specifies the verb ('get') and resource ('snapshot'), and provides context about what snapshots are (frozen pipeline configurations). However, it doesn't explicitly differentiate from sibling tools like 'list_snapshots' or 'get_pipeline_details', which would be needed for a score of 5.

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

Usage Guidelines2/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention sibling tools like 'list_snapshots' for browsing or 'get_pipeline_details' for pipeline-specific information. There's no context about prerequisites, error conditions, or typical use cases beyond the basic functionality.

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/zenml-io/mcp-zenml'

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