Skip to main content
Glama
dolphin-mcp-pilot

dolphin-mcp-pilot

ds_pause_process_instance

Pauses a running workflow instance without stopping it: running tasks finish, no new tasks start, and the instance stays in PAUSE state until resumed.

Instructions

Pause a RUNNING workflow instance (reversible; not a stop).

Tasks already running finish, no new tasks are started, and the instance ends in PAUSE state. Use ds_resume_process_instance to continue it, or ds_stop_process_instance to kill it instead.

Args: project_name: Project name process_instance_id: Instance ID (from ds_list_process_instances)

Returns: {"process_instance_id": int, "executeType": "PAUSE", "status": "submitted"}; the request is asynchronous, so check the state with ds_list_process_instances.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "project_name": "<project_name>",
      "process_instance_id": "<process_instance_id>"
    },
    "name": "ds_pause_process_instance"
  }
}

Input Schema

NameRequiredDescriptionDefault
project_nameYes
process_instance_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.8/5.0
Behavior5/5

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

With no annotations supplied, the description carries the full burden and does so well: it discloses reversibility, that in-flight tasks finish, that no new tasks start, the resulting PAUSE state, and that the call is asynchronous returning status "submitted". It also states the follow-up check needed to confirm the transition.

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?

Front-loaded with the core action and the critical stop-vs-pause distinction, then structured into Args and Returns sections. The Args block adds little beyond the schema field names, a small amount of low-value text, but nothing is confusing or padded.

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?

No output schema exists, so the description supplies the return shape itself, and it explains the asynchronous semantics that an agent must know to interpret that return. For a two-parameter mutation tool, nothing essential is missing.

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 coverage is 0%, so the description must compensate. It does partially: process_instance_id is annotated with its origin (ds_list_process_instances), which is genuinely useful for locating the value, while project_name is only restated tautologically and no format/typing detail is added.

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?

States a specific verb and resource ("Pause a RUNNING workflow instance") plus an immediate disambiguation in parentheses ("reversible; not a stop"), which separates it from ds_stop_process_instance and ds_resume_process_instance without needing their schemas.

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

Usage Guidelines5/5

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

Explicitly routes the agent: use ds_resume_process_instance to continue, ds_stop_process_instance to kill instead, and ds_list_process_instances to check state. Both the alternative tools and the conditions selecting them are named.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.