Skip to main content
Glama
dolphin-mcp-pilot

dolphin-mcp-pilot

ds_raw_put

Sends a raw PUT request to a DolphinScheduler API path with form or JSON data, covering update endpoints not handled by dedicated tools.

Instructions

Send a raw PUT request to the DolphinScheduler API (escape hatch).

Prefer the dedicated update tools (e.g. ds_update_workflow, ds_update_schedule_cron); use this only for endpoints they do not cover.

Args: path: API path starting with / and excluding the /dolphinscheduler prefix, e.g. "/projects/123/schedules/7" form_data_json: form-urlencoded params as a JSON object string, e.g. '{"crontab": "0 0 2 * * ? *"}' (set this or json_body_json) json_body_json: JSON body as a JSON string (set this or form_data_json)

Returns: DolphinScheduler's response as-is ({"code", "msg", "data", ...}); code 0 means success.

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": {
      "path": "<path>"
    },
    "name": "ds_raw_put"
  }
}

Input Schema

NameRequiredDescriptionDefault
pathYes
form_data_jsonNo
json_body_jsonNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.3.1

TDQS

A4.6/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: it discloses that exactly one of the two body parameters should be set, and that responses come back as-is with code 0 signalling success. It omits permission/auth prerequisites and whether the PUT is idempotent or destructive, which matters for a mutation-only escape hatch.

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 escape-hatch guidance before the Args block, then clean Args/Returns sections. Every line carries usable information, such as the prefix exclusion and the code-0 success convention.

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?

Covers the essentials for a raw HTTP passthrough with no output schema: path formatting, body encoding choice, and the response envelope. It falls short only on what an agent most needs before a blind mutation, namely permissions and side effects.

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%, and the description compensates well: the path format is pinned down (leading slash, no /dolphinscheduler prefix) with a concrete example, and both body parameters get example values plus an either/or relationship. What remains unstated is what happens if both body parameters are supplied and whether endpoints differ in which one they accept.

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 ("Send a raw PUT request to the DolphinScheduler API") and immediately frames itself as an escape hatch. The parenthetical 'raw' plus the sibling pointers distinguish it from the named update tools without needing the 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 preference rule: use the dedicated update tools, and this one 'only for endpoints they do not cover,' naming ds_update_workflow and ds_update_schedule_cron as alternatives. A fallback condition and the excluded case are both stated.

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