Pg MCP Server

🚀 PostgreSQL MCP 服務器指南

本指南詳細介紹了 PostgreSQL MCP 服務器的使用方法，包括項目結構、核心腳本、協議實現、環境變量配置等內容，幫助您高效、安全地管理 PostgreSQL 數據庫。

📦 安裝指南

文檔未提及安裝步驟，暫不提供相關內容。

🏗️ 目錄結構

項目結構如下：

• dist：存放編譯後的 JavaScript 文件
• src：核心庫文件
• package.json：依賴管理和構建腳本配置
• tsconfig.json：TypeScript 編譯配置

✨ 主要特性

• 負責初始化和管理 PostgreSQL 數據庫連接，處理事務，並提供數據庫操作接口。
• 提供高效的數據庫連接池，支持高併發訪問。
• 實現事務提交、回滾功能，並提供超時保護機制。
• 執行 SQL 查詢並返回結果集。
• 獲取數據庫表結構信息。

🔧 技術細節

核心腳本說明

目的與功能

這些腳本負責初始化和管理 PostgreSQL 數據庫連接，處理事務，並提供數據庫操作接口。

主要腳本

• index.ts
  • 作用：初始化 MCP 服務器。
  • 功能：
    • 解析命令行參數。
    • 連接 PostgreSQL 數據庫。
    • 啟動監控線程。
    • 處理客戶端請求。
• connection - pool.ts
  • 作用：管理數據庫連接池。
  • 功能：
    • 創建和管理數據庫連接池。
    • 實現連接複用機制。
    • 設置連接超時參數。
    • 監控連接狀態。
• transaction - monitor.ts
  • 作用：監控事務執行狀態。
  • 功能：
    • 記錄事務開始時間。
    • 檢查事務超時情況。
    • 自動回滾長時間未提交的事務。
    • 提供事務統計信息。

MCP 協議實現

功能模塊

• 連接管理：提供高效的數據庫連接池，支持高併發訪問。
• 事務控制：實現事務提交、回滾功能，並提供超時保護機制。
• 查詢執行：執行 SQL 查詢並返回結果集。
• 元數據獲取：獲取數據庫表結構信息。

💻 使用示例

基礎用法

const { McpServer } = require('./dist/mcp-server');

// 初始化 MCP 服務器
const server = new McpServer({
  connectionString: 'postgresql://用戶名:密碼@數據庫地址:端口/數據庫名',
  transactionTimeoutMs: 15000,
  maxConnections: 20
});

// 啟動服務器
server.start();

示例使用場景

執行查詢

SELECT * FROM users WHERE age > 18;

執行數據修改

INSERT INTO users (name, age) VALUES ('張三', 25);

查看錶結構

獲取表 "users" 的詳細信息

列出所有表

列出數據庫中的所有表

📚 詳細文檔

環境變量配置

附錄

錯誤代碼

返回值格式

{
  "code": number,
  "data": any,
  "message": string
}

⚠️ 注意事項

• 數據庫用戶需具備相應操作權限。

• 生產環境建議使用更嚴格的超時設置。

• 長時間運行的事務會自動回滾以防資源佔用。

• DML 操作需顯式提交才能永久生效。

• 禁止在配置文件中明文存儲敏感信息。

• 建議定期備份數據庫。

• 確保數據庫憑據不洩露。

• 配置適當的訪問控制策略。

• 定期審計數據庫操作日誌。

• 使用 SSL 加密數據庫連接。

通過以上配置和使用，您可以高效、安全地管理 PostgreSQL 數據庫。