openGauss MCP server build with FastMCP

openGauss 的 Model Context Protocol 服务

功能

• 使用 FastMCP 2.0 构建。
• 支持 Stdio、SSE 和 Streamable-Http 传输方式。
• MCP 服务的传输方式、监听端口、主机和路径均可通过命令行参数配置。
• openGauss 连接参数可通过环境变量或 .env 文件配置。

部署

注意：需要 uv 和 Python >= 3.12。

git clone https://github.com/HowardQin/fastmcp-opengauss.git
cd fastmcp-opengauss
cp .env.example .env
uv sync

openGauss 连接参数从 .env 文件中加载，例如：

OPENGAUSS_HOST=172.32.148.228
OPENGAUSS_PORT=31001
OPENGAUSS_USER=app
OPENGAUSS_PASSWORD=Postgres1234
OPENGAUSS_DBNAME=app

如果设置了同名环境变量，这些参数可以被覆盖。

在 Claude Desktop 中使用

Claude Desktop 仅支持 Stdio 模式，因此我们在 claude_desktop_config.json 中添加 Stdio 启动命令：

{
    "mcpServers": {
        "openGauss": {
            "command": "uv",
            "args": [
                "--directory",
                "C:\\Users\\qinh\\fastmcp-opengauss",
                "run",
                "server.py",
                "--transport",
                "stdio"
            ]
        }
    }
}

在 CherryStudio 中使用

CherryStudio 支持三种传输模式：Stdio、SSE 和 Streamable-Http

Stdio：

参数：

--directory
C:\Users\qinh\fastmcp-opengauss
run
server.py
--transport=stdio

SSE：

对于 SSE 传输模式，我们需要启动独立的 MCP 服务。在项目根目录中运行以下命令，或在任何目录中使用 --directory 指定项目根目录：

uv --directory C:\Users\qinh\fastmcp-opengauss run .\server.py --transport=sse --port=8000 --path=/sse --host=0.0.0.0

然后配置 CherryStudio 以连接到 SSE MCP 服务：

Streamable-Http：

对于 Streamable-Http，我们需要启动独立的 MCP 服务。在项目根目录中运行以下命令，或在任何目录中使用 --directory 指定项目根目录：

uv --directory C:\Users\qinh\fastmcp-opengauss run .\server.py --transport=streamable-http --port=8000 --path=/mcp --host=0.0.0.0

然后配置 CherryStudio 以连接到 Streamable-Http MCP 服务：