Skip to main content
Glama
zenml-io

ZenML MCP Server

Official
by zenml-io

list_snapshots

Retrieve and filter frozen pipeline configurations in ZenML workspaces to identify runnable or deployable snapshots with pagination support.

Instructions

List all snapshots in the ZenML workspace.

Snapshots are frozen pipeline configurations that replace the deprecated
Run Templates. Use `runnable=True` to find snapshots that can be triggered.

Returns JSON including pagination metadata (items, total, page, size).

Args:
    sort_by: The field to sort the snapshots by
    page: The page number to return
    size: The number of snapshots to return
    logical_operator: The logical operator to use for combining filters
    created: Filter by creation date
    updated: Filter by last update date
    name: Filter by snapshot name
    pipeline: Filter by pipeline name or ID
    runnable: Filter to only runnable snapshots (can be triggered)
    deployable: Filter to only deployable snapshots
    deployed: Filter to only currently deployed snapshots
    tag: Filter by tag
    project: Optional project scope (defaults to active project)
    named_only: Only return named snapshots (default True to avoid internal ones)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sort_byNodesc:created
pageNo
sizeNo
logical_operatorNoand
createdNo
updatedNo
nameNo
pipelineNo
runnableNo
deployableNo
deployedNo
tagNo
projectNo
named_onlyNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior4/5

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

With no annotations provided, the description carries full burden and does well by disclosing key behaviors: it explains what snapshots are, mentions pagination metadata in returns, and describes the purpose of the runnable parameter. It could improve by mentioning authentication needs or rate limits, but covers essential operational context.

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 with a clear purpose statement, context about snapshots, usage tip, return format, and detailed parameter explanations. While comprehensive, it's appropriately sized for a tool with 14 parameters and no schema descriptions. Some sentences could be more concise, but overall it's front-loaded with essential information.

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 complexity (14 parameters, 0% schema coverage, no annotations) and the presence of an output schema, the description is remarkably complete. It explains the tool's purpose, provides usage guidance, documents all parameters thoroughly, and mentions the return format. The output schema handles return values, so the description focuses appropriately on inputs and context.

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

Parameters5/5

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

With 0% schema description coverage for 14 parameters, the description compensates excellently by providing a comprehensive 'Args' section that explains every parameter's purpose, including defaults and filtering logic (e.g., 'named_only: Only return named snapshots (default True to avoid internal ones)'). This adds substantial meaning beyond the bare 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?

The description clearly states the specific action ('List all snapshots') and resource ('in the ZenML workspace'), distinguishing it from sibling tools like get_snapshot (singular) and trigger_pipeline. It also explains what snapshots are ('frozen pipeline configurations that replace the deprecated Run Templates'), providing domain context.

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 description provides clear context for when to use the tool ('Use `runnable=True` to find snapshots that can be triggered'), which helps differentiate from trigger_pipeline. However, it doesn't explicitly state when NOT to use this tool or mention specific alternatives among siblings beyond the general context.

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