Postgresql MCP Server P15

🚀 PostgreSQL MCP 服務器

本項目是一個模型上下文協議 (MCP) 服務器，允許用戶通過 MCP 協議連接到 PostgreSQL 數據庫。它藉助 MCP 協議公開資源、工具和提示，為與 PostgreSQL 數據庫的交互提供便利。

🚀 快速開始

該 MCP 服務器允許外部應用程序通過 POST 請求，將數據庫憑證共享到 SSE（服務器發送事件）端點。之後，服務器會建立與指定 PostgreSQL 數據庫的連接，並提供多種交互方式。

✨ 主要特性

架構

服務器採用模塊化架構，各部分職責明確：

• 服務器核心：負責處理 MCP 協議的實現與協調工作。
• 資源：提供數據庫實體的數據和元數據。
• 工具：實現數據庫操作，如查詢、連接、表管理等。
• 提示：提供自然語言處理提示。

功能

資源

查詢歷史記錄

• 內存存儲：供開發階段使用。
• Redis 存儲：在生產環境中，當提供 REDIS_URL 時使用。

工具

1. 生成查詢：
   • 依據描述生成 SQL 查詢。
   • 參數：描述、表名、數據庫類型（默認值：'postgresql'）
2. 分析查詢：
   • 分析 SQL 查詢的性能和潛在問題。
   • 參數：查詢、數據庫類型（默認值：'postgresql'）
3. 解釋架構：
   • 以自然語言解釋數據庫架構。
   • 參數：架構 JSON

📦 安裝指南

環境變量

📚 詳細文檔

API 端點

資源相關

• GET /api/stats：獲取數據庫統計信息。
• POST /api/query：執行查詢操作。
• DELETE /api/clear-history：清除查詢歷史記錄。

💻 使用示例

MCP 檢查器測試

使用 MCP 檢查器 對服務器進行測試：

# 安裝 MCP 檢查器
npm install -g @modelcontextprotocol/inspector

# 啟動檢查器
mcp-inspector --server-url http://localhost:3000

🤝 貢獻指南

歡迎大家積極貢獻！請隨時提交 Pull Request。

📄 許可證

本項目採用 MIT 許可證，具體詳情請參閱 LICENSE 文件。