RuleGo
目录

MCP 服务

RuleGo-Server 支持 MCP（Model Context Protocol，模型上下文协议），开启后系统自动将管理 API 注册为 MCP 工具，组件和规则链可通过分组配置按需暴露，使 AI 助手（Claude Code、Cursor、Windsurf 等）能够直接操作规则链和调用组件。

# 什么是 MCP

MCP 是一种标准化协议，为 AI 提供了对应用系统的上下文感知能力，不仅仅是代码补全或问答。MCP 的作用类似于 USB-C 接口——为 AI 提供标准化的方式连接数据源和工具。

# 配置

[mcp]
# 是否启用 MCP 服务
enable = true
1
2
3

# 用户配置

使用 MCP 需要为用户配置 apiKey：

[users]
admin = admin,ak-2af255ea5618467d914c67a8beeca31d
user01 = user01,ak-another-key
1
2
3

# MCP 端点

# 默认端点（所有工具）

http://{host}:{port}/api/v1/mcp/{apiKey}
1

# 分组端点（工具子集）

http://{host}:{port}/api/v1/mcp/{apiKey}/group/{groupName}
1

启动成功后，控制台会打印 MCP 地址：

RuleGo-Server mcp server running at http://127.0.0.1:9090/api/v1/mcp/ak-xxx
1

# 认证方式

MCP 端点支持三种认证方式（按优先级）：

方式 格式
URL 路径参数 /api/v1/mcp/{apiKey}
Authorization 头 Authorization: Bearer {apiKey}
X-API-Key 头 X-API-Key: {apiKey}

# 工具类型

MCP 默认端点注册管理 API 工具，组件和规则链工具通过分组配置暴露。

# 1. 管理 API 工具（默认端点）

工具名 功能 必填参数
list_rule_chains 列出/搜索规则链 无（可选 keywords、root、disabled、page、size）
get_rule_chain 获取规则链定义 id
preview_rule_chain 预览规则链（不保存） id、body
save_rule_chain 创建/更新规则链 id、body
delete_rule_chain 删除规则链 id
operate_rule_chain 部署/停止规则链 id、action（deploy/undeploy）
execute_rule_chain 执行规则链 id、message
list_components 列出可用组件 无（可选 category）
get_component_doc 获取组件文档 type（可选 types 数组批量查询）
list_node_pool 列出共享节点池 无

# 2. 组件工具（通过分组暴露）

通过分组配置将 RuleGo 组件注册为 MCP 工具，工具名即组件类型名。

参数从组件的表单定义（ComponentForm.Fields）自动生成，包含名称、类型、描述、默认值和是否必填。

示例：调用 restApiCall 组件发起 HTTP 请求、调用 dbClient 组件查询数据库。

# 3. 规则链工具（通过分组暴露）

通过分组配置将已部署的规则链注册为 MCP 工具，工具名即规则链 ID。

参数来源（按优先级）：

  1. 规则链的 additionalInfo.inputSchema
  2. DSL 模板变量解析
  3. 默认 inMessage 对象参数

规则链工具的变更会实时同步（新建、更新、删除自动反映到工具列表）。

# 分组控制

通过 [mcp.groups] 配置工具分组，实现权限控制。组件和规则链工具仅通过分组端点暴露。

[mcp.groups]
# 只读组：仅包含管理工具中的查看类操作和组件文档
readonly = rules,list_components,get_component_doc

# 完整权限
full = *

# 禁止删除
no-delete = *,-delete_rule_chain
1
2
3
4
5
6
7
8
9

分组语法：

  • *：包含所有工具
  • -prefix*：排除匹配前缀的工具（如 -delete_*）
  • 精确工具名：只包含指定工具
  • rules：包含所有管理 API 工具
  • components：包含所有组件工具
  • chains：包含所有规则链工具

每个用户默认有一个 default 分组，包含所有工具。

# 接入 AI 客户端

# Claude Code

编辑 ~/.claude/settings.json：

{
  "mcpServers": {
    "rulego": {
      "type": "streamableHttp",
      "url": "http://localhost:9090/api/v1/mcp/ak-your-secret-key"
    }
  }
}
1
2
3
4
5
6
7
8

详细使用示例参见 AI 功能。

# Cursor

在 Cursor 设置的 MCP 配置中添加：

{
  "mcpServers": {
    "rulego": {
      "url": "http://localhost:9090/api/v1/mcp/ak-your-secret-key"
    }
  }
}
1
2
3
4
5
6
7

# Trae

在 Trae 的 MCP 设置中添加（Builder > MCP > 添加）：

{
  "mcpServers": {
    "rulego": {
      "type": "streamableHttp",
      "url": "http://localhost:9090/api/v1/mcp/ak-your-secret-key"
    }
  }
}
1
2
3
4
5
6
7
8

# Cherry Studio

  1. 打开 Cherry Studio 设置 → "MCP 服务器"
  2. 点击 "添加服务器"
  3. 填写：
    • 名称：rulego-server
    • 类型：StreamableHTTP
    • URL：http://127.0.0.1:9090/api/v1/mcp/ak-your-secret-key

# 通过编辑器创建自定义 MCP 端点

除了系统级 MCP 服务，还可以通过规则链创建独立的 MCP Server 端点。一个规则链即一个 MCP 服务器，所有工具配置和处理逻辑均在规则链中完成，支持实时更新。

适用场景：需要精细控制工具集、独立部署 MCP 端点、或为不同 AI 客户端提供不同工具集。

# 操作步骤

  1. 打开 RuleGo-Editor，新建规则链，将【MCP服务器】节点拖入画布 mcp_server.png
  2. 配置服务器端口（可复用默认 HTTP 服务器端口 ref://:9090） config.png
  3. 配置路由设置，每个路由代表一个 MCP 工具 tool_list.png
  4. 点击【新增】按钮，配置工具标识、描述和输入 JsonSchema tool_config.png
  5. 将工具实现的逻辑节点拖入画布，将工具标识与处理节点连线 tool_link.png
  6. 在【设置】-【集成】中复制 MCP SSE 地址，用于客户端测试 sse_url.png
  7. 在 AI 客户端中配置该地址即可使用 trae_mcp.png

# 示例：温度转换工具

{
  "ruleChain": {
    "id": "temp-converter",
    "name": "温度转换MCP服务",
    "root": true
  },
  "metadata": {
    "endpoints": [{
      "id": "ep1",
      "type": "endpoint/mcpServer",
      "name": "MCP服务器",
      "configuration": {
        "allowCors": true,
        "name": "温度转换服务",
        "server": "ref://:9090",
        "version": "v1.0.0"
      },
      "routers": [{
        "id": "r1",
        "params": ["传入转换系数转换温度", "{\"type\":\"object\",\"properties\":{\"scaleFactor\":{\"type\":\"number\",\"title\":\"换算系数\",\"default\":1.8}},\"required\":[\"scaleFactor\"]}"],
        "from": {"path": "transformText"},
        "to": {"path": "temp-converter:node_js"}
      }]
    }],
    "nodes": [{
      "id": "node_js",
      "type": "jsTransform",
      "name": "转换温度",
      "configuration": {
        "jsScript": "var newMsg=msg||{}; newMsg.value=msg.from||'test01'; return {'msg':newMsg,'metadata':metadata,'msgType':msgType};"
      }
    }],
    "connections": []
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

更多组件配置细节参见 MCP 服务端 组件文档。

# 核心价值

  1. 增强 AI 对业务逻辑的理解：AI 通过规则链工具深入理解业务流程
  2. 智能自动化决策：AI 获取实时数据并结合规则进行决策
  3. 扩展智能体边界：通过组件和规则链无限扩展 AI 能力
  4. 跨系统集成：RuleGo-Server 作为中间层封装数据源和工具
  5. 应用交互新范式：业务系统快速封装为 MCP 工具，打通 AI 与应用的最后一公里
在 GitHub 上编辑此页 (opens new window)
上次更新: 2026/05/30, 11:18:53
REST API 参考
AI 功能

← AI 功能→

Theme by Vdoing | Copyright © 2023-2026 RuleGo Team | Apache 2.0 License