Skip to main content
Glama
zenml-io

ZenML MCP Server

Official
by zenml-io

get_deployment

Retrieve detailed information about a specific ZenML deployment, including its runtime status, URL, and metadata, to monitor and manage what's currently serving or provisioned.

Instructions

Get detailed information about a specific deployment.

Deployments represent the runtime state of what's currently serving/provisioned,
including status, URL, and metadata. They tie back to snapshots.

Args:
    name_id_or_prefix: The name, ID or prefix of the deployment to retrieve
    project: Optional project scope (defaults to active project)
    hydrate: Whether to hydrate the response with additional details

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
name_id_or_prefixYes
projectNo
hydrateNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes
Behavior2/5

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

No annotations are provided, so the description carries full burden. It mentions that deployments include 'status, URL, and metadata' and 'tie back to snapshots,' adding some context. However, it doesn't disclose critical behavioral traits like whether this is a read-only operation, authentication requirements, error handling, or rate limits, which are essential for a tool with no annotation coverage.

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?

The description is well-structured and appropriately sized. It starts with a clear purpose statement, provides context about deployments, and lists parameters with brief explanations. Every sentence adds value, and there's no redundant or wasted text.

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 (3 parameters, no annotations, but with an output schema), the description is fairly complete. It explains the purpose, parameters, and context of deployments. The output schema likely covers return values, so the description doesn't need to detail them. However, it lacks behavioral transparency and usage guidelines, which slightly reduces completeness.

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?

Schema description coverage is 0%, so the description must compensate. It provides clear semantics for all three parameters: 'name_id_or_prefix' as the identifier, 'project' as an optional scope with default behavior, and 'hydrate' for additional details. This adds significant value beyond the bare schema, though it could be more detailed (e.g., format examples).

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 deployment.' It specifies the verb ('get') and resource ('deployment'), and explains what deployments represent. However, it doesn't explicitly differentiate from sibling tools like 'list_deployments' or 'get_deployment_logs', which would be needed for a perfect score.

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?

No explicit guidance on when to use this tool versus alternatives is provided. The description doesn't mention sibling tools like 'list_deployments' for listing multiple deployments or 'get_deployment_logs' for logs, nor does it specify prerequisites or exclusions. Usage is implied but not clearly articulated.

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