Postgres

🚀 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 許可證。

💪 貢獻

歡迎貢獻！請隨意提交拉取請求。