Skip to main content
Glama
dolphin-mcp-pilot

dolphin-mcp-pilot

ds_delete_process_instance

Permanently deletes a finished DolphinScheduler workflow instance and its task records. Stop running instances first; deletion is irreversible and does not affect the workflow definition.

Instructions

Permanently delete a finished workflow instance and its task records.

Irreversible. DolphinScheduler rejects deleting a RUNNING instance; stop it first with ds_stop_process_instance. Does not affect the workflow definition.

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

Returns: {"process_instance_id": int, "status": "deleted"}

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_delete_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.5/5.0
Behavior4/5

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

With no annotations, the description carries the disclosure burden and does well: it states irreversibility, that task records are destroyed, that the workflow definition is untouched, and the server-side rejection of RUNNING instances. It does not cover permission requirements or error/partial-failure behavior, so it falls short of full transparency.

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?

Front-loaded with the action and the destructive/irreversible warning before any logistics, then short Args/Returns blocks. No filler sentences and nothing duplicated across sections.

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?

For a simple two-parameter mutation with no output schema, the description supplies everything needed to call it safely: the destructive scope, the running-instance guard, the sibling to use first, and even the return payload. Nothing material is missing.

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?

Schema description coverage is 0%, so the description must compensate, and it only partially does. 'process_instance_id' gains real value from the pointer to ds_list_process_instances, but 'project_name: Project name' is a restatement of the field title with no added meaning (e.g., case sensitivity or exact-match behavior).

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 first sentence names a specific verb and resource ('Permanently delete a finished workflow instance and its task records') and scopes it to finished instances. The follow-up 'Does not affect the workflow definition' separates it from ds_delete_workflow, so an agent can pick between the two without opening a schema.

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?

Gives an explicit precondition ('DolphinScheduler rejects deleting a RUNNING instance') plus the correct alternative to use first ('stop it first with ds_stop_process_instance'). This is a concrete when-to-use / what-to-do-instead rule rather than an implied one.

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