Skip to main content
Glama
ying-dao

YingDao RPA MCP Server

Official
by ying-dao

startJob

Initiate an RPA job by specifying a robot UUID, optional account or group, timeout settings, and parameters for automated execution.

Instructions

该接口用于启动RPA应用JOB。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
robotUuidYesRPA应用uuid,必填
accountNameNoRPA机器人账号名称,要求机器人的状态为idle,和robotClientGroupUuid互斥,二选一即可
robotClientGroupUuidNoRPA机器人组uuid,和accountName互斥,二选一即可
waitTimeoutSecondsNo等待超时时间(秒)
runTimeoutNo运行超时时间(秒)
paramsNo运行参数

Implementation Reference

  • The MCP tool handler for 'startJob'. It registers the tool with the MCP server, transforms the 'params' object from Record<string,any> into an array of {name, value, type} objects, and delegates to this.openApiService?.startJob().
    this.server.tool('startJob', i18n.t('tool.startJob.description'), startJobSchema, async ({ robotUuid, accountName,params }) => {
        try {
            // Transform params from Record<string, any> to the expected array format
            const transformedParams = params ? Object.entries(params).map(([name, value]) => ({
                name,
                value: String(value), // Convert value to string
                type: 'string' // Default type as string
            })) : undefined;
            
            const result = await this.openApiService?.startJob({
                robotUuid,
                accountName,
                params: transformedParams
            });
            return { content: [{ type: 'text', text: JSON.stringify(result) }]};
        } catch (error) {
            console.error(error);
            throw new Error(i18n.t('tool.startJob.error'));
        }
    });
  • Input schema for the startJob tool using Zod validation. Defines robotUuid (required string), accountName, robotClientGroupUuid, waitTimeoutSeconds, runTimeout, and params (optional record of any).
    export const startJobSchema = {
        robotUuid: z.string().describe(i18n.t('schema.startJob.robotUuid')),
        accountName: z.string().optional().describe(i18n.t('schema.startJob.accountName')),
        robotClientGroupUuid: z.string().optional().describe(i18n.t('schema.startJob.robotClientGroupUuid')),
        waitTimeoutSeconds: z.number()
            .optional()
            .describe(i18n.t('schema.startJob.waitTimeoutSeconds')),
        runTimeout: z.number()
            .optional()
            .describe(i18n.t('schema.startJob.runTimeout')),
        params: z.record(z.any()).optional()
            .describe(i18n.t('schema.startJob.params'))
    } as const;
  • src/baseServer.ts:5-5 (registration)
    Import of the startJobSchema from schema/openApi.ts. The actual registration is on line 102 via this.server.tool('startJob', ...) which binds the schema and handler.
    import { querySchema, robotParamSchema, uploadFileSchema, startJobSchema, queryJobSchema, clientListSchema } from './schema/openApi.js';
  • The OpenApiService.startJob() method that makes the actual HTTP POST request to '/dispatch/v2/job/start'. Validates robotUuid is present, calls the API, and handles errors.
    async startJob(params: JobStartRequest): Promise<JobStartResponse> {
      // Validate required parameters
      if (!params.robotUuid) {
        throw new Error(i18n.t('rpaService.error.robotUuidRequired'));
      }
      try {
        const response = await this.client.post<JobStartResponse>('/dispatch/v2/job/start', params);
        console.log("response",response.data);
        if (!response.data.success || response.data.code !== 200) {
          throw new Error(response.data.msg || i18n.t('rpaService.error.startJobFailed'));
        }
        return response.data;
      } catch (error: any) {
        throw new Error(`${i18n.t('rpaService.error.startJobFailed')}: ${error.message}`);
      }
    }
  • TypeScript interface for JobStartRequest, defining the shape of parameters sent to the startJob API endpoint, including robotUuid, accountName, robotClientGroupUuid, waitTimeout, runTimeout, and params array.
    interface JobStartRequest {
      accountName?: string;
      robotClientGroupUuid?: string;
      robotUuid: string;
      idempotentUuid?: string;
      waitTimeout?: string;
      waitTimeoutSeconds?: number;
      runTimeout?: number;
      priority?: string;
      executeScope?: string;
      params?: Array<{
        name: string;
        value: string;
        type: string;
      }>;
    }
Behavior1/5

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

No annotations provided, and the description gives no behavioral details (e.g., side effects, required permissions, idempotency). The word 'start' implies mutation but no specifics.

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

Conciseness3/5

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

The description is a single concise sentence in Chinese. It is not overly verbose, but it is too minimal to be considered well-structured or fully informative.

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 6 parameters, one required, nested 'params' object, and no output schema, the description is far from complete. It does not explain return values, error conditions, or how parameters interact (e.g., mutual exclusivity of accountName and robotClientGroupUuid).

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 100% with descriptions for all 6 parameters. The description adds no additional meaning beyond the schema, so baseline 3 is appropriate.

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

Purpose4/5

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

The description clearly states the action (start) and resource (RPA application JOB). However, it does not differentiate from sibling tools like queryJob or queryClientList, which are query operations, but the name itself implies uniqueness.

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

Usage Guidelines2/5

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

No guidance on when to use this tool vs alternatives, prerequisites, or context. The description only states the basic purpose without usage instructions.

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/ying-dao/yingdao_mcp_server'

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