关键词

自动化编排规则引擎AI助手工具集成工作流平台

使用说明

项目简介

RuleGo-Server 是一个基于 RuleGo 构建的轻量级、高性能、模块化和易于集成的自动化工作流平台。它不仅可以用于自动化编排、iPaaS、API 编排和数据处理等多种场景，还通过支持 MCP 协议，为 AI 助手提供强大的工具扩展能力，实现与应用系统的深度集成。

主要功能点

  • MCP 协议支持： RuleGo-Server 实现了 Model Context Protocol (MCP) 服务器，能够以标准化的方式向 LLM 客户端提供上下文信息和功能，使 AI 助手能够直接调用平台的功能。
  • 自动化工作流编排： 提供可视化界面和低代码方式进行规则链（工作流）的设计、管理和执行。
  • 丰富的组件库： 内置超过 100 种组件，并支持动态安装组件市场和规则链市场的组件，方便用户扩展功能。
  • AI 助手集成： 自动将注册的组件、规则链和 API 转化为 MCP 工具，供 AI 助手（如 Windsurf、Cursor、Codeium 等）调用。
  • 多租户支持： 支持多用户环境，每个用户拥有独立的工作流数据，保障数据隔离和安全。
  • 灵活的 HTTP API： 提供完善的 HTTP API 接口，方便与现有系统集成和管理。

安装步骤

  1. 下载仓库： 从 GitHub 克隆 RuleGo-Server 仓库到本地。 
    git clone https://github.com/rulego/rulego-server.git
cd rulego-server
  2. 编译服务器： 进入 'cmd/server' 目录，使用 Go 编译服务器程序。 
    cd cmd/server
go build .
    如果需要包含扩展组件，可以使用 'tags' 进行编译，例如包含 AI 扩展组件： 
    go build -tags with_ai .
  3. 启动服务器： 编译成功后，运行服务器程序，并指定配置文件路径。 
    ./server -c="./config.conf"
    或者在后台运行： 
    nohup ./server -c="./config.conf" >> console.log &

服务器配置

MCP 服务器配置位于 'config.conf' 文件的 '[mcp]' सेक्शन。以下是 MCP 客户端连接和使用 RuleGo-Server MCP 服务器所需的配置信息（JSON 格式）：

{
  "serverName": "RuleGo-Server MCP Server",  // MCP 服务器名称，可自定义
  "command": "./server",                    // MCP 服务器启动命令，根据实际路径调整
  "args": ["-c", "./config.conf"],         // 启动参数，指定配置文件路径
  "transport": "sse",                       // 传输协议，RuleGo-Server MCP 服务器默认支持 SSE
  "apiKey": "YOUR_API_KEY"                  // API 密钥，用于身份验证，需要替换为实际用户的 API Key
}

参数注释：

  • 'serverName': MCP 服务器的名称，客户端显示用，可以自定义。
  • 'command': 启动 RuleGo-Server 服务器的可执行文件路径，根据实际编译后的文件位置填写。
  • 'args': 启动 RuleGo-Server 服务器的命令行参数，'-c' 参数指定配置文件路径，请确保指向正确的 'config.conf' 文件。
  • 'transport': 指定 MCP 客户端与服务器通信的传输协议，RuleGo-Server MCP 服务器支持 SSE (Server-Sent Events)。
  • 'apiKey': 重要，用于 MCP 客户端身份验证的 API 密钥。需要替换为 RuleGo-Server 中配置用户的实际 API Key。 可以在 'config.conf' 文件的 '[users]' 部分配置用户及其 API Key，例如： 
    [users]
admin = admin,YOUR_API_KEY
    请将 'YOUR_API_KEY' 替换为您设置的 API Key，并在客户端配置中使用 'admin' 用户的 API Key。

基本使用方法

  1. 配置 MCP 客户端： 在 MCP 客户端中，配置上述 JSON 格式的服务器连接信息，并确保 'apiKey' 配置正确。
  2. 连接 MCP 服务器： 启动 RuleGo-Server 后，MCP 客户端应能成功连接到服务器。
  3. 发现和调用工具： MCP 客户端连接成功后，可以发现 RuleGo-Server 提供的 MCP 工具，这些工具包括：
    • 组件工具： RuleGo-Server 注册的内置和扩展组件，例如 'delay', 'log', 'dbClient' 等，可以直接被 AI 助手调用执行特定功能。
    • 规则链工具： 用户在 RuleGo-Server 中创建的规则链，可以作为工具被 AI 助手调用，执行复杂的工作流逻辑。
    • API 工具： RuleGo-Server 提供的规则链管理 API，例如 'listRuleChain', 'saveRuleChain', 'executeRuleChain' 等，允许 AI 助手进行规则链的查询、创建、执行等操作。
  4. 通过 AI 助手调用工具： 在支持 MCP 协议的 AI 助手（如 Windsurf、Cursor、Codeium 等）中，即可通过自然语言指令调用 RuleGo-Server 提供的工具，实现与后端应用系统的集成和交互。

注意：

  • 确保 'config.conf' 文件中 '[mcp]' 部分的 'enable = true'，以启用 MCP 服务。
  • 根据实际需求配置 '[mcp]' 部分的其他参数，例如 'load_components_as_tool', 'load_chains_as_tool', 'load_apis_as_tool' 等，以控制哪些功能作为 MCP 工具暴露给 AI 助手。
  • 详细的 MCP 工具列表和使用方法，请参考 RuleGo-Server 的官方文档和 MCP 客户端的相关文档。

信息

分类

开发者工具

访问项目