This is an automated email from the ASF dual-hosted git repository.
terrymanu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new bea8f9de7e5 Clarify ShardingSphere MCP access path (#38758)
bea8f9de7e5 is described below
commit bea8f9de7e5ba0c228687dc27388a8c65a1c939c
Author: Liang Zhang <[email protected]>
AuthorDate: Fri May 29 23:48:15 2026 +0800
Clarify ShardingSphere MCP access path (#38758)
- Describe ShardingSphere-MCP as a controlled access path for models and
agents
- Clarify that models call MCP capabilities instead of connecting to
databases directly
- Split product positioning on the MCP overview from client integration
guidance
---
docs/document/content/user-manual/shardingsphere-mcp/_index.cn.md | 3 ++-
docs/document/content/user-manual/shardingsphere-mcp/_index.en.md | 3 ++-
.../content/user-manual/shardingsphere-mcp/client-integration.cn.md | 5 +++--
.../content/user-manual/shardingsphere-mcp/client-integration.en.md | 5 +++--
4 files changed, 10 insertions(+), 6 deletions(-)
diff --git a/docs/document/content/user-manual/shardingsphere-mcp/_index.cn.md
b/docs/document/content/user-manual/shardingsphere-mcp/_index.cn.md
index 765d443a879..e18ca4d5064 100644
--- a/docs/document/content/user-manual/shardingsphere-mcp/_index.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-mcp/_index.cn.md
@@ -6,7 +6,8 @@ chapter = true
+++
ShardingSphere-MCP 是 Apache ShardingSphere 的 MCP Server,可以独立启动,并向 MCP 客户端暴露
ShardingSphere 逻辑库的元数据、安全 SQL 访问能力和插件工作流。
-它面向大模型或 Agent 主动理解数据库结构、读取治理状态,并在需要时调用受控工具完成查询或生成可审查的治理变更计划。
+ShardingSphere-MCP 为大模型和 Agent 提供一条受控访问 ShardingSphere 逻辑库的通路。
+模型通过 MCP 客户端主动发现数据库结构、读取治理状态,并在权限边界内调用 SQL 工具或生成可审查的治理变更计划;数据库连接、会话和执行边界由 MCP
Server 管理。
ShardingSphere-MCP 的配置以数据库为核心:先配置 MCP Server 可以连接的 ShardingSphere 逻辑库,再通过 MCP
客户端读取元数据或调用 SQL 工具。
diff --git a/docs/document/content/user-manual/shardingsphere-mcp/_index.en.md
b/docs/document/content/user-manual/shardingsphere-mcp/_index.en.md
index 3881cab1d6b..1dc0b4f0cfc 100644
--- a/docs/document/content/user-manual/shardingsphere-mcp/_index.en.md
+++ b/docs/document/content/user-manual/shardingsphere-mcp/_index.en.md
@@ -6,7 +6,8 @@ chapter = true
+++
ShardingSphere-MCP is the MCP Server for Apache ShardingSphere. It can run
independently and expose ShardingSphere logical database metadata, safe SQL
access, and plugin workflows to MCP clients.
-It is designed for models or agents to understand database structure, read
governance state, and call controlled tools when they need to query data or
create reviewable governance change plans.
+ShardingSphere-MCP provides models and agents with a controlled access path to
ShardingSphere logical databases.
+Through an MCP client, a model can actively discover database structure, read
governance state, and call SQL tools or create reviewable governance change
plans within defined boundaries. Database connections, sessions, and execution
boundaries are managed by the MCP Server.
ShardingSphere-MCP configuration starts from databases: configure the
ShardingSphere logical databases that the MCP Server can connect to, then read
metadata or call SQL tools through an MCP client.
diff --git
a/docs/document/content/user-manual/shardingsphere-mcp/client-integration.cn.md
b/docs/document/content/user-manual/shardingsphere-mcp/client-integration.cn.md
index 53f8415d19e..7efdf2a3282 100644
---
a/docs/document/content/user-manual/shardingsphere-mcp/client-integration.cn.md
+++
b/docs/document/content/user-manual/shardingsphere-mcp/client-integration.cn.md
@@ -3,9 +3,10 @@ title = "客户端集成"
weight = 4
+++
-客户端集成面向把 ShardingSphere-MCP 接入桌面客户端、IDE 插件、Agent 平台或自研 LLM 应用的场景。
+客户端集成用于把这条受控数据库访问通路接入桌面客户端、IDE 插件、Agent 平台或自研 LLM 应用。
+接入后,大模型不是直接连接数据库,而是通过 MCP 客户端调用 ShardingSphere-MCP 暴露的资源、工具、提示和补全能力。
它不是快速开始中 curl 手工验证流程的替代说明,也不是让用户手工拼 JSON-RPC 的操作手册。
-它的价值是让大模型通过 MCP 客户端主动发现 ShardingSphere 元数据和治理能力,再由客户端负责连接配置、会话头、补全和调用编排。
+客户端负责连接配置、会话头、补全和调用编排。
用户只需要表达要完成的元数据查询、只读 SQL 查询或数据库治理任务。
适合使用客户端集成的场景:
diff --git
a/docs/document/content/user-manual/shardingsphere-mcp/client-integration.en.md
b/docs/document/content/user-manual/shardingsphere-mcp/client-integration.en.md
index a9bb57167a8..ba03c888897 100644
---
a/docs/document/content/user-manual/shardingsphere-mcp/client-integration.en.md
+++
b/docs/document/content/user-manual/shardingsphere-mcp/client-integration.en.md
@@ -3,9 +3,10 @@ title = "Client Integration"
weight = 4
+++
-Client integration is for desktop clients, IDE extensions, agent platforms, or
custom LLM applications that connect to ShardingSphere-MCP.
+Client integration connects this controlled database access path to desktop
clients, IDE extensions, agent platforms, or custom LLM applications.
+After integration, the model does not connect to the database directly. It
calls the resources, tools, prompts, and completion capabilities exposed by
ShardingSphere-MCP through an MCP client.
It is not a replacement for the curl-based smoke test in Quick Start, and it
is not a guide for users to hand-write JSON-RPC.
-Its value is letting models discover ShardingSphere metadata and governance
capabilities through an MCP client, while the client manages connection
configuration, session headers, completion, and call orchestration.
+The client manages connection configuration, session headers, completion, and
call orchestration.
Users only need to describe the metadata lookup, read-only SQL query, or
database governance task they want to complete.
Use client integration when: