Postgresql Mcp Ddz

by fanzhenddz

244 downloads
Not rated
GitHub

About

Postgresql Mcp Ddz is a PostgreSQL database operation server built on the Model Context Protocol (MCP). It enables AI assistants to interact with PostgreSQL databases through a standardized interface, supporting query execution, data modification, schema inspection, and…

Details

Author
fanzhenddz
Downloads
244
Categories
Database

- Execute parameterized SELECT queries
- Perform INSERT, UPDATE, and DELETE operations
- List database tables and view table structures
- Analyze query performance with EXPLAIN
- Supports both environment variable and manual connection

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 Postgresql Mcp Ddz
    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

Install with npm install postgresql-mcp-ddz or run directly via npx postgresql-mcp-ddz. Configure automatic database connection by setting environment variables (POSTGRES_HOST, POSTGRES_PORT, POSTGRES_USER, POSTGRES_PASSWORD, POSTGRES_DB) in your MCP client, or use the connect_db tool to connect manually. Once connected, invoke tools like query, execute, list_tables, describe_table, explain, and show_statement to interact with the database.

connect_db

Connect to a PostgreSQL database

query

Execute a SELECT query and return results

execute

Execute an INSERT, UPDATE, or DELETE query

list_tables

List all tables in the database

describe_table

Get the structure of a specific table

explain

Analyze SQL query performance using EXPLAIN

show_statement

Execute a SHOW statement (e.g., SHOW STATUS, SHOW VARIABLES)

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "postgresql mcp ddz": {
            "postgresql-mcp-ddz": {
                "command": "npx",
                "args": [
                    "postgresql-mcp-ddz"
                ],
                "env": {
                    "POSTGRES_HOST": "127.0.0.1",
                    "POSTGRES_PORT": "5432",
                    "POSTGRES_USER": "postgres",
                    "POSTGRES_PASSWORD": "your_password",
                    "POSTGRES_DB": "your_database"
                }
            }
        }
    }
}

McpServers

{
    "postgresql-mcp-ddz": {
        "command": "npx",
        "args": [
            "postgresql-mcp-ddz"
        ],
        "env": {
            "POSTGRES_HOST": "127.0.0.1",
            "POSTGRES_PORT": "5432",
            "POSTGRES_USER": "postgres",
            "POSTGRES_PASSWORD": "your_password",
            "POSTGRES_DB": "your_database"
        }
    }
}

PostgreSQL MCP Server

一个基于模型上下文协议(MCP)的 PostgreSQL 数据库操作服务器,让 AI 助手能够通过标准化接口与 PostgreSQL 数据库交互。

功能特性

- 查询执行:执行带参数化的 SELECT 查询 - 数据修改:执行 INSERT、UPDATE、DELETE 操作 - 结构查询:列出数据库表、查看表结构 - 性能分析:使用 EXPLAIN 分析查询性能 - 连接管理:支持环境变量自动连接,安全可靠

安装

``bash npm install postgresql-mcp-ddz ` 或直接使用 npx: `bash npx postgresql-mcp-ddz `

配置

方式一:环境变量自动连接(推荐)

在 MCP 客户端配置中添加环境变量,服务器启动时会自动连接数据库:
`json { "mcpServers": { "postgresql-mcp-ddz": { "command": "npx", "args": ["postgresql-mcp-ddz"], "env": { "POSTGRES_HOST": "127.0.0.1", "POSTGRES_PORT": "5432", "POSTGRES_USER": "postgres", "POSTGRES_PASSWORD": "your_password", "POSTGRES_DB": "your_database" } } } } ` 支持的环境变量: | 变量名 | 说明 | 必填 | |--------|------|------| | POSTGRES_HOST | 数据库主机地址 | 是 | | POSTGRES_PORT | 数据库端口(默认 5432) | 否 | | POSTGRES_USER | 数据库用户名 | 是 | | POSTGRES_PASSWORD | 数据库密码 | 是 | | POSTGRES_DB | 数据库名称 | 是 |

方式二:手动连接

不在配置中添加环境变量时,需要通过
connect_db 工具手动连接: `json { "mcpServers": { "postgresql": { "command": "npx", "args": ["postgresql-mcp-ddz"] } } } `

可用工具

connect_db

连接到 PostgreSQL 数据库(环境变量配置后可省略此步骤)。 参数: - host(字符串,必填):数据库主机地址 - port(数字,可选):数据库端口,默认 5432 - user(字符串,必填):数据库用户名 - password(字符串,必填):数据库密码 - database(字符串,必填):数据库名称 示例: `json { "host": "localhost", "port": 5432, "user": "postgres", "password": "password", "database": "mydb" } `

query

执行 SELECT 查询并返回结果。 参数: - sql(字符串,必填):SQL SELECT 查询语句 - params(数组,可选):查询参数 示例: `json { "sql": "SELECT FROM users WHERE age > $1", "params": [18] } `

execute

执行 INSERT、UPDATE 或 DELETE 查询。 参数: - sql(字符串,必填):SQL 语句 - params(数组,可选):查询参数 示例: `json { "sql": "INSERT INTO users (name, email) VALUES ($1, $2)", "params": ["张三", "zhangsan@example.com"] } `

list_tables

列出当前数据库中的所有表。

describe_table

获取指定表的结构信息,包括列、主键和外键。 参数: - table(字符串,必填):表名 示例: `json { "table": "users" } `

explain

使用 EXPLAIN 分析 SQL 查询性能。 参数: - sql(字符串,必填):要分析的 SQL 查询 示例: `json { "sql": "SELECT
FROM users WHERE email = 'test@example.com'" } `

show_statement

执行 SHOW 语句。 参数: - sql(字符串,必填):SHOW SQL 语句 示例: `json { "sql": "SHOW ALL" } `

安全说明

-
query 工具仅允许 SELECT、SHOW、EXPLAIN 和 WITH 查 - 数据修改操作请使用 execute` 工具 - 所有查询支持参数化输入,防止 SQL 注入 - 数据库凭据仅在运行时传递,不会被持久化存储
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.