关键词

Workato自动化API集成工作流连接器

使用说明

项目简介

Workato MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在为 LLM (大型语言模型) 客户端提供与 Workato API 交互的能力。通过此服务器，LLM 客户端可以调用 Workato 的各种功能，例如管理自动化工作流 (Recipes)、连接器 (Connections 和 Connectors) 等，从而实现更智能的自动化任务编排和管理。

主要功能点

  • 自动化工作流 (Recipes) 管理: 支持列出、创建、启动和停止 Workato 中的自动化工作流，以及监控工作流的执行情况。
  • 连接器 (Connections) 管理: 允许列出和创建 Workato 连接器，查看连接详情和状态，管理连接配置。
  • 连接器 (Connectors) 发现: 能够列出可用的 Workato 连接器及其功能，查看连接器的元数据和支持的操作。
  • 文件夹和项目组织: 支持创建和管理 Workato 中的文件夹和项目，帮助用户组织和管理自动化资源。
  • 任务 (Job) 管理: 可以查看特定工作流的任务执行记录，获取任务详情，以及恢复暂停的任务。

安装步骤

  1. 克隆仓库 
    git clone https://github.com/jacobgoren-sb/workato-mpc-server.git
cd workato-mpc-server
  2. 安装依赖 使用 npm 或 yarn 安装项目依赖： 
    npm install
# 或
yarn install
  3. 构建服务器 编译 TypeScript 代码生成 JavaScript 文件： 
    npm run build

服务器配置

要将 Workato MCP Server 添加到 MCP 客户端（例如 Cursor 或 Claude Desktop），您需要提供以下配置信息。以下是使用 JSON 格式的配置示例，通常在 MCP 客户端的设置中添加新的 MCP 服务器时使用，或者在项目配置文件中指定。

{
  "serverName": "workato-tools",  // MCP 服务器的名称，可以自定义
  "command": "node",           // 启动服务器的命令，这里使用 Node.js 运行 JavaScript 文件
  "args": ["/path/to/your/project/dist/server.js"], // 启动命令的参数，指向编译后的 server.js 文件路径，请替换为实际路径
  "type": "stdio",             // 指定 MCP 服务器的传输类型为 stdio (标准输入输出)
  "env": {
    "WORKATO_API_TOKEN": "YOUR_WORKATO_API_TOKEN"  // 环境变量，用于存储 Workato API 访问令牌，请替换为您的实际令牌
  }
}

配置参数说明:

  • 'serverName': 为您的 MCP 服务器指定一个名称，例如 "workato-tools"，在 MCP 客户端中用于标识和管理该服务器。
  • 'command': 指定用于启动 MCP 服务器的命令。由于该服务器是 Node.js 应用，所以这里使用 'node' 命令。
  • 'args': 一个字符串数组，包含启动命令的参数。
    • '"/path/to/your/project/dist/server.js"': 请务必替换为 'server.js' 文件在您本地文件系统中的绝对路径。 'server.js' 文件是项目构建后生成的服务器入口文件，位于 'dist' 目录下。
  • 'type': 指定 MCP 服务器使用的传输协议类型。 'stdio' 表示使用标准输入和标准输出进行通信，这是该服务器实现的传输方式。
  • 'env': 一个 JSON 对象，用于设置 MCP 服务器运行所需的环境变量。
    • 'WORKATO_API_TOKEN': 请务必替换为您的 Workato API 访问令牌。 这是服务器连接 Workato API 的凭证，需要在 Workato 平台获取。

配置位置:

  • Cursor: 在 Cursor 编辑器的设置 ('Cursor Settings > Features > MCP') 中，点击 "Add New MCP Server"，然后根据上述 JSON 配置填写表单。
  • Claude Desktop: 编辑 Claude Desktop 的配置文件 ('claude_desktop_config.json')，在 'mcp_servers' 字段下添加上述 JSON 配置。配置文件的路径根据操作系统有所不同 (macOS, Windows, Linux)。

基本使用方法

  1. 启动 MCP 服务器: 配置完成后，MCP 客户端（如 Cursor 或 Claude Desktop）会自动或手动启动 Workato MCP Server。服务器将在后台运行，并监听来自客户端的 MCP 请求。
  2. 在 LLM 客户端中使用工具: 在支持 MCP 协议的 LLM 客户端中，您可以像使用其他工具一样调用 Workato MCP Server 提供的功能。例如，您可以指示 LLM 列出 Workato 中的 Recipes，创建新的 Connections，或者启动特定的自动化工作流。 具体的工具名称和参数请参考仓库 'README.md' 文件中 "🛠️ Available Tools" 部分的描述。
  3. 身份验证: 确保您已正确配置 'WORKATO_API_TOKEN' 环境变量。服务器将使用此令牌向 Workato API 进行身份验证。

示例工具调用 (在 LLM 客户端中)

  • 列出 Recipes: 'list-recipes'
  • 创建 Connection: 'create-connection'
  • 启动 Recipe: 'start-recipe recipe_id: 12345' (假设 recipe_id 为 12345)

请查阅仓库 'README.md' 和 'src/server.ts' 文件以获取更详细的工具列表、参数说明和使用示例。

信息

分类

商业系统

访问项目