This is an automated email from the ASF dual-hosted git repository.
xiaoyu pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/shenyu-website.git
The following commit(s) were added to refs/heads/main by this push:
new f22e5816d73 fea:plugin center mcp plugin (#1094)
f22e5816d73 is described below
commit f22e5816d7376327743c01e12d888ba7c00b2d0a
Author: Yu Siheng <[email protected]>
AuthorDate: Wed Nov 12 10:05:27 2025 +0800
fea:plugin center mcp plugin (#1094)
---
docs/plugin-center/mcp/_category_.json | 4 ++
docs/plugin-center/mcp/mcp-server-plugin.md | 65 +++++++++++++++++++++
.../plugin-center/mcp/_category_.json | 4 ++
.../plugin-center/mcp/mcp-server-plugin.md | 65 +++++++++++++++++++++
static/img/shenyu/plugin/mcpServer/disable.png | Bin 0 -> 127500 bytes
.../plugin/mcpServer/mcp_client_config_en.png | Bin 0 -> 93627 bytes
.../plugin/mcpServer/mcp_client_config_zh.png | Bin 0 -> 87338 bytes
.../img/shenyu/plugin/mcpServer/request_config.png | Bin 0 -> 61237 bytes
.../img/shenyu/plugin/mcpServer/selector_new.png | Bin 0 -> 48388 bytes
static/img/shenyu/plugin/mcpServer/tool_config.png | Bin 0 -> 58561 bytes
.../plugin-center/mcp/_category_.json | 4 ++
.../plugin-center/mcp/mcp-server-plugin.md | 65 +++++++++++++++++++++
12 files changed, 207 insertions(+)
diff --git a/docs/plugin-center/mcp/_category_.json
b/docs/plugin-center/mcp/_category_.json
new file mode 100644
index 00000000000..cbf4b734107
--- /dev/null
+++ b/docs/plugin-center/mcp/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Mcp",
+ "position": 10
+}
diff --git a/docs/plugin-center/mcp/mcp-server-plugin.md
b/docs/plugin-center/mcp/mcp-server-plugin.md
new file mode 100644
index 00000000000..0183251db63
--- /dev/null
+++ b/docs/plugin-center/mcp/mcp-server-plugin.md
@@ -0,0 +1,65 @@
+---
+title: McpServer Plugin
+keywords: ["mcpServer"]
+description: mcp Server Plugin
+---
+
+## Explanation
+
+* The `mcpServer` plugin is used to enable the `mcpServer` functionality in
the ShenYu gateway. After enabling this plugin, users can register `Tools` for
unified management by the gateway.
+
+* The `mcpServer` plugin must be used together with a `proxy` plugin to enable
Tool invocation.
+
+## Plugin Setting
+
+* To add the necessary dependencies and enable the plugin, please refer to:
[Quick Start with McpServer](../../quick-start/quick-start-mcpServer).
+
+* For McpTool client integration, please refer to: [McpTool Service
Integration](../../user-guide/proxy/mcp-tool-proxy.md).
+
+* For selector and rule configuration, please refer to: [Selector and Rule
Management](../../user-guide/admin-usage/selector-and-rule).
+
+## Plugin Details
+
+After the client is connected to the `Apache ShenYu` gateway, selector and
rule information will be automatically registered. For details about selector
and rule configuration, please refer to: [Selector and Rule
Management](../../user-guide/admin-usage/selector-and-rule).
+
+#### Selector Handling
+
+<img src="/img/shenyu/plugin/mcpServer/selector_new.png" width="80%"
height="80%" />
+
+For selector handling, the current version only supports the `startWith`
condition in `Condition`. The `endpoint` is equal to the gateway route plus the
URL configured in `Condition` and the request protocol (sse/streamablehttp).
+
+Click "SSE Configuration" or "Streamable Configuration" to enter the JSON
editing page, which helps users conveniently edit the JSON configuration
required by the Mcp client.
+
+<img src="/img/shenyu/plugin/mcpServer/mcp_client_config_en.png" width="80%"
height="80%" />
+
+#### Tool Handling
+
+<img src="/img/shenyu/plugin/mcpServer/tool_config.png" width="80%"
height="80%" />
+
+<img src="/img/shenyu/plugin/mcpServer/request_config.png" width="80%"
height="80%" />
+
+Tool handling refers to the `handle` field, which allows you to perform
operations after the gateway has completed traffic matching. For more
information, please refer to [Plugin Handle
Explanation](../../user-guide/admin-usage/plugin-handle-explanation) in plugin
management.
+
+* Details of tool configuration:
+
+ * `Description`: Defines the purpose of the tool.
+
+ * `Parameter`: Defines the type of parameters required by the tool.
+
+* Details of requestConfig configuration:
+
+ * `url`: Defines context-path + the actual URL of the tool.
+
+ * `method`: Defines the request type of the tool method.
+
+ * `argsPosition`: Defines the correspondence between all parameters and
their positions.
+
+ * `argsToJsonBody`: If true, all parameters will be added to the body.
+
+ * `headers`: You can add headers required by the Tool here.
+
+## How to disable plugin
+
+- In `shenyu-admin` --> Basic Configuration --> Plugin Management --> set
`mcpServer` to disabled.
+
+
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/_category_.json
b/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/_category_.json
new file mode 100644
index 00000000000..07a88c5823c
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "mcp",
+ "position": 10
+}
\ No newline at end of file
diff --git
a/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
b/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
new file mode 100644
index 00000000000..90b537872b8
--- /dev/null
+++
b/i18n/zh/docusaurus-plugin-content-docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
@@ -0,0 +1,65 @@
+---
+title: McpServer插件
+keywords: ["mcpServer"]
+description: mcp Server插件
+---
+
+## 说明
+
+* `mcpServer`插件是启动 Shenyu 网关`mcpServer`功能的插件，启动该插件后，允许用户将`Tool`注册到网关统一管理。
+
+* `mcpServer`插件需要配合`proxy`插件才能实现`Tool`的调用。
+
+## 插件设置
+
+* 引入相关依赖，开启插件，请参考：[McpServer快速开始](../../quick-start/quick-start-mcpServer) 。
+
+* `McpTool`客户端接入，请参考：[McpTool服务接入](../../user-guide/proxy/mcp-tool-proxy.md) 。
+
+* 选择器和规则配置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)。
+
+## 插件详解
+
+客户端接入`Apache
ShenYu`网关后，会自动注册选择器和规则信息，关于选择器和规则配置，请参考：[选择器和规则管理](../../user-guide/admin-usage/selector-and-rule)
。
+
+#### 选择器处理
+
+<img src="/img/shenyu/plugin/mcpServer/selector_new.png" width="80%"
height="80%" />
+
+选择器处理，在当前版本仅支持`Condition`中的条件为startWith，`endpoint`等于网关路由加`Condition`配置的url加请求协议sse/streamablehttp
+
+点击 SSE配置 Streamable配置 可以进入Json编辑页面，可以更方便的帮助用户编辑Mcp客户端需要使用的Json配置
+
+<img src="/img/shenyu/plugin/mcpServer/mcpclient_config_zh.png" width="80%"
height="80%" />
+
+#### 工具处理
+
+<img src="/img/shenyu/plugin/mcpServer/tool_config.png" width="80%"
height="80%" />
+
+<img src="/img/shenyu/plugin/mcpServer/request_config.png" width="80%"
height="80%" />
+
+工具处理，即`handle`字段，是网关对流量完成最终匹配后，可以进行处理的操作。更多信息请参考插件管理中的
[插件处理管理](../../user-guide/admin-usage/plugin-handle-explanation) 。
+
+* tool配置详解：
+
+ * `Description`：定义了工具的用途。
+
+ * `Parameter`： 定义了工具需要的参数类型
+
+* requestConfig配置详解
+
+ * `url`：定义了context-path + 工具真实url
+
+ * `method`：定义了工具方法的请求类型
+
+ * `argsPosition`：定义了所有参数和参数位置的对应关系
+
+ * `argsToJsonBody`：如果为true则会将所有参数添加到body中
+
+ * `headers`：可以在此处添加Tool需要的header
+
+## 如何禁用插件
+
+- 在 `shenyu-admin` --> 基础配置 --> 插件管理 --> `mcpServer` 设置为禁用。
+
+
diff --git a/static/img/shenyu/plugin/mcpServer/disable.png
b/static/img/shenyu/plugin/mcpServer/disable.png
new file mode 100644
index 00000000000..aec3abcbde8
Binary files /dev/null and b/static/img/shenyu/plugin/mcpServer/disable.png
differ
diff --git a/static/img/shenyu/plugin/mcpServer/mcp_client_config_en.png
b/static/img/shenyu/plugin/mcpServer/mcp_client_config_en.png
new file mode 100644
index 00000000000..0191616a465
Binary files /dev/null and
b/static/img/shenyu/plugin/mcpServer/mcp_client_config_en.png differ
diff --git a/static/img/shenyu/plugin/mcpServer/mcp_client_config_zh.png
b/static/img/shenyu/plugin/mcpServer/mcp_client_config_zh.png
new file mode 100644
index 00000000000..6f0a0964856
Binary files /dev/null and
b/static/img/shenyu/plugin/mcpServer/mcp_client_config_zh.png differ
diff --git a/static/img/shenyu/plugin/mcpServer/request_config.png
b/static/img/shenyu/plugin/mcpServer/request_config.png
new file mode 100644
index 00000000000..da80b8be81f
Binary files /dev/null and
b/static/img/shenyu/plugin/mcpServer/request_config.png differ
diff --git a/static/img/shenyu/plugin/mcpServer/selector_new.png
b/static/img/shenyu/plugin/mcpServer/selector_new.png
new file mode 100644
index 00000000000..555808319c0
Binary files /dev/null and
b/static/img/shenyu/plugin/mcpServer/selector_new.png differ
diff --git a/static/img/shenyu/plugin/mcpServer/tool_config.png
b/static/img/shenyu/plugin/mcpServer/tool_config.png
new file mode 100644
index 00000000000..a1af1042590
Binary files /dev/null and b/static/img/shenyu/plugin/mcpServer/tool_config.png
differ
diff --git a/versioned_docs/version-2.7.0.2/plugin-center/mcp/_category_.json
b/versioned_docs/version-2.7.0.2/plugin-center/mcp/_category_.json
new file mode 100644
index 00000000000..cbf4b734107
--- /dev/null
+++ b/versioned_docs/version-2.7.0.2/plugin-center/mcp/_category_.json
@@ -0,0 +1,4 @@
+{
+ "label": "Mcp",
+ "position": 10
+}
diff --git
a/versioned_docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
b/versioned_docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
new file mode 100644
index 00000000000..fbadb4984c5
--- /dev/null
+++ b/versioned_docs/version-2.7.0.2/plugin-center/mcp/mcp-server-plugin.md
@@ -0,0 +1,65 @@
+---
+title: McpServer Plugin
+keywords: ["mcpServer"]
+description: mcp Server Plugin
+---
+
+## Explanation
+
+* The `mcpServer` plugin is used to enable the `mcpServer` functionality in
the ShenYu gateway. After enabling this plugin, users can register `Tools` for
unified management by the gateway.
+
+* The `mcpServer` plugin must be used together with a `proxy` plugin to enable
Tool invocation.
+
+## Plugin Setting
+
+* To add the necessary dependencies and enable the plugin, please refer to:
[Quick Start with McpServer](../../quick-start/quick-start-mcpServer).
+
+* For McpTool client integration, please refer to: [McpTool Service
Integration](../../user-guide/proxy/mcp-tool-proxy.md).
+
+* For selector and rule configuration, please refer to: [Selector and Rule
Management](../../user-guide/admin-usage/selector-and-rule).
+
+## Plugin Details
+
+After the client is connected to the `Apache ShenYu` gateway, selector and
rule information will be automatically registered. For details about selector
and rule configuration, please refer to: [Selector and Rule
Management](../../user-guide/admin-usage/selector-and-rule).
+
+#### Selector Handling
+
+<img src="/img/shenyu/plugin/mcpServer/selector_new.png" width="80%"
height="80%" />
+
+For selector handling, the current version only supports the `startWith`
condition in `Condition`. The `endpoint` is equal to the gateway route plus the
URL configured in `Condition` and the request protocol (sse/streamablehttp).
+
+Click "SSE Configuration" or "Streamable Configuration" to enter the JSON
editing page, which helps users conveniently edit the JSON configuration
required by the Mcp client.
+
+<img src="/img/shenyu/plugin/mcpServer/mcp_client_config_en.png" width="80%"
height="80%" />
+
+#### Tool Handling
+
+<img src="/img/shenyu/plugin/mcpServer/tool_config.png" width="80%"
height="80%" />
+
+<img src="/img/shenyu/plugin/mcpServer/request_config.png" width="80%"
height="80%" />
+
+Tool handling refers to the `handle` field, which allows you to perform
operations after the gateway has completed traffic matching. For more
information, please refer to [Plugin Handle
Explanation](../../user-guide/admin-usage/plugin-handle-explanation) in plugin
management.
+
+* Details of tool configuration:
+
+ * `Description`: Defines the purpose of the tool.
+
+ * `Parameter`: Defines the type of parameters required by the tool.
+
+* Details of requestConfig configuration:
+
+ * `url`: Defines context-path + the actual URL of the tool.
+
+ * `method`: Defines the request type of the tool method.
+
+ * `argsPosition`: Defines the correspondence between all parameters and
their positions.
+
+ * `argsToJsonBody`: If true, all parameters will be added to the body.
+
+ * `headers`: You can add headers required by the Tool here.
+
+## How to disable plugin
+
+- In `shenyu-admin` --> Basic Configuration --> Plugin Management --> set
`mcpServer` to disabled.
+
+
