Postgresql MCP Server Y4k

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP 服務器是一個用於與 PostgreSQL 數據庫交互的 Model Context Protocol (MCP) 服務器，支持讀取查詢、寫入查詢、創建表和列出表等功能，為數據庫操作提供了便捷的解決方案。

🚀 快速開始

安裝步驟

先決條件

• PostgreSQL 數據庫實例
• Go 語言開發環境
• Make 工具

克隆倉庫

git clone https://github.com/yourusername/pgmcp.git
cd pgmcp

安裝依賴

go mod tidy

構建服務器

make build

配置說明

將以下環境變量添加到項目的 .env 文件中：

• DB_NAME: PostgreSQL 數據庫名稱
• DB_USER: 連接數據庫的用戶名
• DB_PASSWORD: 用戶密碼
• DB_HOST: 數據庫主機地址（默認為 localhost）
• DB_PORT: 數據庫端口號（默認為 5432）

示例 .env 文件：

DB_NAME=postgres
DB_USER=pguser
DB_PASSWORD=pgpassword
DB_HOST=localhost
DB_PORT=5432

運行服務器

go run main.go

MCP 配置

在 config.json 中配置 MCP 服務參數：

{
  "name": "PostgreSQL MCP Server",
  "version": "1.0",
  "description": "A PostgreSQL MCP server implementation.",
  "tools": {
    "read_query": {
      "description": "Execute a SELECT query and return the results."
    },
    "write_query": {
      "description": "Execute an INSERT, UPDATE, or DELETE statement."
    },
    "create_table": {
      "description": "Create a new table in the database."
    },
    "list_tables": {
      "description": "List all tables in the database."
    }
  }
}

✨ 主要特性

• 讀取查詢：執行 SELECT 類型的 SQL 查詢。
• 寫入查詢：執行 INSERT、UPDATE 和 DELETE 類型的 SQL 操作。
• 創建表：在數據庫中創建新表。
• 列出表：獲取數據庫中的所有表信息。

💻 使用示例

基礎用法

讀取查詢

{
  "tool": "read_query",
  "params": {
    "query": "SELECT * FROM users LIMIT 10;"
  }
}

寫入查詢

{
  "tool": "write_query",
  "params": {
    "query": "INSERT INTO users (name, email) VALUES ($1, $2);",
    "args": ["John Doe", "john@example.com"]
  }
}

創建表

{
  "tool": "create_table",
  "params": {
    "table_name": "users",
    "schema": "CREATE TABLE users (\n    id SERIAL PRIMARY KEY,\n    name VARCHAR(255) NOT NULL,\n    email VARCHAR(255) UNIQUE NOT NULL\n);"
  }
}

列出表

{
  "tool": "list_tables",
  "params": {}
}

🔧 技術細節

安全注意事項

• 服務器對查詢類型進行驗證，確保每個工具僅執行其允許的操作。
• 對輸入的 schema 名稱進行 sanitization，防止 SQL 注入攻擊。
• 建議使用權限受限的專用數據庫用戶。
• 在生產環境中啟用 SSL，設置 DB_SSLMODE 為 require 或更高。

依賴項

• github.com/joho/godotenv - 加載 .env 文件
• github.com/lib/pq - PostgreSQL 驅動程序
• github.com/mark3labs/mcp-go - MCP 協議的 Go SDK

📄 許可證

[在此處添加許可信息]

🤝 貢獻指南

[在此處添加貢獻指南]