Postgres

🚀 Postgres MCP（研究项目）

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

🚀 快速开始

Postgres MCP是一个用于PostgreSQL数据库的MCP服务器，可通过HTTP接口与之交互。以下是使用前的准备和启动步骤。

先决条件

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

安装

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

配置

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

1. 使用命令行标志：

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

2. 使用环境变量：
   • 在项目根目录创建一个.env文件。
   • 添加你的数据库URL：

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

启动服务器

go run cmd/postgres-mcp/main.go

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

✨ 主要特性

• 符合MCP协议的HTTP服务器，提供标准化的交互方式。
• 支持只读SQL查询执行，保障数据安全性。
• 可列出数据库资源，方便用户了解数据库情况。
• 通过.env文件支持环境变量，灵活配置数据库连接。
• 使用Go语言和Gin Web框架构建，保证高性能和开发效率。

💻 使用示例

基础用法

列出数据库资源

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许可证。

🤝 贡献

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