PG_MCP_SERVER

<div align="center">为 PostgreSQL + PostGIS 提供支持的自定义实现</div>

简介

中文文档

一个通用的 PostgreSQL MCP 服务器。 MCP 部分使用 go-mcp 实现，支持 Stdio 和 SSE 传输。

PostGIS 和 PgVector 的描述来自另一个开源项目：https://github.com/stuzero/pg-mcp-server 🙏🙏🙏 这种提供上下文的方式令人耳目一新。

⚠️ 数据库需要定义角色以防止 SQL 注入。 授予 public 模式的 SELECT 权限以防止敏感数据泄露。 ⚠️ 授予新角色对 temp 模式的所有权限，以确保数据隔离。

特性

在本地部署 LLM 时，需要有效地管理上下文。 每次调用都读取数据库模式会消耗时间和大量的 token 上下文。 本项目采用预处理方法。 它原生支持从数据库获取表结构，并向 LLM 提供描述性信息：

• 利用工具描述和输入模式来隐式或显式地传达模式信息。
• 在初始化期间利用 MCP 资源来读取表名、列、约束、外键、索引、几何类型和 EPSG 代码，为大型模型创建基本理解。

安装

在 main.go 中：

// 在这里您可以设置用于数据库交互的连接字符串
schemaLoadConnID, err := dbService.RegisterConnection(tempCtx, "postgres://mcp_user:mcp123456@192.168.2.19:5432/postgres")

格式为 postgres://user:pass@host:port/db 或者，您可以通过取消注释并设置 SCHEMA_LOAD_DB_URL 变量来通过 .env 进行配置。 在这里，RegisterConnection 为服务器提供了一个初始连接字符串，用于缓存数据库表信息。 🏁 建议创建一个专用的服务器角色。 SQL 如下：

-- 创建一个新角色并设置密码
CREATE ROLE mcp_user WITH LOGIN PASSWORD 'mcp123456';

-- 设置 mcp_user 的基本权限
GRANT CONNECT ON DATABASE postgres TO mcp_user;
GRANT USAGE ON SCHEMA public TO mcp_user;

-- 授予对 public 模式中所有现有表的 SELECT 权限
GRANT SELECT ON ALL TABLES IN SCHEMA public TO mcp_user;

-- 自动授予对 public 模式中未来表的 SELECT 权限给 mcp_user
ALTER DEFAULT PRIVILEGES IN SCHEMA public
   GRANT SELECT ON TABLES TO mcp_user;

-- 创建一个 temp 模式
CREATE SCHEMA temp;

-- 授予对 temp 模式的所有权限给 mcp_user
GRANT USAGE, CREATE ON SCHEMA temp TO mcp_user;
GRANT SELECT, INSERT, UPDATE, DELETE ON ALL TABLES IN SCHEMA temp TO mcp_user;

-- 授予对 temp 模式中未来表的所有权限给 mcp_user
ALTER DEFAULT PRIVILEGES IN SCHEMA temp
   GRANT SELECT, INSERT, UPDATE, DELETE ON TABLES TO mcp_user;
Use code with caution.

运行

• 🐋 使用 Docker 运行

git clone https://github.com/cbc3929/pg_mcp_server.git
cd pg_mcp_server
docker build -t pg-mcp-server:latest .
docker run -d -p 8181:8181 --name my-mcp-server pg-mcp-server:latest

• 🀄 直接运行

1. 克隆项目

git clone https://github.com/cbc3929/pg_mcp_server.git
cd pg_mcp_server

2. 安装依赖

go mod tidy

或者

go mod download

3. 直接运行 确保设置了必要的环境变量或存在 .env 文件

go run ./cmd/server/main.go

4. 构建 (可选)

go build -o pg_mcp_server ./cmd/server/main.go
./pg_mcp_server

扩展支持

PostGIS ✅ PgVector ✅ PgRouting ⭕

TODO / 未完成

• temp 模式中表的管理：应实施表清理/回收机制。
• 单元测试。