项目简介
该项目是影刀RPA基于 Model Context Protocol (MCP) 实现的服务器。它允许支持MCP协议的LLM客户端(如影刀AI Power、Claude Desktop、Cursor等)发现并调用影刀RPA的能力,实现LLM与RPA自动化流程的集成。
主要功能点
该服务器根据配置(本地模式或开放API模式)提供以下能力(工具):
- 查询RPA应用列表: 获取用户可用的RPA自动化应用列表。
- 查询RPA应用参数: 获取指定RPA应用的输入/输出参数信息。
- 运行RPA应用 (本地模式): 在本地运行指定的RPA自动化应用。
- 上传文件 (开放API模式): 上传文件至影刀RPA平台供自动化流程使用。
- 启动RPA作业 (开放API模式): 启动云端或指定机器人上的RPA自动化作业。
- 查询RPA作业状态 (开放API模式): 查询已启动RPA作业的当前状态和结果。
- 查询RPA机器人列表 (开放API模式): 获取可用于调度的RPA机器人列表。
安装步骤
- 克隆仓库:
git clone https://github.com/ying-dao/yingdao-mcp-server.git cd yingdao-mcp-server - 安装依赖:
npm install - 构建项目:
npm run build
服务器配置
MCP服务器的配置通常需要在MCP客户端(LLM应用)中完成。根据你的需求选择运行模式(本地模式或开放API模式),并在客户端配置相应的启动命令或URL。
服务器端自身启动前需要设置的环境变量:
- 选择模式: 'RPA_MODEL' 环境变量,设为 'local' 或 'openApi'。
- 本地模式 (RPA_MODEL=local) 必需:
- 'SHADOWBOT_PATH': 影刀RPA主程序 ('ShadowBot.exe' 或 macOS 下的执行文件) 的完整路径。
- 'USER_FOLDER': 影刀RPA的用户文件夹路径,可在影刀设置中查看。
- 开放API模式 (RPA_MODEL=openApi) 必需:
- 'ACCESS_KEY_ID': 影刀RPA开放平台的Access Key ID。
- 'ACCESS_KEY_SECRET': 影刀RPA开放平台的Access Key Secret。
- 语言 (可选): 'LANGUAGE' 环境变量,设为 'zh' (中文) 或 'en' (英文),默认中文。
MCP客户端中的配置示例 (JSON格式):
此配置位于MCP客户端的特定位置,指导客户端如何启动和连接到MCP服务器。
-
Stdio模式配置:
{ "mcpServers": { "YingDao RPA MCP Server": { "command": "npx", // 启动命令,这里使用npx直接运行已发布的npm包 "args": ["-y", "yingdao-mcp-server"], // 启动参数,yingdao-mcp-server是npm包名 "env":{ // 传递给MCP服务器进程的环境变量 "RPA_MODEL":"openApi", // 或 "local" "ACCESS_KEY_ID":"{你的Access Key ID}", // 开放API模式需要 "ACCESS_KEY_SECRET":"{你的Access Key Secret}" // 开放API模式需要 // 如果是local模式,这里需要配置 SHADOWBOT_PATH 和 USER_FOLDER // "SHADOWBOT_PATH":"{你的影刀exe路径}", // 本地模式需要 // "USER_FOLDER":"{你的影刀用户文件夹路径}" // 本地模式需要 } } } }说明: Stdio模式下,客户端直接通过标准输入/输出与服务器进程通信。客户端负责启动服务器进程并传递必要的环境变量。
-
SSE模式配置:
- 先手动启动服务器: 在服务器代码目录下,创建一个'.env'文件,配置上面提到的环境变量('RPA_MODEL' 及对应的路径或密钥)。然后运行:
服务器默认监听3000端口。npm run start:server - 客户端配置:
{ "mcpServers": { "YingDao RPA MCP Server": { "url": "http://localhost:3000/sse", // MCP服务器的SSE接口地址 "description": "影刀 MCP Server" // 服务器描述 } } }
说明: SSE模式下,MCP服务器作为一个独立的HTTP服务运行。客户端通过HTTP连接到服务器的SSE接口进行通信。
- 先手动启动服务器: 在服务器代码目录下,创建一个'.env'文件,配置上面提到的环境变量('RPA_MODEL' 及对应的路径或密钥)。然后运行:
基本使用方法
在MCP客户端中完成上述配置后,客户端即可发现“YingDao RPA MCP Server”以及其声明的工具能力。用户可以通过LLM与客户端交互,触发对RPA工具的调用(例如,通过自然语言让LLM查询可用的RPA应用列表,或者启动一个RPA作业),从而将RPA自动化集成到LLM应用中。具体如何通过LLM触发工具调用取决于客户端的设计。
信息
分类
开发者工具