Skip to main content
Glama

pause_deployment_schedule

Pause the automated schedule of a Prefect deployment to temporarily halt workflow execution without deleting the deployment configuration.

Instructions

Pause a deployment's schedule.

Args: deployment_id: The deployment UUID

Returns: Confirmation message

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
deployment_idYes

Implementation Reference

  • The handler function for the 'pause_deployment_schedule' MCP tool. It is decorated with @mcp.tool for registration and implements pausing the schedule of a Prefect deployment by calling the Prefect client's pause_deployment_schedule method.
    @mcp.tool
    async def pause_deployment_schedule(
        deployment_id: str,
    ) -> List[Union[types.TextContent, types.ImageContent, types.EmbeddedResource]]:
        """
        Pause a deployment's schedule.
        
        Args:
            deployment_id: The deployment UUID
            
        Returns:
            Confirmation message
        """
        async with get_client() as client:
            await client.pause_deployment_schedule(UUID(deployment_id))
            
            return [types.TextContent(type="text", text=f"Schedule for deployment '{deployment_id}' paused successfully.")]
Behavior2/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 states the action ('Pause') but doesn't explain whether this requires specific permissions, if it's reversible, what happens to active runs, or any side effects. This is inadequate for a mutation tool with zero 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.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with clear sections for purpose, arguments, and returns. It's front-loaded with the core action and uses minimal sentences. The 'Args' and 'Returns' sections are efficient, though the 'Returns' part could be more specific.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with no annotations and no output schema, the description is incomplete. It lacks details on behavioral traits, error conditions, prerequisites, and the confirmation message format. Given the complexity of pausing a deployment schedule, more context is needed for safe and effective use.

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?

The description includes an 'Args' section that documents the single parameter 'deployment_id' as 'The deployment UUID', adding meaning beyond the schema (which has 0% description coverage). However, it doesn't provide format examples, validation rules, or where to find the UUID, leaving some gaps.

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 with a specific verb ('Pause') and resource ('a deployment's schedule'), making it immediately understandable. However, it doesn't explicitly differentiate from sibling tools like 'pause_work_queue' or contrast with 'resume_deployment_schedule', 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 guidance is provided on when to use this tool versus alternatives. The description doesn't mention prerequisites, conditions for pausing, or what happens after pausing. It also doesn't reference related tools like 'resume_deployment_schedule' or 'set_deployment_schedule' for 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/allen-munsch/mcp-prefect'

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