Gaussdb Ro MCP

Read-only MCP server for Huawei GaussDB (centralized & distributed), built for coding agents.

Quick Install

Automated & IDE Setup

Copy the AI prompt to install this server into Claude Code, Cursor, or another agent — or use 1-click editor setup below.

One-click editor setup isn’t available for this listing yet — we don’t have a confirmed install command, and we’d rather show nothing than point your editor at the wrong package or host. Follow the project’s own setup instructions, linked above.

Manual Client & Custom JSON ConfigExpand JSON ▾

No confirmed setup config for this listing yet. We only publish a config block when the install details come from the project itself — its README, its docs, or a verified owner. We haven’t found those for gaussdb-ro-mcp, and we’d rather show nothing than a guess you’d paste into your client. Follow the project’s own setup instructions for the current steps.

Documentation Overview

gaussdb-ro-mcp

面向 Coding Agent（Claude Code、OpenCode 等）的 GaussDB 只读 MCP 服务器。基于 GaussDB 官方 Go 驱动（华为云官方开源的 pgx v5 适配版，源码随仓库内置于 third_party/gaussdb-go，支持离线构建），通过 stdio 传输提供数据库只读探查工具。

专为内网非 SSL 环境设计：默认 sslmode=disable，配置文件支持同时管理多个 GaussDB 实例。

只读保障（三层纵深防御）

层级	机制	说明
1. SQL 静态校验	`internal/guard`	仅放行单条 `SELECT`/`WITH` 查询：拒绝 DML/DDL（含 CTE 内写语句）、`SELECT ... INTO`、`FOR UPDATE/SHARE` 行锁、多语句、危险函数（`dblink`、`set_config`、`setval`、`pg_read_file`、`pg_terminate_backend`、`pg_advisory_*`、大对象写等，可配置）。词法分析正确跳过字符串/注释/引号标识符，避免误报
2. 事务级强制	`internal/db`	所有查询统一在显式只读事务中执行：`BEGIN` → `SET LOCAL TRANSACTION READ ONLY` → 查询 → `COMMIT`（失败回滚）。GaussDB 分布式版仅支持事务级只读设置，该方式在集中式/主备与分布式实例上通用；另设 `SET statement_timeout`。即使第 1 层被绕过，服务端也会拒绝事务内一切写入（包括函数内部的写）
3. 部署建议	README	建议使用仅授予 `SELECT` 权限的数据库账号（见下文），实现权限最小化

提供的 MCP 工具

工具	功能
`test_connection`	连通性测试：服务器版本、当前库/用户、只读状态、延迟；可选 `instance` 参数
`list_schemas`	schema（模式）清单：对象数、注释；`include_system` 控制是否含系统模式
`list_tables`	表/视图清单：类型（表/视图/物化视图/分区表/外表）、估算行数、注释；可按 `schema` 过滤
`describe_table`	表结构：列（类型/可空/默认值/注释）、主键与约束、全部索引及定义；视图返回视图定义 SQL；分区表返回分区清单（GaussDB `pg_partition`）
`execute_select`	执行 SELECT：仅接受单条 SELECT/WITH，受 `max_rows`/超时限制，返回列名+行数据+是否截断

所有工具均接受可选 instance 参数以选择数据源，缺省使用 default_instance。

安装

从 Releases 下载对应平台的二进制（linux-amd64 / linux-arm64 / darwin-arm64 / windows-amd64.exe；其他平台或内网环境可自行构建，见下节）。

Linux：

Terminal

curl -LO https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-linux-amd64
sudo install -Dm 755 gaussdb-ro-mcp-linux-amd64 /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

macOS（Apple Silicon）：

Terminal

curl -LO https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-darwin-arm64
sudo install -Dm 755 gaussdb-ro-mcp-darwin-arm64 /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

Windows（PowerShell；放入 PATH 目录后即可直接调用）：

powershell

Invoke-WebRequest -Uri "https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-windows-amd64.exe" -OutFile "gaussdb-ro-mcp.exe"
Move-Item .\gaussdb-ro-mcp.exe "$env:LOCALAPPDATA\Microsoft\WindowsApps\"  # 该目录默认在 PATH 中
gaussdb-ro-mcp --version

各产物校验值见 Release 页的 SHA256SUMS.txt。

构建

要求 Go 1.26+（与 go.mod 一致）。驱动源码已内置于 third_party/gaussdb-go（通过 replace 指令引用），正常联网环境下 go build 会自动解析其余依赖；纯内网环境请先在有网环境执行 go mod vendor 后携带 vendor/ 目录，用 go build -mod=vendor 构建。

bash

go build -o gaussdb-ro-mcp ./cmd/gaussdb-ro-mcp
sudo install -Dm 755 gaussdb-ro-mcp /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

交叉编译其他平台（纯 Go，CGO_ENABLED=0 即可）：CGO_ENABLED=0 GOOS=<os> GOARCH=<arch> go build -o ... ./cmd/gaussdb-ro-mcp。

配置

复制 gaussdb-ro-mcp.example.yaml 为 gaussdb-ro-mcp.yaml 并修改。配置文件查找顺序：-config 参数 > 环境变量 GAUSSDB_RO_MCP_CONFIG > ./gaussdb-ro-mcp.yaml。

yaml

server:
  max_rows: 500          # execute_select 默认行数上限
  max_rows_cap: 10000    # 单次调用可放宽的硬上限
  statement_timeout: 30s
  connect_timeout: 10s

instances:
  - name: prod                    # 实例名称，工具调用时用 instance 参数引用
    host: 192.168.0.10
    port: 8000
    database: postgres
    user: readonly_user
    password: "****"
    sslmode: disable              # 内网非 SSL 默认值
  - name: dev
    dsn: "gaussdb://readonly_user:****@192.168.1.20:5432/appdb?sslmode=disable"

default_instance: prod

接入 Coding Agent

Claude Code

方式一：项目根目录 .mcp.json（或 claude mcp add 命令）：

config.json

{
  "mcpServers": {
    "gaussdb-readonly": {
      "command": "/usr/local/bin/gaussdb-ro-mcp",
      "args": ["-config", "/path/to/gaussdb-ro-mcp.yaml"]
    }
  }
}

Terminal

claude mcp add gaussdb-readonly -- /usr/local/bin/gaussdb-ro-mcp -config /path/to/gaussdb-ro-mcp.yaml

OpenCode

opencode.json：

config.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "gaussdb-readonly": {
      "type": "local",
      "command": ["/usr/local/bin/gaussdb-ro-mcp", "-config", "/path/to/gaussdb-ro-mcp.yaml"]
    }
  }
}

数据库侧只读账号（强烈建议）

sql

CREATE USER readonly_user WITH PASSWORD 'your-strong-password';
GRANT USAGE ON SCHEMA public TO readonly_user;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO readonly_user;
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO readonly_user;
-- 其他模式按需逐个授权

即使数据库账号被限定为只读，本服务的 SQL 校验与会话强制仍会拦截锁行（FOR UPDATE）、SELECT INTO、危险函数调用、长查询等行为。

日志

所有运行日志输出到 stderr（stdout 为 MCP 协议通道），包括配置加载、数据源就绪、会话只读校验结果等，便于在代理客户端的 MCP 日志中排障。

开发与测试

bash

go test ./...                       # 单元测试（SQL 校验、配置解析）
GAUSSDB_RO_MCP_TEST_DSN="host=... port=... user=... password=... dbname=... sslmode=disable" \
  go test -count=1 ./...            # 集成测试（需 GaussDB/openGauss 实例）

可用 Docker 快速起一个 openGauss 测试实例并灌入测试数据：

Terminal

docker run -d --name opengauss-ro-test -e GS_PASSWORD='Gaussdb@123' \
  -p 127.0.0.1:15433:5432 --privileged docker.m.daocloud.io/enmotech/opengauss:latest

go run ./scripts/devseed "host=127.0.0.1 port=15433 user=gaussdb password=Gaussdb@123 dbname=postgres sslmode=disable"

集成测试覆盖：只读会话强制（服务端拒绝写入）、5 个工具的端到端行为、真实二进制 stdio 子进程冒烟。注意：本驱动使用 GaussDB 扩展协议（3.51），无法连接原生 PostgreSQL，集成测试需要真实的 GaussDB / openGauss 实例。

目录结构

Code

cmd/gaussdb-ro-mcp/     程序入口（stdio MCP 服务器）
internal/config/        YAML 配置：多实例数据源、行数/超时等
internal/guard/         第 1 层防护：SQL 只读静态校验器
internal/db/            多实例连接池 + 第 2 层防护：会话级 READ ONLY 强制、元数据查询
internal/tools/         MCP 工具注册与实现
scripts/devseed/        集成测试数据灌入工具（开发用）
third_party/gaussdb-go/ GaussDB 官方 Go 驱动源码（go.mod replace 引用）

反馈与贡献

欢迎提交 Issue 和 Pull Request：

问题反馈 / 功能建议：https://github.com/gxc/gaussdb-ro-mcp/issues
获取最新版本：https://github.com/gxc/gaussdb-ro-mcp/releases/latest
提交 PR 前，请确保 go vet ./... 与 go test ./... 通过；涉及安全防护逻辑（SQL 静态校验 / 只读强制）的改动请附带回归测试

Read the full README →View source on GitHub →

Related MCP Servers

View all in Developer Tools View all alternatives

Reviews

No reviews yet — be the first to share how this listing worked for you.

Frequently Asked Questions about Gaussdb Ro MCP

We don't have a confirmed install command for gaussdb-ro-mcp yet, so we don't publish a generated one — a guessed package name would point at the wrong package or none at all. Follow the project's own README or setup instructions (https://github.com/gxc/gaussdb-ro-mcp) for the current steps.

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:

Live Dynamic SVG Preview

Markdown (GitHub README)

[![AllMCPs](https://allmcps.com/api/badge/gaussdb-ro-mcp?style=directory)](https://allmcps.com/mcp/gaussdb-ro-mcp)

HTML Embed

<a href="https://allmcps.com/mcp/gaussdb-ro-mcp"><img src="https://allmcps.com/api/badge/gaussdb-ro-mcp?style=directory" alt="Gaussdb Ro MCP on AllMCPs" /></a>

Technical Specs & Signals

CategoryDeveloper Tools

27Quality signal: Emerging · 27/100How this signal is calculated ▾

Server availabilityNot measured

Not scored for repo-hosted servers — we can't reach the running server, only its GitHub page. Hosted MCP endpoints are health-checked live.

Verified ownership8/20

Documentation & tools11/30

Adoption & activity1/15

Community engagement0/10

A guidance signal from public completeness & health data — not a user rating. New listings start lower and rise as they add docs, get verified, and grow adoption. Signals we can't observe for a listing are skipped, not counted against it.

★ Spotlight Slot

Feature Your MCP Server

Get maximum visibility for your server across our directory, search results, and detail pages.

Spotlight Your Server

Own this project?

This directory is pre-filled from public sources. Claim via GitHub README, site badge, or DNS TXT to unlock edit access and the Official badge and attach your website — proof is checked automatically, then reviewed by our team.

Free dofollow backlink: add your website and place the AllMCPs badge on it — no claim needed. We detect it automatically and keep it verified as long as the badge stays live.

Claim & get free dofollow

Share & Embed

Add our SVG badge (dark/light directory styles) or embeddable widget to your site.

Explore more

More in 💻 Developer Tools →Best MCP servers for Developers →Alternatives to Gaussdb Ro MCP →Install in Claude Desktop Install in Cursor Install in VS Code Setup guides for all 13 MCP clients

Gaussdb Ro MCP

Read-only MCP server for Huawei GaussDB (centralized & distributed), built for coding agents.

Quick Install

Automated & IDE Setup

Copy the AI prompt to install this server into Claude Code, Cursor, or another agent — or use 1-click editor setup below.

Manual Client & Custom JSON ConfigExpand JSON ▾

Documentation Overview

gaussdb-ro-mcp

专为内网非 SSL 环境设计：默认 sslmode=disable，配置文件支持同时管理多个 GaussDB 实例。

只读保障（三层纵深防御）

层级	机制	说明
1. SQL 静态校验	`internal/guard`	仅放行单条 `SELECT`/`WITH` 查询：拒绝 DML/DDL（含 CTE 内写语句）、`SELECT ... INTO`、`FOR UPDATE/SHARE` 行锁、多语句、危险函数（`dblink`、`set_config`、`setval`、`pg_read_file`、`pg_terminate_backend`、`pg_advisory_*`、大对象写等，可配置）。词法分析正确跳过字符串/注释/引号标识符，避免误报
2. 事务级强制	`internal/db`	所有查询统一在显式只读事务中执行：`BEGIN` → `SET LOCAL TRANSACTION READ ONLY` → 查询 → `COMMIT`（失败回滚）。GaussDB 分布式版仅支持事务级只读设置，该方式在集中式/主备与分布式实例上通用；另设 `SET statement_timeout`。即使第 1 层被绕过，服务端也会拒绝事务内一切写入（包括函数内部的写）
3. 部署建议	README	建议使用仅授予 `SELECT` 权限的数据库账号（见下文），实现权限最小化

提供的 MCP 工具

工具	功能
`test_connection`	连通性测试：服务器版本、当前库/用户、只读状态、延迟；可选 `instance` 参数
`list_schemas`	schema（模式）清单：对象数、注释；`include_system` 控制是否含系统模式
`list_tables`	表/视图清单：类型（表/视图/物化视图/分区表/外表）、估算行数、注释；可按 `schema` 过滤
`describe_table`	表结构：列（类型/可空/默认值/注释）、主键与约束、全部索引及定义；视图返回视图定义 SQL；分区表返回分区清单（GaussDB `pg_partition`）
`execute_select`	执行 SELECT：仅接受单条 SELECT/WITH，受 `max_rows`/超时限制，返回列名+行数据+是否截断

所有工具均接受可选 instance 参数以选择数据源，缺省使用 default_instance。

安装

从 Releases 下载对应平台的二进制（linux-amd64 / linux-arm64 / darwin-arm64 / windows-amd64.exe；其他平台或内网环境可自行构建，见下节）。

Linux：

Terminal

curl -LO https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-linux-amd64
sudo install -Dm 755 gaussdb-ro-mcp-linux-amd64 /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

macOS（Apple Silicon）：

Terminal

curl -LO https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-darwin-arm64
sudo install -Dm 755 gaussdb-ro-mcp-darwin-arm64 /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

Windows（PowerShell；放入 PATH 目录后即可直接调用）：

powershell

Invoke-WebRequest -Uri "https://github.com/gxc/gaussdb-ro-mcp/releases/latest/download/gaussdb-ro-mcp-windows-amd64.exe" -OutFile "gaussdb-ro-mcp.exe"
Move-Item .\gaussdb-ro-mcp.exe "$env:LOCALAPPDATA\Microsoft\WindowsApps\"  # 该目录默认在 PATH 中
gaussdb-ro-mcp --version

各产物校验值见 Release 页的 SHA256SUMS.txt。

构建

bash

go build -o gaussdb-ro-mcp ./cmd/gaussdb-ro-mcp
sudo install -Dm 755 gaussdb-ro-mcp /usr/local/bin/gaussdb-ro-mcp
gaussdb-ro-mcp --version

交叉编译其他平台（纯 Go，CGO_ENABLED=0 即可）：CGO_ENABLED=0 GOOS=<os> GOARCH=<arch> go build -o ... ./cmd/gaussdb-ro-mcp。

配置

复制 gaussdb-ro-mcp.example.yaml 为 gaussdb-ro-mcp.yaml 并修改。配置文件查找顺序：-config 参数 > 环境变量 GAUSSDB_RO_MCP_CONFIG > ./gaussdb-ro-mcp.yaml。

yaml

server:
  max_rows: 500          # execute_select 默认行数上限
  max_rows_cap: 10000    # 单次调用可放宽的硬上限
  statement_timeout: 30s
  connect_timeout: 10s

instances:
  - name: prod                    # 实例名称，工具调用时用 instance 参数引用
    host: 192.168.0.10
    port: 8000
    database: postgres
    user: readonly_user
    password: "****"
    sslmode: disable              # 内网非 SSL 默认值
  - name: dev
    dsn: "gaussdb://readonly_user:****@192.168.1.20:5432/appdb?sslmode=disable"

default_instance: prod

接入 Coding Agent

Claude Code

方式一：项目根目录 .mcp.json（或 claude mcp add 命令）：

config.json

{
  "mcpServers": {
    "gaussdb-readonly": {
      "command": "/usr/local/bin/gaussdb-ro-mcp",
      "args": ["-config", "/path/to/gaussdb-ro-mcp.yaml"]
    }
  }
}

Terminal

claude mcp add gaussdb-readonly -- /usr/local/bin/gaussdb-ro-mcp -config /path/to/gaussdb-ro-mcp.yaml

OpenCode

opencode.json：

config.json

{
  "$schema": "https://opencode.ai/config.json",
  "mcp": {
    "gaussdb-readonly": {
      "type": "local",
      "command": ["/usr/local/bin/gaussdb-ro-mcp", "-config", "/path/to/gaussdb-ro-mcp.yaml"]
    }
  }
}

数据库侧只读账号（强烈建议）

sql

CREATE USER readonly_user WITH PASSWORD 'your-strong-password';
GRANT USAGE ON SCHEMA public TO readonly_user;
GRANT SELECT ON ALL TABLES IN SCHEMA public TO readonly_user;
ALTER DEFAULT PRIVILEGES IN SCHEMA public GRANT SELECT ON TABLES TO readonly_user;
-- 其他模式按需逐个授权

即使数据库账号被限定为只读，本服务的 SQL 校验与会话强制仍会拦截锁行（FOR UPDATE）、SELECT INTO、危险函数调用、长查询等行为。

日志

所有运行日志输出到 stderr（stdout 为 MCP 协议通道），包括配置加载、数据源就绪、会话只读校验结果等，便于在代理客户端的 MCP 日志中排障。

开发与测试

bash

go test ./...                       # 单元测试（SQL 校验、配置解析）
GAUSSDB_RO_MCP_TEST_DSN="host=... port=... user=... password=... dbname=... sslmode=disable" \
  go test -count=1 ./...            # 集成测试（需 GaussDB/openGauss 实例）

可用 Docker 快速起一个 openGauss 测试实例并灌入测试数据：

Terminal

docker run -d --name opengauss-ro-test -e GS_PASSWORD='Gaussdb@123' \
  -p 127.0.0.1:15433:5432 --privileged docker.m.daocloud.io/enmotech/opengauss:latest

go run ./scripts/devseed "host=127.0.0.1 port=15433 user=gaussdb password=Gaussdb@123 dbname=postgres sslmode=disable"

目录结构

Code

cmd/gaussdb-ro-mcp/     程序入口（stdio MCP 服务器）
internal/config/        YAML 配置：多实例数据源、行数/超时等
internal/guard/         第 1 层防护：SQL 只读静态校验器
internal/db/            多实例连接池 + 第 2 层防护：会话级 READ ONLY 强制、元数据查询
internal/tools/         MCP 工具注册与实现
scripts/devseed/        集成测试数据灌入工具（开发用）
third_party/gaussdb-go/ GaussDB 官方 Go 驱动源码（go.mod replace 引用）

反馈与贡献

欢迎提交 Issue 和 Pull Request：

问题反馈 / 功能建议：https://github.com/gxc/gaussdb-ro-mcp/issues
获取最新版本：https://github.com/gxc/gaussdb-ro-mcp/releases/latest
提交 PR 前，请确保 go vet ./... 与 go test ./... 通过；涉及安全防护逻辑（SQL 静态校验 / 只读强制）的改动请附带回归测试

Read the full README →View source on GitHub →

Related MCP Servers

View all in Developer Tools View all alternatives

Reviews

No reviews yet — be the first to share how this listing worked for you.

Frequently Asked Questions about Gaussdb Ro MCP

AllMCPs Directory Badge

Full Badge Customizer

Showcase your server listing on GitHub or your project documentation. Embed this dynamic SVG badge to highlight official listing status and live engagement.

Badge Style:

Live Dynamic SVG Preview

Markdown (GitHub README)

[![AllMCPs](https://allmcps.com/api/badge/gaussdb-ro-mcp?style=directory)](https://allmcps.com/mcp/gaussdb-ro-mcp)

HTML Embed

<a href="https://allmcps.com/mcp/gaussdb-ro-mcp"><img src="https://allmcps.com/api/badge/gaussdb-ro-mcp?style=directory" alt="Gaussdb Ro MCP on AllMCPs" /></a>

Technical Specs & Signals

CategoryDeveloper Tools

27Quality signal: Emerging · 27/100How this signal is calculated ▾

Server availabilityNot measured

Not scored for repo-hosted servers — we can't reach the running server, only its GitHub page. Hosted MCP endpoints are health-checked live.

Verified ownership8/20

Documentation & tools11/30

Adoption & activity1/15

Community engagement0/10

★ Spotlight Slot

Feature Your MCP Server

Get maximum visibility for your server across our directory, search results, and detail pages.

Spotlight Your Server

Own this project?

Free dofollow backlink: add your website and place the AllMCPs badge on it — no claim needed. We detect it automatically and keep it verified as long as the badge stays live.

Claim & get free dofollow

Share & Embed

Add our SVG badge (dark/light directory styles) or embeddable widget to your site.

Explore more

More in 💻 Developer Tools →Best MCP servers for Developers →Alternatives to Gaussdb Ro MCP →Install in Claude Desktop Install in Cursor Install in VS Code Setup guides for all 13 MCP clients