MCP Postgres Server

🚀 MCP PostgreSQL 服務器

MCP PostgreSQL 服務器是一個提供 PostgreSQL 數據庫操作的模型上下文協議（MCP）服務器。它為 AI 模型提供了標準化接口，使其能夠與 PostgreSQL 數據庫進行交互。

🚀 快速開始

MCP PostgreSQL 服務器可助力 AI 模型與 PostgreSQL 數據庫進行交互，以下為你介紹它的安裝、配置及使用方法。

📦 安裝指南

手動安裝

你可以使用以下命令進行安裝：

npm install mcp-postgres-server

或者直接運行：

npx mcp-postgres-server

🔧 配置

服務器需要配置以下環境變量：

{
  "mcpServers": {
    "postgres": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "mcp-postgres-server"],
      "env": {
        "PG_HOST": "your_host",
        "PG_PORT": "5432",
        "PG_USER": "your_user",
        "PG_PASSWORD": "your_password",
        "PG_DATABASE": "your_database"
      }
    }
  }
}

💻 使用示例

基礎用法

1. connect_db

使用提供的憑證建立與 PostgreSQL 數據庫的連接。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "connect_db",
  arguments: {
    host: "localhost",
    port: 5432,
    user: "your_user",
    password: "your_password",
    database: "your_database"
  }
});

2. query

執行 SELECT 查詢，支持可選的預處理語句參數。支持 PostgreSQL 樣式（$1, $2）和 MySQL 樣式 (?) 參數佔位符。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "query",
  arguments: {
    sql: "SELECT * FROM users WHERE id = $1",
    params: [1]
  }
});

3. execute

執行 INSERT、UPDATE 或 DELETE 查詢，支持可選的預處理語句參數。支持 PostgreSQL 樣式（$1, $2）和 MySQL 樣式 (?) 參數佔位符。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "execute",
  arguments: {
    sql: "INSERT INTO users (name, email) VALUES ($1, $2)",
    params: ["John Doe", "john@example.com"]
  }
});

4. list_schemas

列出數據庫中的所有架構。

use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_schemas",
  arguments: {}
});

5. list_tables

列出數據庫中的表。接受一個可選的架構參數（默認為 'public'）。

// 列出 'public' 架構中的表（默認）
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {}
});

// 列出特定架構中的表
use_mcp_tool({
  server_name: "postgres",
  tool_name: "list_tables",
  arguments: {
    schema: "my_schema"
  }
});

6. describe_table

獲取特定表格的結構。接受一個可選的架構參數（默認為 'public'）。

// 描述 'public' 架構中的表（默認）
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users"
  }
});

// 描述特定架構中的表
use_mcp_tool({
  server_name: "postgres",
  tool_name: "describe_table",
  arguments: {
    table: "users",
    schema: "my_schema"
  }
});

✨ 主要特性

• 安全連接處理，帶有自動清理功能
• 支持預處理語句以防止 SQL 注入
• 支持 PostgreSQL 樣式（$1, $2）和 MySQL 樣式 (?) 參數佔位符
• 全面的錯誤處理和驗證
• TypeScript 支持
• 自動化連接管理
• 支持 PostgreSQL 特定語法和功能
• 多架構支持

🔒 安全性

• 使用預處理語句防止 SQL 注入
• 通過環境變量支持密碼等敏感信息的安全存儲
• 強化的身份驗證機制

🛠️ 錯誤處理

• 明確的錯誤返回機制
• 詳細的錯誤日誌記錄
• 可自定義的錯誤處理邏輯

📄 許可證

``` （原文檔此處許可證內容為空，故保留原樣）