Skip to main content
Glama
dolphin-mcp-pilot

dolphin-mcp-pilot

ds_offline_schedule

Takes a DolphinScheduler schedule offline to stop it triggering new runs while keeping the schedule and running instances intact. Use when you need to temporarily halt a schedule without deleting it.

Instructions

Take a schedule offline so it stops triggering new runs.

Keeps the schedule and running instances; bring it back with ds_online_schedule, or remove it with ds_delete_schedule.

Args: project_name: Project name schedule_id: Schedule ID (from ds_list_schedules)

Returns: {"schedule_id": int, "status": "OFFLINE"}

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>",
      "schedule_id": "<schedule_id>"
    },
    "name": "ds_offline_schedule"
  }
}

Input Schema

NameRequiredDescriptionDefault
schedule_idYes
project_nameYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.4/5.0
Behavior4/5

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

With no annotations, the description carries the full burden and does well: it discloses what is preserved (the schedule and running instances) and the resulting state (status OFFLINE), which is exactly the non-obvious behavior for a mutation. It omits permission requirements and what happens if the schedule is already offline, keeping it short of a 5.

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 behavioral effect is front-loaded in the first sentence, alternatives follow in the second, and the Args/Returns block is minimal. No sentence is redundant.

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?

For a two-parameter state-change tool with no output schema, the definition covers effect, reversibility, alternatives, and the return shape (schedule_id plus OFFLINE status). Only error and permission behavior are left unaddressed, which is a minor gap at this complexity.

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 coverage is 0%, so the description must compensate. It does partially: "from ds_list_schedules" tells the agent where to obtain schedule_id, which is real added value, but "project_name: Project name" merely restates the field and neither parameter's format or constraints are clarified.

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 names a specific verb and resource ("Take a schedule offline") and immediately states the observable effect ("stops triggering new runs"). It explicitly distinguishes itself from two siblings, ds_online_schedule and ds_delete_schedule, so an agent can separate the three 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?

It gives an explicit routing rule: use ds_online_schedule to reverse, use ds_delete_schedule to remove permanently, and use this tool when you want the schedule kept but paused. The state consequence of each choice is spelled out, leaving nothing to inference.

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