🚀 Postgres MCP（研究项目）

Postgres MCP 是一个为 PostgreSQL 数据库实现的 Model Control Protocol (MCP) 服务器。它提供简单的 HTTP 接口，可通过 MCP 与数据库交互，支持执行只读查询和探索数据库资源。

🚀 快速开始

本项目为 PostgreSQL 数据库实现了 MCP 服务器，借助其 HTTP 接口，你能轻松与数据库交互。下面为你介绍快速开启使用的步骤。

✨ 主要特性

• 🌟 符合 MCP 协议的 HTTP 服务器，确保与 MCP 标准兼容。
• 🔍 只读 SQL 查询执行，保障数据安全性。
• 📋 数据库资源列表，方便查看数据库资源。
• ⚙️ 通过 .env 文件支持环境变量，灵活配置项目。
• 🐹 使用 Go 语言和 Gin Web 框架构建，保证高效稳定。

📦 安装指南

先决条件

• Go 1.23.6 或更高版本
• PostgreSQL 数据库
• Git

安装步骤

git clone https://github.com/ipfans/postgres-mcp.git
cd postgres-mcp
go mod download

💻 使用示例

配置数据库连接

可以通过两种方式配置数据库连接：

方式一：使用命令行标志

go run cmd/postgres-mcp/main.go -db "postgres://user:password@localhost:5432/dbname"

方式二：使用环境变量

• 在项目根目录创建一个 .env 文件
• 添加你的数据库 URL：

DATABASE_URL=postgres://user:password@localhost:5432/dbname

启动服务器

go run cmd/postgres-mcp/main.go

服务器将在默认端口 8080 启动。

与 MCP 端点交互

列出数据库资源

POST http://localhost:8080/mcp
Content-Type: application/json

{
    "type": "function",
    "name": "resources"
}

执行只读查询

POST http://localhost:8080/mcp
Content-Type: application/json

{
    "type": "function",
    "name": "query",
    "arguments": {
        "query": "SELECT * FROM your_table LIMIT 10"
    }
}

📄 许可证

该项目是开源的，采用 MIT 许可证。

💪 贡献

欢迎贡献！请随意提交拉取请求。