openGauss

by howardqin

315 downloads
Not rated
GitHub

About

An MCP server for interacting with the openGauss database.

Details

Author
howardqin
Downloads
315
Categories
Database, Other, Developer Tools
Tags
#sql

- Built with FastMCP 2.0

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name openGauss
    Command (node, npx, python, etc.)

    Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Clone the repository, copy .env.example to .env, and run uv sync (requires Python ≥3.12 and uv). Configure openGauss connection parameters via .env or environment variables (host, port, user, password, dbname). Start the server with uv run server.py --transport=<stdio|sse|streamable-http> and optional flags for port, host, and path. For Claude Desktop, add a Stdio command to claude_desktop_config.json as shown in the README.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

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

McpServers

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

Model Context Protocol Server for openGauss

- Build with FastMCP 2.0 .
- Support Stdio, SSE and Streamable-Http transporting method.
- MCP server transporting method, listerning port, host and path are Configurable via command-line argument.
- openGauss connection parameters are configurable via environment variables or .env files.

Note: uv and python >= 3.12 is required.

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

openGauss connection parameters are loaded from .env, for example:

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

These parameters can be overwriten if identical environment variables are set.

Claude Desktop only supports Stdio mode, so we add the Stdio starting command in claude_desktop_config.json:

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

CherryStudio supports all three transporting modes: Stdio, SSE and Streamable-Http

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

For SSE transport mode, we need to start a standalone mcp server, run following command in project root directory, or in any directory with --directory specifing project root dir :

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

Then configure CherryStudio to connect to sse mcp server:

For Streamable-Http, we need to start a standalone mcp server, run following command in project root directory, or in any directory with --directory specifing project root dir:

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

Then configure CherryStudio to connect to streamable-http mcp server:

Official MCP server for dbt (data build tool) providing integration with dbt Core/Cloud CLI, project metadata discovery, model information, and semantic layer querying capabilities.

Open source MCP server specializing in easy, fast, and secure tools for Databases.

Query and analyze data with MotherDuck and local DuckDB

Query Streams securely connects MCP clients to live databases through the Query Streams Cloud Network, with no VPNs, inbound ports, or complex setup.

Interact with the SingleStore database platform

Official Supabase MCP server for managing Supabase projects, databases, auth, storage, edge functions, and SQL workflows from AI agents.

A collection of tools for managing the platform, addressing data quality and reading and writing to Teradata Database.

Multi-database agent access (PostgreSQL, SQLite, MySQL, Oracle, SQL Server) with batch queries, pre-configured connections, and SQLGlot-enforced read-only safety

No reviews yet — be the first

Sign in to leave a review

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.