MCP Server Postgres

🚀 PostgreSQL 模型上下文協議（PG-MCP）服務器

PG-MCP服務器專為PostgreSQL數據庫設計，能增強AI代理功能。它藉助模型上下文協議（MCP），為AI代理提供強大支持，使其可更好地發現、連接、查詢和理解PostgreSQL數據庫。

🚀 快速開始

若你想使用PG - MCP服務器，可按以下步驟操作：

安裝

先決條件

• Python 3.13+
• PostgreSQL數據庫

使用Docker

# 克隆倉庫
git clone https://github.com/stuzero/pg-mcp.git
cd pg-mcp

# 使用Docker Compose構建並運行
docker-compose up -d

手動安裝

# 克隆倉庫
git clone https://github.com/stuzero/pg-mcp.git
cd pg-mcp

# 創建並激活虛擬環境
python -m venv .venv
source .venv/bin/activate  # Windows用戶請使用：.venv\Scripts\activate

# 使用uv安裝
uv sync --frozen

# 啟動服務器
python -m server.app

測試服務器功能

倉庫包含測試腳本用於驗證服務器功能：

# 基本服務器功能測試
python test.py "postgresql://username:password@hostname:port/database"

# 使用Claude進行自然語言到SQL的轉換
python client/claude_cli.py "Show me the top 5 customers by total sales"

✨ 主要特性

完整的服務器實現

作為生產環境使用的SSE傳輸完整服務器，為生產環境的使用提供了可靠保障。

多數據庫支持

可同時連接多個PostgreSQL數據庫，滿足多樣化的業務需求。

豐富的目錄信息

提取並暴露數據庫目錄中的表/列描述，方便用戶更好地瞭解數據庫結構。

擴展上下文

提供詳細的YAML格式知識，關於PostgreSQL擴展如PostGIS和pgvector，助力用戶深入使用數據庫擴展功能。

查詢解釋

內置專門工具用於分析查詢執行計劃，幫助用戶優化查詢性能。

robust連接管理

完善的連接生命週期管理及安全的連接ID處理，確保數據庫連接的穩定與安全。

💻 使用示例

連接管理

• Connect 工具：註冊PostgreSQL連接字符串並獲取一個安全連接ID。
• Disconnect 工具：顯式關閉數據庫連接。
• 連接池：高效的連接管理。

查詢工具

• pg_query：使用連接ID執行只讀SQL查詢。
• pg_explain：分析查詢執行計劃並返回JSON格式結果。

📚 詳細文檔

PG - MCP是模型上下文協議在PostgreSQL數據庫上的一個完整服務器實現，通過MCP的資源導向架構為AI代理提供全面的API，用於發現、連接、查詢和理解PostgreSQL數據庫。

該實現基於並擴展了參考PostgreSQL MCP實現。

模型上下文協議（MCP）服務器的架構

該服務器基於以下組件構建：

• MCP：模型上下文協議基礎。
• FastMCP：用於MCP的Python庫。
• asyncpg：異步PostgreSQL客戶端。
• YAML：用於擴展上下文信息。