跳至内容
用户手册
ShardingSphere-MCP
部署说明

部署说明

ShardingSphere-MCP 可以通过源码构建的独立发行包运行，也可以通过官方 OCI 镜像运行。

独立发行包

构建发行包：

./mvnw -pl distribution/mcp -am -DskipTests package

发行包目录包含：

  • bin/：启动脚本。
  • conf/：默认配置和日志配置。
  • lib/：MCP Server 依赖和内置 MCP 功能插件。
  • plugins/：外部 JDBC 驱动或额外 MCP 功能插件 jar。
  • logs/：运行日志。

OCI 镜像

官方 MCP Registry 元数据位于 mcp/server.json。 公开 server name 是 io.github.apache/shardingsphere-mcp。 OCI image 示例引用是：

ghcr.io/apache/shardingsphere-mcp:5.5.4

OCI 镜像可以使用内置 conf/mcp-http-docker.yaml 配置和空的 runtimeDatabases 启动。 使用元数据、SQL 或规则能力前，请先准备自定义配置文件。 HTTP 模式在容器中运行时，bindHost 应绑定到容器可暴露的网络接口，例如 0.0.0.0：

transport:
  type: HTTP
  http:
    bindHost: 0.0.0.0
    port: 18088
    endpointPath: /mcp

runtimeDatabases:
  "logic_db":
    jdbcUrl: "jdbc:mysql://127.0.0.1:3307/logic_db"
    username: "root"
    password: ""
    driverClassName: "com.mysql.cj.jdbc.Driver"

以 HTTP 模式运行，并挂载自定义配置文件和插件目录：

docker run --rm -p 18088:18088 \
  -e SHARDINGSPHERE_MCP_CONFIG=/opt/shardingsphere-mcp/conf/custom-mcp-http.yaml \
  -v /path/to/mcp-http.yaml:/opt/shardingsphere-mcp/conf/custom-mcp-http.yaml:ro \
  -v /path/to/plugins:/opt/shardingsphere-mcp/plugins:ro \
  ghcr.io/apache/shardingsphere-mcp:${latest.release.version}

以 STDIO 模式运行时，配置文件中的 transport.type 应为 STDIO：

docker run --rm -i \
  -e SHARDINGSPHERE_MCP_CONFIG=/opt/shardingsphere-mcp/conf/custom-mcp-stdio.yaml \
  -v /path/to/mcp-stdio.yaml:/opt/shardingsphere-mcp/conf/custom-mcp-stdio.yaml:ro \
  -v /path/to/plugins:/opt/shardingsphere-mcp/plugins:ro \
  ghcr.io/apache/shardingsphere-mcp:${latest.release.version}

根据目标能力边界配置 runtimeDatabases：

  • 使用 ShardingSphere 规则能力或规则变更流程时，指向用户已准备好的 ShardingSphere-Proxy 逻辑库。
  • 仅使用元数据搜索、元数据查看和受控 SQL 能力时，可以使用数据库直连。

安全部署建议

内置 HTTP Server 不提供认证、授权、限流或审计日志。 不支持把内置 HTTP Server 直接暴露到公网作为生产部署边界。 如果需要远程访问，应放在受信网络、反向代理或网关后面，由外层组件处理：

  • TLS 终止。
  • 身份认证。
  • 授权策略。
  • 限流。
  • 网络访问控制。
  • 审计日志。

HTTP 绑定建议：

  • 本地调试使用 127.0.0.1。
  • 容器或内网部署使用受控网络接口。
  • 面向远程客户端暴露时，避免直接裸露 MCP Server，应通过受信网关转发。
  • 需要把会话和外部用户或调用来源关联时，由受信网关注入会话归属请求头；不要允许客户端直接伪造这些请求头。

受信网关与 TLS 终止样例

以下示例使用 Nginx 说明“外层入口负责 HTTPS，ShardingSphere-MCP 继续在受控网络中提供 HTTP”的最小布局。其他反向代理、Ingress、ALB 或 API Gateway 只要满足同样边界，也可以采用相同思路。

ShardingSphere-MCP 配置示例：

transport:
  type: HTTP
  http:
    bindHost: 127.0.0.1
    port: 18088
    endpointPath: /mcp
    sessionAttributionSource:
      subjectHeader: X-ShardingSphere-MCP-Subject
      sourceHeader: X-ShardingSphere-MCP-Source
      attributeHeaderPrefix: X-ShardingSphere-MCP-Attribute-

Nginx 示例：

server {
  listen 443 ssl http2;
  server_name _;

  ssl_certificate     /etc/nginx/certs/mcp.crt;
  ssl_certificate_key /etc/nginx/certs/mcp.key;

  location /mcp {
    proxy_pass http://127.0.0.1:18088/mcp;
    proxy_http_version 1.1;
    proxy_pass_request_headers off;

    proxy_set_header Host $host;
    proxy_set_header Content-Type $http_content_type;
    proxy_set_header Accept $http_accept;
    proxy_set_header MCP-Session-Id $http_mcp_session_id;
    proxy_set_header MCP-Protocol-Version $http_mcp_protocol_version;
    proxy_set_header X-Forwarded-Proto https;
    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
  }
}

这类布局的关键点是：

  • TLS 在受信网关终止，MCP 进程本身不直接管理公网证书。
  • ShardingSphere-MCP 继续绑定到本地回环地址或受控内网接口，不直接裸露到公网。
  • 认证、授权、限流和网络访问控制仍由外层网关处理，而不是由内置 HTTP Server 处理。

会话归属接线样例

如果外层网关已经能识别调用方身份，可以让网关在转发请求时覆写会话归属请求头，再由 MCP Runtime 绑定到会话上下文。请求头名称与前缀应和配置说明中的 transport.http.sessionAttributionSource 保持一致。

Nginx 示例：

location /mcp {
  proxy_pass http://127.0.0.1:18088/mcp;
  proxy_http_version 1.1;
  proxy_pass_request_headers off;

  proxy_set_header Host $host;
  proxy_set_header Content-Type $http_content_type;
  proxy_set_header Accept $http_accept;
  proxy_set_header MCP-Session-Id $http_mcp_session_id;
  proxy_set_header MCP-Protocol-Version $http_mcp_protocol_version;
  proxy_set_header X-Forwarded-Proto https;
  proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

  proxy_set_header X-ShardingSphere-MCP-Subject $remote_user;
  proxy_set_header X-ShardingSphere-MCP-Source gateway-nginx;
  proxy_set_header X-ShardingSphere-MCP-Attribute-Environment production;
}

接线时建议遵循以下原则：

  • 对转发到后端的请求头使用白名单，或在注入可信值前剥离或拒绝所有匹配归属请求头名称和前缀的客户端原始请求头。
  • subjectHeader 表示外部主体，例如试用账号、正式客户标识或内部调用身份。
  • sourceHeader 表示请求来源，例如 gateway-nginx、internal-alb 或其他受信入口名称。
  • attributeHeaderPrefix 可用于注入少量非敏感上下文，例如环境、区域或接入渠道；不要通过这些请求头传递密码、密钥或令牌。
  • 初始化会话时，subject、source 和 attributes 会与 session ID 一起固化。该会话的后续请求必须携带完全一致的归属快照；缺少、新增或修改任何值都会被拒绝。
  • 归属字段只能使用在整个会话期间保持稳定的值。不要把 request ID、trace ID、时间戳或其他单次请求值映射为归属属性。
  • 会话归属只用于描述和诊断上下文，不代表已经完成认证或授权；两者仍须由受信网关执行。
  • 如果当前部署不需要把请求归属绑定到会话上下文，可以省略 sessionAttributionSource 配置。

完成接线后，继续按照下文的健康检查步骤确认：

  • 网关地址可访问。
  • MCP 协议已就绪。
  • 运行时数据库已就绪。
  • 同一会话内的后续请求不会因为归属请求头变化而失配。

健康检查

部署完成后，建议按以下顺序确认 ShardingSphere-MCP 是否真正可用，而不只停留在“HTTP 端口可达”：

  1. 服务进程与端点可达

    • HTTP 模式确认进程已启动、端口已监听，并且 http://127.0.0.1:18088/mcp 与客户端配置一致。
    • STDIO 模式确认由 AI 应用正确拉起 MCP 进程，不把标准输入输出当作交互式 shell 使用。

  2. MCP 协议已就绪

    • 通过 AI 应用确认 MCP Server 已被识别，或按自研集成附录中的协议调试示例完成 initialize 和能力读取。
    • 如果只能确认 HTTP 返回，但无法读取 capabilities、resources 或 tools，说明端点可达但协议尚未正确接通。

  3. 运行时数据库已就绪

    • 读取 shardingsphere://runtime，确认 transport、runtime 数据库摘要和运行状态可见。
    • 调用 database_gateway_validate_runtime_database，或在 AI 应用中执行“查看 logic_db 中有哪些表”这类最小任务，确认当前 runtimeDatabases 对应的逻辑库可用。
    • 仅有 MCP Server 进程启动并不表示目标运行时数据库已经可用；连接失败、权限不足或逻辑库不可见仍会阻断后续任务。

基础可观测入口

日志

  • HTTP 模式：查看启动终端和 logs/mcp.log。
  • STDIO 模式：不要把标准输出作为日志查看入口，诊断信息查看 stderr 或 logs/mcp.log。

运行时状态与保护信息

  • shardingsphere://runtime 提供当前 transport、runtime 数据库摘要、运行状态和基础诊断信息。
  • 运行时保护信息会反映查询行数限制、查询超时和会话级工具调用保护等边界。
  • 当运行时数据库连接失败时，可结合错误分类和恢复建议定位问题；详细分类说明见常见问题。

最小排障信息

需要向管理员或排障人员反馈问题时，至少收集以下信息：

  • 启动命令或容器运行命令。
  • MCP 配置文件摘要，注意移除密码、密钥和令牌。
  • 传输方式、端点地址和 runtimeDatabases 中的目标逻辑库名称。
  • AI 应用中的 MCP Server 配置摘要。
  • 失败任务、错误分类和 logs/mcp.log 中相关日志片段。

进一步的症状定位、错误分类和运行时保护说明见常见问题；需要直接调试 MCP 协议请求时，见自研集成附录。

配置说明常见问题