Skip to main content
Glama
zenml-io

ZenML MCP Server

Official
by zenml-io

list_deployments

Retrieve and filter deployments in a ZenML workspace to monitor runtime status, serving pipelines, and provisioned resources with paginated results.

Instructions

List all deployments in the ZenML workspace.

Deployments show what's currently serving/provisioned with runtime status.

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

Args:
    sort_by: The field to sort the deployments by
    page: The page number to return
    size: The number of deployments 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 deployment name
    status: Filter by deployment status (e.g., "running", "error")
    url: Filter by deployment URL
    pipeline: Filter by pipeline name or ID
    snapshot_id: Filter by source snapshot ID
    tag: Filter by tag
    project: Optional project scope (defaults to active project)

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
sort_byNodesc:created
pageNo
sizeNo
logical_operatorNoand
createdNo
updatedNo
nameNo
statusNo
urlNo
pipelineNo
snapshot_idNo
tagNo
projectNo

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 adds value by explaining what deployments represent ('currently serving/provisioned with runtime status') and describing the return format ('JSON including pagination metadata'). However, it doesn't cover important behavioral aspects like rate limits, authentication requirements, error conditions, or whether this is a read-only operation (though 'list' 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 with a clear purpose statement, explanatory context, return format, and parameter documentation. It's appropriately sized for a tool with 13 parameters. The front-loaded purpose statement is effective, though the parameter section is lengthy but necessary.

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 (13 parameters, no annotations, but has output schema), the description is reasonably complete. It explains the resource, provides filtering semantics for all parameters, and describes the return format. The output schema existence means the description doesn't need to detail return values. However, it lacks guidance on usage versus alternatives and some behavioral context.

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 an 'Args' section that documents all 13 parameters with brief explanations, compensating for the 0% schema description coverage. It adds meaning beyond the schema by explaining what each parameter filters by (e.g., 'Filter by deployment status', 'Filter by tag'). However, it doesn't provide format details, examples, or constraints for parameters like 'logical_operator' or date filters.

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: 'List all deployments in the ZenML workspace' with the verb 'list' and resource 'deployments'. It distinguishes deployments by explaining they 'show what's currently serving/provisioned with runtime status', which helps differentiate from other list_* tools. However, it doesn't explicitly contrast with sibling tools like get_deployment or list_services.

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 get_deployment (for single deployment details) or list_services (for related resources), nor does it specify prerequisites or exclusions. Usage context is implied but not stated.

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