使用说明

项目简介

Workato MCP服务器是一个基于Model Context Protocol (MCP) 构建的应用后端，旨在作为 Cursor 或 Claude 等 LLM 客户端的插件，提供与 Workato 自动化平台集成的能力。通过该服务器，用户可以使用自然语言指令，在 LLM 环境中直接调用 Workato 的 API 工具，实现工作流程的自动化管理，例如查看、创建、启动、停止 Recipes (自动化工作流程)、管理 Connections (连接器)、浏览 Connectors (连接器应用) 等。

主要功能点

Recipe 管理: 列出、创建、启动和停止 Workato Recipes，监控执行状态。
Connection 管理: 列出和创建 Workato Connections，查看连接详情。
Connector 发现: 列出可用的 Workato Connectors 及其功能。
文件夹和项目组织: 管理 Workato 文件夹和项目。
活动日志: 查看 Workato 工作区内的活动日志。
标签管理: 管理 Workato 标签，包括创建、更新、删除和应用标签。
作业管理: 查看 Recipe 的作业信息，包括作业状态和详情。
API 端点管理: 列出 Workato API 端点。

安装步骤

克隆仓库：将 GitHub 仓库 'https://github.com/jacobgoren-sb/workato-mcp-server' 克隆到本地。

安装依赖：在项目根目录下运行以下命令安装项目依赖。

npm install
# 或
yarn install

构建服务器：运行以下命令构建服务器代码。
```
npm run build
```
构建成功后，将在 'dist' 目录下生成 'server.js' 文件。

服务器配置

要将 Workato MCP 服务器添加到 Cursor 或 Claude，您需要配置 MCP 服务器的启动命令。以下是配置信息，请根据您的实际项目路径进行调整。

Cursor 配置:

在 Cursor 中，打开设置 (Settings) > Features > MCP，点击 "+ Add New MCP Server" 添加新的 MCP 服务器，填写以下信息：

{
  "serverName": "workato-tools",
  "type": "stdio",
  "command": "node",
  "args": ["/path/to/your/project/dist/server.js"],
  "environmentVariables": [
    {
      "name": "WORKATO_API_TOKEN",
      "value": "your_workato_api_token"  // 替换为您的 Workato API Token
    }
  ]
}

Claude Desktop 配置:

编辑 Claude Desktop 的配置文件 ( 'claude_desktop_config.json' )，在 'mcp_servers' 字段下添加以下配置：

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%\Claude\claude_desktop_config.json'
Linux: '~/.config/Claude/claude_desktop_config.json'

{
  "mcp_servers": {
    "workato-tools": {
      "command": "node",
      "args": ["/path/to/your/project/dist/server.js"],
      "env": {
        "WORKATO_API_TOKEN": "your_workato_api_token" // 替换为您的 Workato API Token
      }
    }
  }
}

配置参数说明:

'"serverName": "workato-tools"': MCP 服务器的名称，可以自定义。
'"type": "stdio"': 指定 MCP 服务器使用 Stdio 传输协议。
'"command": "node"': 启动 MCP 服务器的命令，这里使用 Node.js 运行时。
'"args": ["/path/to/your/project/dist/server.js"]': 命令参数，指向构建后的 'server.js' 文件路径。 请将 '/path/to/your/project/dist/server.js' 替换为实际的项目 'dist/server.js' 文件的绝对路径。
'"environmentVariables"' 或 '"env"': 环境变量配置，用于设置 Workato API Token。
- '"WORKATO_API_TOKEN"': Workato API Token 的环境变量名。
- '"your_workato_api_token"': 请将 '"your_workato_api_token"' 替换为您在 Workato 平台生成的 API Token。 API Token 用于服务器访问 Workato API 的身份验证。

注意: 请确保您已安装 Node.js 环境，并且拥有有效的 Workato API Token。

基本使用方法

配置完成后，在 Cursor 或 Claude 中，您可以使用自然语言配合 '@tool_code' 语法来调用 Workato 的工具。例如：

'@list-recipes' - 列出 Workato 中的 Recipes。
'@list-connections' - 列出 Workato 中的 Connections。
'@start-recipe recipe_id:123' - 启动 ID 为 123 的 Recipe。

您可以参考 "Available Tools" 章节了解更多可用的工具及其参数，并在 LLM 对话中灵活使用。工具的返回结果将会以 JSON 格式显示在对话中。

关键词