Postgresql Model Context Protocol (pg Mcp) Server 7fh

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

PG - MCP 服務器是專為 PostgreSQL 數據庫設計的模型上下文協議（MCP）服務器，具備 AI 代理增強功能，能為 AI 代理提供全面 API，用於發現、連接、查詢和理解 PostgreSQL 數據庫。

更多關於 pg - mcp 項目的信息，請參考：[https://stuzero.github.io/pg - mcp/](https://stuzero.github.io/pg - mcp/)

🚀 快速開始

安裝

先決條件

• Python 3.13+
• PostgreSQL 數據庫

使用 Docker

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

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

手動安裝

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

# 安裝依賴項並創建虛擬環境（.venv）
uv sync

# 激活虛擬環境
source .venv/bin/activate  # 在 Windows 上：.venv\Scripts\activate

# 運行服務器
python -m server.app

安裝完成後的使用說明

1. 啟動服務器：

   python -m server.app
   

2. 訪問 API 文檔： 打開瀏覽器，訪問 http://localhost:8000/docs 查看交互式 API 文檔。

3. 使用命令行工具： 使用 pg_query 和 pg_explain 命令與數據庫進行交互。

示例

# 執行查詢
pg_query -H localhost -P 5432 -U postgres -d testdb -q "SELECT * FROM users LIMIT 10;"

# 分析執行計劃
pg_explain -H localhost -P 5432 -U postgres -d testdb -q "SELECT COUNT(*) FROM orders;"

✨ 主要特性

連接管理

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

查詢工具

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

模式發現資源

• 列出模式及其描述
• 列出表及其描述和行數
• 獲取列詳細信息，包括數據類型和描述
• 查看錶約束和索引
• 探索數據庫擴展

數據訪問資源

• 表樣本數據（帶分頁）
• 獲取近似行數

擴展上下文

內置關於 PostgreSQL 擴展的上下文信息，例如：

• PostGIS：空間數據類型、函數和示例
• pgvector：向量相似性搜索功能和最佳實踐 其他擴展可通過 YAML 配置文件輕鬆添加。

🔧 技術細節

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

該實現基於並擴展了 參考 PostgreSQL MCP 實現，具有一些關鍵增強功能：

1. 完整的服務器實現：作為生產環境使用的完整服務器，帶 SSE 傳輸
2. 多數據庫支持：同時連接到多個 PostgreSQL 數據庫
3. 豐富的目錄信息：提取並公開數據庫目錄中的表/列描述
4. 擴展上下文：提供詳細基於 YAML 的有關 PostgreSQL 擴展（如 PostGIS 和 pgvector）的知識
5. 查詢解釋：包含專門用於分析查詢執行計劃的工具
6. 強大的連接管理：處理數據庫連接生命週期的高效連接管理與安全的連接 ID 處理

PG - MCP 服務器採用分層架構設計，主要組件包括：

• Web 服務：基於 FastAPI 實現 RESTful API
• 數據庫適配器：支持 PostgreSQL 的連接池和事務管理
• 查詢解釋器：集成 PostgreSQL 執行計劃分析工具
• 文檔生成：自動生成 API 文檔（如 Swagger）

📚 詳細文檔

參考資料

1. FastAPI 官方文檔
2. PostgreSQL 官方文檔
3. 模型上下文協議 (MCP) 規範