Skip to main content
Glama
aliyun
by aliyun

CreateDataServiceApi

Create a data service API in DataWorks MCP Server to expose data through HTTP/HTTPS endpoints with configurable request methods, response types, and access controls.

Instructions

创建数据服务API

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
ProjectIdNo工作空间的ID
ApiNameYesAPI的名称,支持汉字、英文、数字和下划线(_),且只能以英文和汉字开头,4~50个字符
GroupIdYes业务流程的ID
ApiModeNoAPI的类型,可选枚举值包括0(向导API)、1(脚本API)和2(注册API)
RequestMethodNoAPI的请求方式,可选枚举值包括0(GET)、1(POST)、2(PUT)和3(DELETE)。向导和脚本API支持GET和POST。注册API支持GET、POST、PUT和DELETE
ResponseContentTypeNoAPI的返回数据类型,可选枚举值包括0(JSON)和1(XML)。向导和脚本API支持JSON,注册API支持JSON和XML
TimeoutNo超时时间,单位为毫秒(ms),取值范围为(0,30000]
VisibleRangeNo可见范围,可选枚举值包括0(工作空间)和1(私有)
ProtocolsYesAPI的协议,可选枚举值包括0(HTTP)和1(HTTPS)。支持多个值,多个值之间使用英文逗号(,)分隔
ApiPathYesAPI的路径,支持英文、数字、下划线(_)和连字符(-),且只能以斜线(/)开头,不能超过200个字符
ApiDescriptionYesAPI的描述信息
WizardDetailsNo向导API的详情,请参见[GetDataServiceApi](~~174013~~)接口wizardDetails字段的JSONString
ResourceGroupIdNo独享资源组ID
FolderIdNo创建API的目标文件夹ID,业务流程下根文件夹ID等于0,用户自建文件夹ID大于0
RegistrationDetailsNo注册API的详情,请参见[GetDataServiceApi](~~174013~~)接口registrationDetails字段的JSONString
TenantIdNo租户ID
ScriptDetailsNo脚本API的详情,请参见[GetDataServiceApi](~~174013~~)接口scriptDetails字段的JSONString
RequestContentTypeNo请求数据类型。- 0:xml- 1:json- 2:form
SqlModeNo0-基础模式。-1-mybatis
Behavior1/5

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

No annotations are provided, so the description carries full burden for behavioral disclosure. It states 'creates' but doesn't clarify if this is a write operation, what permissions are required, whether it's idempotent, what happens on failure, or what the output looks like (no output schema). For a complex creation tool with 19 parameters, this is a critical gap.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness2/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single phrase ('创建数据服务API') which is overly concise to the point of under-specification. For a tool with 19 parameters and no annotations, this brevity fails to provide necessary context. It's not structured or front-loaded with key information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness1/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (19 parameters, no annotations, no output schema), the description is completely inadequate. It doesn't explain the tool's behavior, output, error handling, or usage context. Sibling tools like 'PublishDataServiceApi' and 'UpdateDataServiceApi' suggest a workflow that isn't addressed, leaving the agent with insufficient guidance.

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 100%, so all parameters are documented in the schema itself. The description adds no additional parameter semantics beyond what's in the schema (e.g., no examples, no clarification of dependencies between parameters like 'ApiMode' and 'RequestMethod'). The baseline of 3 is appropriate since the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description '创建数据服务API' is a tautology that simply restates the tool name in Chinese ('Create Data Service API'). It doesn't specify what 'creating' entails, what a 'Data Service API' is, or how this differs from similar tools like 'PublishDataServiceApi' or 'UpdateDataServiceApi'. The purpose is stated but not clarified beyond the obvious.

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

Usage Guidelines1/5

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

The description provides no guidance on when to use this tool versus alternatives. It doesn't mention prerequisites (e.g., needing a project or group), when to choose this over 'PublishDataServiceApi' or 'UpdateDataServiceApi', or any constraints on usage. With 19 parameters including complex ones like 'ApiMode', this lack of context is problematic.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/aliyun/alibabacloud-dataworks-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server