Skip to main content
Glama
ying-dao

YingDao RPA MCP Server

Official
by ying-dao
OverviewSchemaRelated ServersScoreDiscussions
TypeScript
Hybrid

queryRobotParam

Retrieve RPA robot parameters by providing the robot UUID or exact robot name. Get configuration details to integrate with automated workflows.

Instructions

该接口用于查询RPA机器人参数。

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
robotUuidNoRPA应用UUID
accurateRobotNameNo精确匹配的RPA应用名称

Implementation Reference

  • src/yingdao/openApiService.ts:44-57 (handler)
    The queryRobotParam handler for the OpenAPI service. It sends a POST request to '/robot/v2/queryRobotParam' with robotUuid and accurateRobotName parameters and returns the response data.
    async queryRobotParam(params: {
  robotUuid?: string;
  accurateRobotName?: string;
}): Promise<RobotParamResponse> {
  try {
    const response = await this.client.post('/robot/v2/queryRobotParam', params);
    console.log("response",response.data);
     return response.data.code === 200
      ? response.data.data
      :  response.data.msg ;
  } catch (error: any) {
    throw new Error(`Failed to fetch robot parameters: ${error.message}`);
  }
}
  • src/yingdao/localService.ts:20-31 (handler)
    The queryRobotParam handler for the local service. It reads main.flow.json from the local apps directory and returns the parameters if they exist.
    async queryRobotParam(robotUuid?: string): Promise<any> {
     const mainFlowJsonPath=path.join(this.appsPath, 'xbot_robot','.dev','main.flow.json');
    if (!existsSync(mainFlowJsonPath)) {
        const mainFlow = JSON.parse(readFileSync(mainFlowJsonPath, 'utf8'));
        if (mainFlow.parameters) {
            return mainFlow.parameters;
        } else {
            return [];
        }
    }
    return [];
}
  • src/baseServer.ts:58-65 (registration)
    Registration of the 'queryRobotParam' tool for the local mode. Uses queryRobotParamSchema from local schema and delegates to LocalService.queryRobotParam.
    this.server.tool('queryRobotParam', i18n.t('tool.uploadFile.description'), queryRobotParamSchema, async ({ robotUuid }) => {
    try {
        const result = await this.localService?.queryRobotParam(robotUuid);
        return { content: [{ type: 'text', text: JSON.stringify(result) }]};
    } catch (error) {
        throw new Error(i18n.t('tool.uploadFile.error'));
    }
});
  • src/baseServer.ts:77-87 (registration)
    Registration of the 'queryRobotParam' tool for the OpenAPI mode. Uses robotParamSchema from OpenAPI schema and delegates to OpenApiService.queryRobotParam.
    this.server.tool('queryRobotParam', i18n.t('tool.queryRobotParam.description'), robotParamSchema, async ({ robotUuid, accurateRobotName }) => {
    try {
        const result = await this.openApiService?.queryRobotParam({
            robotUuid,
            accurateRobotName
        });
        return { content: [{ type: 'text', text: JSON.stringify(result) }]};
    } catch (error) {
        throw new Error(i18n.t('tool.queryRobotParam.error'));
    }
});
  • src/schema/local.ts:10-13 (schema)
    Schema definition for local queryRobotParam: accepts optional robotUuid string.
    // Schema for queryRobotParam method
export const queryRobotParamSchema = {
    robotUuid: z.string().optional().describe(i18n.t('schema.local.queryRobotParam.robotUuid'))
} as const;
  • src/schema/openApi.ts:10-13 (schema)
    Schema definition (queryRobotParamSchema) for queryRobotParam in local context, same as local.ts.
    // Schema for queryRobotParam method
export const queryRobotParamSchema = {
    robotUuid: z.string().optional().describe(i18n.t('schema.local.queryRobotParam.robotUuid'))
} as const;
  • src/schema/openApi.ts:39-42 (schema)
    Schema definition (robotParamSchema) for queryRobotParam in OpenAPI context, accepts optional robotUuid and accurateRobotName strings.
    export const robotParamSchema = {
    robotUuid: z.string().optional().describe(i18n.t('schema.robotParam.robotUuid')),
    accurateRobotName: z.string().optional().describe(i18n.t('schema.robotParam.accurateRobotName'))
} as const;
  • src/i18n/index.ts:1-146 (helper)
    i18n translations providing description and error messages for the queryRobotParam tool in English and Chinese.
    import i18n from 'i18next';
import { initReactI18next } from 'react-i18next';

const resources = {
  en: {
    translation: {
      // Tool descriptions
      'tool.uploadFile.description': 'This interface is used to upload files to the RPA platform.',
      'tool.queryRobotParam.description': 'This interface is used to query RPA robot parameters.',
      'tool.queryApplist.description': 'This interface is used to paginate and get the RPA application list.',
      'tool.startJob.description': 'This interface is used to start an RPA job.',
      'tool.queryJob.description': 'This interface is used to query the status of an RPA job.',
      'tool.queryClientList.description': 'This interface is used to query the list of RPA clients.',
      'tool.runApp.description': 'This interface is used to run an RPA application.',
      
      // Tool errors
      'tool.uploadFile.error': 'Failed to upload file',
      'tool.queryRobotParam.error': 'Failed to query robot parameters',
      'tool.queryApplist.error': 'Failed to get application list',
      'tool.startJob.error': 'Failed to start job',
      'tool.queryJob.error': 'Failed to query job status',
      'tool.queryClientList.error': 'Failed to query client list',
      'tool.runApp.error': 'Failed to run application',
      
      // RpaService validation errors
      'rpaService.error.fileNameTooLong': 'File name length cannot exceed 100 characters',
      'rpaService.error.unsupportedFileType': 'Only txt, csv, xlsx file types are supported',
      'rpaService.error.uploadFailed': 'File upload failed',
      'rpaService.error.robotUuidRequired': 'robotUuid is a required parameter',
      'rpaService.error.accountNameAndGroupConflict': 'accountName and robotClientGroupUuid can only choose one of them',
      'rpaService.error.waitTimeoutRange': 'waitTimeoutSeconds must be between 60 and 950400 seconds',
      'rpaService.error.runTimeoutRange': 'runTimeout must be between 60 and 950400 seconds',
      'rpaService.error.paramsLengthExceeded': 'The total length of params cannot exceed 8000',
      'rpaService.error.startJobFailed': 'Failed to start application',
      'rpaService.error.jobUuidRequired': 'jobUuid is a required parameter',
      'rpaService.error.queryJobFailed': 'Failed to query application execution result',
      'rpaService.error.pageSizeRequired': 'page and size are required parameters',
      'rpaService.error.queryClientListFailed': 'Failed to query robot list',
      
      // Schema descriptions
      'schema.uploadFile.file': 'File content',
      'schema.uploadFile.fileName': 'File name, supports txt, csv, xlsx formats, length not exceeding 100 characters',
      'schema.robotParam.robotUuid': 'RPA application uuid',
      'schema.robotParam.accurateRobotName': 'Exact match of RPA application name',
      'schema.query.appId': 'RPA application ID',
      'schema.query.size': 'Page size',
      'schema.query.sizeRefine': 'Maximum 100 items per page',
      'schema.query.page': 'Page number',
      'schema.query.ownerUserSearchKey': 'Exact match of user account',
      'schema.query.appName': 'Fuzzy match of RPA application name',
      'schema.startJob.robotUuid': 'RPA application uuid, required',
      'schema.startJob.accountName': 'Account name, the client status must be idle,mutually exclusive with robotClientGroupUuid, choose only one',
      'schema.startJob.robotClientGroupUuid': 'RPA robot group uuid, mutually exclusive with accountName, choose only one',
      'schema.startJob.waitTimeoutSeconds': 'Wait timeout (seconds)',
      'schema.startJob.waitTimeoutRefine': 'Wait timeout must be between 60 and 950400 seconds',
      'schema.startJob.runTimeout': 'Run timeout (seconds)',
      'schema.startJob.runTimeoutRefine': 'Run timeout must be between 60 and 950400 seconds',
      'schema.startJob.params': 'Run parameters',
      'schema.startJob.paramsRefine': 'Total length of params cannot exceed 8000',
      'schema.queryJob.jobUuid': 'RPA application execution uuid, required',
      'schema.clientList.status': 'Status, generally no keyword is specified to query idle robots',
      'schema.clientList.key': 'Keyword',
      'schema.clientList.robotClientGroupUuid': 'RPA robot group uuid',
      'schema.clientList.page': 'Page number',
      'schema.clientList.size': 'Page size',
      'schema.clientList.sizeRefine': 'Maximum 100 items per page'
    }
  },
  zh: {
    translation: {
      // Tool descriptions
      'tool.uploadFile.description': '该接口用于上传文件到RPA平台。',
      'tool.queryRobotParam.description': '该接口用于查询RPA机器人参数。',
      'tool.queryApplist.description': '该接口用于分页获取RPA应用列表。',
      'tool.startJob.description': '该接口用于启动RPA应用JOB。',
      'tool.queryJob.description': '该接口用于查询RPA应用JOB状态。',
      'tool.queryClientList.description': '该接口用于查询RPA机器人列表。',
      'tool.runApp.description': '该接口用于运行RPA应用。',
      
      // Tool errors
      'tool.uploadFile.error': '上传文件失败',
      'tool.queryRobotParam.error': '查询机器人参数失败',
      'tool.queryApplist.error': '获取RPA应用列表失败',
      'tool.startJob.error': '启动RPA应用JOB失败',
      'tool.queryJob.error': '查询RPA应用JOB状态失败',
      'tool.queryClientList.error': '查询RPA机器人列表失败',
      'tool.runApp.error': '运行RPA应用失败',
      
      // RpaService validation errors
      'rpaService.error.fileNameTooLong': '文件名长度不能超过100',
      'rpaService.error.unsupportedFileType': '仅支持txt、csv、xlsx文件类型',
      'rpaService.error.uploadFailed': '文件上传失败',
      'rpaService.error.robotUuidRequired': 'robotUuid是必填参数',
      'rpaService.error.accountNameAndGroupConflict': 'accountName和robotClientGroupUuid只能选择其中一个',
      'rpaService.error.waitTimeoutRange': 'waitTimeoutSeconds必须在60到950400秒之间',
      'rpaService.error.runTimeoutRange': 'runTimeout必须在60到950400秒之间',
      'rpaService.error.paramsLengthExceeded': 'params参数总长度不能超过8000',
      'rpaService.error.startJobFailed': '启动RPA应用JOB失败',
      'rpaService.error.jobUuidRequired': 'jobUuid是必填参数',
      'rpaService.error.queryJobFailed': '查询RPA应用JOB状态失败',
      'rpaService.error.pageSizeRequired': 'page和size是必填参数',
      'rpaService.error.queryClientListFailed': '查询RPA机器人列表失败',
      
      // Schema descriptions
      'schema.uploadFile.file': '文件内容',
      'schema.uploadFile.fileName': '文件名，支持txt、csv、xlsx格式，长度不超过100字符',
      'schema.robotParam.robotUuid': 'RPA应用UUID',
      'schema.robotParam.accurateRobotName': '精确匹配的RPA应用名称',
      'schema.query.appId': 'RPA应用UUID',
      'schema.query.size': '一页大小',
      'schema.query.sizeRefine': '每页最大100条',
      'schema.query.page': '页码',
      'schema.query.ownerUserSearchKey': '用户账号精确匹配',
      'schema.query.appName': 'RPA应用名称模糊匹配',
      'schema.startJob.robotUuid': 'RPA应用uuid，必填',
      'schema.startJob.accountName': 'RPA机器人账号名称,要求机器人的状态为idle,和robotClientGroupUuid互斥，二选一即可',
      'schema.startJob.robotClientGroupUuid': 'RPA机器人组uuid,和accountName互斥，二选一即可',
      'schema.startJob.waitTimeoutSeconds': '等待超时时间（秒）',
      'schema.startJob.waitTimeoutRefine': '等待超时时间必须在60到950400秒之间',
      'schema.startJob.runTimeout': '运行超时时间（秒）',
      'schema.startJob.runTimeoutRefine': '运行超时时间必须在60到950400秒之间',
      'schema.startJob.params': '运行参数',
      'schema.startJob.paramsRefine': 'params参数总长度不能超过8000',
      'schema.queryJob.jobUuid': 'RPA应用运行uuid，必填',
      'schema.clientList.status': '状态,idle表示空闲,一般不指定关键字的情况下都是要查询空闲的机器人',
      'schema.clientList.key': '关键字',
      'schema.clientList.robotClientGroupUuid': 'RPA机器人组uuid',
      'schema.clientList.page': '页码',
      'schema.clientList.size': '一页大小',
      'schema.clientList.sizeRefine': '每页最大100条'
    }
  }
};

i18n
  .use(initReactI18next)
  .init({
    resources,
    lng: 'zh',
    fallbackLng: 'en',
    interpolation: {
      escapeValue: false
    }
  });

export default i18n;

Tool Definition Quality

C2.9/5.0
Behavior2/5

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

No annotations are provided, so the description must bear full weight. It only indicates a read operation ('query') but lacks details on side effects, authorization needs, or behavioral constraints. The agent is left uninformed about what the tool does beyond the basic query.

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 description is a single concise sentence without superfluous information. It is front-loaded with the purpose, but being in Chinese may slightly hinder quick parsing by an English-oriented agent.

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

Completeness2/5

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

Given the tool has no output schema, the description fails to explain what the query returns. For a data retrieval tool, this is a significant gap. The description is too minimal to provide complete context for the agent.

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%, with both parameters already described in the schema. The tool's description adds no additional meaning beyond the schema, so a baseline score of 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 tool queries RPA robot parameters, using a specific verb and resource. It distinguishes from sibling tools like queryApplist and queryClientList, which target different resources. However, the description is in Chinese, which may reduce clarity for an English-preferring AI agent.

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 versus alternatives, nor any indication of prerequisites or context. The description simply states its function without helping the agent decide between queryRobotParam and sibling tools.

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