dolphinscheduler icon indicating copy to clipboard operation
dolphinscheduler copied to clipboard

[DSIP-92][API] Should we introduce an official Dolphin Scheduler client?

Open Sud0x67 opened this issue 5 months ago • 3 comments

Search before asking

  • [x] I had searched in the DSIP and found no similar DSIP.

Motivation

If an official Dolphin Scheduler client is introduced, it would enable developers to interact with Dolphin Scheduler in new and flexible ways.

For example, an MCP server could be built on top of this client and integrated into LLM-based applications. A use case within the MCP client could be as simple as instructing the model to "create a workflow scheduler at 3:00 AM." MCP client would then invoke the MCP server, which in turn utilizes the Dolphin Scheduler client to automatically create the scheduled workflow.

Alternatively, the client could also be used in a traditional application — allowing developers to create workflows programmatically via API, without the need for a UI.

Design Detail

No Design details at present, just an idea. May use swagger to generate a client automatically?

Compatibility, Deprecation, and Migration Plan

No content.

Test Plan

later.

Code of Conduct

Sud0x67 avatar Jul 27 '25 16:07 Sud0x67

+1 to this DSIP.

Right now Dolphin API is actually quite difficult to use, if we have sdk can help to reduce the bar. But before that, we need to determine which APIs are needed in the client.

ruanwenjun avatar Jul 28 '25 01:07 ruanwenjun

Hi @ruanwenjun, thanks for your reply! I'll add more details to this proposal later. If you have more ideas, please comment directly.

Sud0x67 avatar Jul 28 '25 01:07 Sud0x67

+1, sounds pretty promising to me. Not like airflow holding the concept of workflow as code, current apis of dolphinscheduler users use to create workflows could be complicated in input and output parameters, which may become a big challenge.

EricGao888 avatar Sep 05 '25 07:09 EricGao888