Postgresql MCP

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP 服務器可提供 PostgreSQL 數據庫表的增刪改查（CRUD）操作。藉助該服務器，用戶能方便地與 PostgreSQL 數據庫交互，對指定表執行各類操作。

🚀 快速開始

此 MCP 服務器允許您通過一組工具與 PostgreSQL 數據庫交互，對指定的表執行增刪改查操作。該服務器使用 FastMCP 庫，並以標準輸入輸出模式運行，使其與各種 MCP 客戶端兼容。

✨ 主要特性

• 連接 PostgreSQL 數據庫
• 對指定表執行增刪改查操作
• 表級和列級訪問控制
• 數據庫表結構檢查
• 執行自定義 SQL 查詢
• 通過 YAML 文件配置

📦 安裝指南

1. 克隆此倉庫：

   git clone https://github.com/yourusername/postgresql-mcp.git
   cd postgresql-mcp
   

2. 安裝所需的依賴項：

   pip install -r requirements.txt
   

📚 詳細文檔

配置

服務器通過 config.yaml 文件進行配置。此文件包含：

1. 數據庫連接詳細信息
2. 表配置，包括：
   • 哪些表是可訪問的
   • 允許哪些列進行操作
   • 允許哪些操作（創建、讀取、更新、刪除）

示例配置：

database:
  host: localhost
  port: 5432
  dbname: postgres
  user: postgres
  password: postgres
  
tables:
  - name: users
    allowed_columns:
      - id
      - name
      - email
      - created_at
    allowed_operations:
      - create
      - read
      - update
      - delete
  
  - name: products
    allowed_columns:
      - id
      - name
      - price
      - description
      - category
    allowed_operations:
      - create
      - read
      - update
      - delete

使用

運行 MCP 服務器：

python postgresql_mcp_server.py

服務器將以標準輸入輸出模式啟動，準備接收來自 MCP 客戶端的命令。

可用 MCP 工具

list_tables

列出配置中的所有表。

response = list_tables()

create_record

在指定表中創建新記錄。

response = create_record(
    table_name="users",
    data={
        "name": "John Doe",
        "email": "john@example.com"
    }
)

read_records

從指定表中讀取記錄，帶可選過濾條件。

response = read_records(
    table_name="users",
    filters={"name": "John Doe"},
    limit=10,
    offset=0
)

update_record

更新指定表中的記錄。

response = update_record(
    table_name="users",
    record_id=1,
    data={"email": "newemail@example.com"},
    id_column="id"
)

delete_record

從指定表中刪除記錄。

response = delete_record(
    table_name="users",
    record_id=1,
    id_column="id"
)

execute_query

執行自定義 SQL 查詢。

response = execute_query(
    query="SELECT * FROM users WHERE age > %s",
    params=[18]
)

get_table_schema

獲取特定表的架構信息。

response = get_table_schema(table_name="users")

響應格式

所有工具都返回標準響應格式：

{
  "status": "success",
  "message": "Optional message",
  "records": [...],  // 用於讀取操作
  "record": {...},   // 用於創建和更新操作
  "count": 10        // 用於讀取操作
}

如果發生錯誤，響應狀態將為 error，幷包含錯誤消息。

⚠️ 注意事項

⚠️ 重要提示

• 數據庫連接信息需要根據實際情況配置。
• 表和列的訪問控制嚴格遵循配置文件中的定義。
• 所有 SQL 查詢都需要通過參數化方式執行以防止注入攻擊。