MCP Server Template

🚀 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 替換為您自己的數據庫名稱。

✨ 主要特性

工具

• query
  • 執行針對連接數據庫的只讀 SQL 查詢
  • 輸入：sql (字符串)：要執行的 SQL 查詢
  • 所有查詢均在只讀事務中執行

資源

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

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

📦 安裝指南

Docker

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

📄 許可證

該 MCP 服務器基於 MIT License 許可證。這意味著您可以自由使用、修改和分發軟件，但需遵守 MIT License 的條款。有關詳細信息，請參閱項目倉庫中的 LICENSE 文件。