Skip to main content
Glama

pause_workflow

Pause a running workflow execution to temporarily halt its progress, allowing for troubleshooting or manual intervention before resuming operations.

Instructions

Pause a running workflow execution. The workflow will pause and can be resumed later.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
workflowIdYesThe workflow execution ID to pause

Implementation Reference

  • Executes the pause_workflow tool by sending a PUT request to Conductor's /workflow/{workflowId}/pause endpoint and returns a success message.
    case "pause_workflow": {
      const { workflowId } = args as any;
      await conductorClient.put(`/workflow/${workflowId}/pause`);
      
      return {
        content: [
          {
            type: "text",
            text: `Workflow ${workflowId} paused successfully.`,
          },
        ],
      };
    }
  • Defines the tool schema with name, description, and input schema requiring a workflowId string.
    {
      name: "pause_workflow",
      description:
        "Pause a running workflow execution. The workflow will pause and can be resumed later.",
      inputSchema: {
        type: "object",
        properties: {
          workflowId: {
            type: "string",
            description: "The workflow execution ID to pause",
          },
        },
        required: ["workflowId"],
      },
    },
  • src/index.ts:598-602 (registration)
    Registers the list of tools (including pause_workflow) for the ListToolsRequestSchema handler.
    server.setRequestHandler(ListToolsRequestSchema, async () => {
      return {
        tools,
      };
    });
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It mentions that the workflow 'can be resumed later', which adds some context about the pause state. However, it lacks details on permissions required, whether the pause is immediate or delayed, error conditions, or what happens to in-progress tasks, leaving significant gaps for a mutation tool.

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 two concise sentences that are front-loaded with the main action and outcome. There is no redundant or unnecessary information, making it efficient and easy to understand.

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

Completeness3/5

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

Given the tool's complexity as a mutation operation with no annotations and no output schema, the description is minimally adequate. It covers the basic purpose and effect but lacks details on behavioral aspects like error handling or return values, which are important for an agent to use it correctly.

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 schema description coverage is 100%, with the parameter 'workflowId' clearly documented in the schema. The description does not add any additional meaning or details about the parameter beyond what the schema provides, such as format examples or constraints, so it meets the baseline for high schema coverage.

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 ('Pause') and resource ('a running workflow execution'), distinguishing it from siblings like 'resume_workflow' or 'terminate_workflow'. It also mentions the outcome ('can be resumed later'), which adds clarity about the tool's effect.

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

Usage Guidelines3/5

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

The description implies usage context by specifying 'a running workflow execution', suggesting it should be used when a workflow is active. However, it does not explicitly state when to use this tool versus alternatives like 'terminate_workflow' or 'restart_workflow', nor does it provide exclusions or prerequisites for usage.

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/opensensor/conductor-mcp'

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