Skip to main content
Glama
dolphin-mcp-pilot

dolphin-mcp-pilot

ds_list_datasources

List readable data sources by type and return their IDs for SQL task configuration in workflows and DAGs. Read-only; returns an empty list if none match.

Instructions

List the data sources of one type that the current user can see (read-only).

Pass the returned id as datasource_id of SQL tasks, e.g. in ds_create_workflow or ds_create_dag_workflow.

Args: ds_type: Data source type in DolphinScheduler's upper-case form, e.g. HIVE (default), MYSQL, POSTGRESQL, SPARK, CLICKHOUSE.

Returns: [{"id": int, "name": str, "type": str}, ...]; empty if none match.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "ds_list_datasources"
  }
}

Input Schema

NameRequiredDescriptionDefault
ds_typeNoHIVE

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 supplied, the description carries the full burden, and it does most of the work: it declares the operation read-only, flags that results are permission-filtered to what the current user can see, and states that an empty list is returned when nothing matches. It does not mention pagination, ordering, or whether hidden/archived data sources are included, which are the remaining unknowns for a listing tool.

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?

The purpose is front-loaded in the first sentence, followed by usage and Args/Returns blocks that are easy to scan. The reStructuredText double-backtick artifacts and the explicit 'Args:'/'Returns:' headers add light noise for a single-parameter tool, but nothing is genuinely wasteful.

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 one-parameter read-only list tool with no output schema, the description supplies everything an agent needs: the filter semantics, the accepted value format, the default, the return record shape, and the empty-result behavior. Nothing material 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 description coverage is 0%, so the description must compensate, and it does: ds_type is documented as DolphinScheduler's upper-case form with concrete values (HIVE, MYSQL, POSTGRESQL, SPARK, CLICKHOUSE) and a stated default of HIVE. The default is already present in the schema, so a small part of this is redundant, keeping it from a 5.

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 opening sentence gives a specific verb ('List'), a specific resource ('data sources'), and a scope ('of one type that the current user can see', 'read-only'). This is distinguishable from the other ds_list_* siblings (projects, workflows, tenants, users) without opening any schema.

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

Usage Guidelines4/5

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

It explicitly states the downstream purpose: pass the returned id as datasource_id for SQL tasks in ds_create_workflow or ds_create_dag_workflow, which tells an agent exactly when this tool is a prerequisite. It stops short of naming when NOT to use it or what to do if the list is empty, so it falls just shy of a 5.

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