Postgres MCP

🚀 PostgreSQL 模型上下文協議 (Model Context Protocol) 服務器

本服務器提供對 PostgreSQL 數據庫的只讀訪問功能，藉助它，大型語言模型（LLMs）能夠查看數據庫架構並執行只讀查詢，為數據交互提供便利。

🚀 快速開始

若要將此服務器與 Claude Desktop 應用程序配合使用，需在 claude_desktop_config.json 文件的 "mcpServers" 部分添加相應配置。具體配置方式如下：

Docker

{
  "mcpServers": {
    "postgres": {
      "command": "docker",
      "args": [
        "run", 
        "-i", 
        "--rm", 
        "mcp/postgres", 
        "postgresql://host.docker.internal:5432/mydb"
      ]
    }
  }
}

⚠️ 重要提示

當在 macOS 上運行 Docker 且服務器運行在主機網絡（例如 localhost）時，請使用 host.docker.internal。同時，用戶名/密碼可以添加到 PostgreSQL URL 中，格式為 postgresql://user:password@host:port/db-name。

NPX

{
  "mcpServers": {
    "postgres": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-postgres",
        "postgresql://localhost/mydb"
      ]
    }
  }
}

請將 /mydb 替換為您的數據庫名稱。

✨ 主要特性

工具

• query
  • 可執行針對連接數據庫的只讀 SQL 查詢。
  • 輸入參數為 sql（字符串），即要執行的 SQL 查詢。
  • 所有查詢均在 READ ONLY 事務中執行。

資源

該服務器能提供每個表的架構信息：

• 表架構 (postgres://<host>/<table>/schema)
  • 以 JSON 格式呈現每個表的架構信息。
  • 包含列名和數據類型。
  • 這些信息會自動從數據庫元數據中發現。

📦 安裝指南

Docker 構建

docker build -t mcp/postgres -f src/postgres/Dockerfile .

📄 許可證

此 MCP 服務器依據 MIT License 進行分發。這意味著您可以自由使用、修改和分發該軟件，但需遵循 MIT License 的條款和條件。有關詳細信息，請查閱項目存儲庫中的 LICENSE 文件。