MCP Server Postgres

🚀 PostgreSQL 模型上下文協議（Model Context Protocol）服務器

這是一個專為 PostgreSQL 數據庫提供只讀訪問功能的模型上下文協議服務器。藉助該服務器，大型語言模型（LLMs）能夠查看數據庫架構，並執行只讀查詢，為數據交互提供了便利。

🚀 快速開始

要將此服務器與 Claude Desktop 應用一起使用，請在 claude_desktop_config.json 文件的 "mcpServers" 部分添加以下配置：

Docker

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

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

NPX

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

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

✨ 主要特性

• 為 PostgreSQL 數據庫提供只讀訪問，保障數據安全。
• 支持大型語言模型查看數據庫架構並執行只讀查詢。
• 提供每個表的架構信息，方便數據探查。

📦 安裝指南

Docker 構建

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

💻 使用示例

工具使用

query

• 執行針對連接到數據庫的 PostgreSQL 數據庫的只讀 SQL 查詢。
• 輸入：sql (字符串)：要執行的 SQL 查詢。
• 所有查詢都在 READ ONLY（只讀）事務中執行。

📚 詳細文檔

組件

工具

• query：可執行針對連接到數據庫的 PostgreSQL 數據庫的只讀 SQL 查詢。輸入為 sql 字符串，代表要執行的 SQL 查詢，且所有查詢都在只讀事務中執行。

資源

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

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

使用 Claude Desktop 的方法

在使用 Claude Desktop 應用時，需在 claude_desktop_config.json 文件的 "mcpServers" 部分添加相應配置。對於 Docker 和 NPX 有不同的配置方式，具體如下：

Docker

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

NPX

按給定的 JSON 格式進行配置，將 /mydb 替換為實際的數據庫名稱。

📄 許可證

此 MCP 服務器根據 MIT 許可證發佈。這意味著您可以自由使用、修改和分發軟件，但需遵守 MIT 許可證的條款和條件。更多詳細信息，請參閱項目存儲庫中的 LICENSE 文件。