Postgresql Database Management Server

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP（模型上下文協議）服務器是一款用於管理和操作 PostgreSQL 數據庫的工具。它具備數據庫分析、調試、模式管理、數據遷移和即時監控等多種功能，能有效提升數據庫管理的效率和質量。

🚀 快速開始

使用 PostgreSQL MCP 服務器前，需要滿足一定的先決條件，然後按照安裝步驟進行操作。

先決條件

• Node.js >= 18.0.0
• PostgreSQL 服務器（用於目標數據庫操作）
• 網絡訪問到目標 PostgreSQL 實例

安裝步驟

1. 克隆倉庫。
2. 安裝依賴：

   npm install
   

3. 構建服務器：

   npm run build
   

4. 將以下內容添加到 MCP 設置文件中：

   {
     "mcpServers": {
       "postgresql-mcp": {
         "command": "node",
         "args": ["/path/to/postgresql-mcp-server/build/index.js"],
         "disabled": false,
         "alwaysAllow": [],
         "env": {
           "POSTGRES_CONNECTION_STRING": "postgresql://username:password@server:port/dbname"
         }
       }
     }
   }
   

✨ 主要特性

1. 數據庫分析

• 描述：提供對 PostgreSQL 數據庫的全面分析，包括性能指標和健康檢查。
• 示例：

  // 分析數據庫性能
  const analysis = await postgresqlMcpServer.analyzeDatabase(connectionString);
  

2. 數據庫調試

• 描述：幫助識別和解決數據庫中的問題，包括查詢優化和錯誤排查。
• 示例：

  // 調試具體查詢
  const debugResult = await postgresqlMcpServer.debugQuery(connectionString, query);
  

3. 模式管理

• 描述：提供對數據庫模式的管理和操作功能，包括表、索引和視圖等。
• 示例：

  // 獲取數據庫模式
  const schema = await postgresqlMcpServer.getSchema(connectionString);
  

4. 數據遷移

• 描述：支持在不同的 PostgreSQL 數據庫之間遷移數據，包括過濾和清理操作。
• 示例：

  // 遷移數據
  await postgresqlMcpServer.migrateData(sourceConnectionString, targetConnectionString);
  

5. 即時監控

• 描述：提供對 PostgreSQL 數據庫的即時監控功能，包括性能指標、查詢活動和鎖信息。
• 示例：

  // 監控數據庫狀態
  const monitoringResult = await postgresqlMcpServer.monitorDatabase(connectionString);
  

💻 使用示例

基礎用法

以下是使用 PostgreSQL MCP 服務器進行數據庫分析的基礎示例：

// 分析數據庫性能
const analysis = await postgresqlMcpServer.analyzeDatabase(connectionString);

高級用法

在實際應用中，你可能需要結合多個功能來完成複雜的數據庫管理任務。例如，先進行數據庫分析，然後根據分析結果進行數據遷移：

// 分析數據庫性能
const analysis = await postgresqlMcpServer.analyzeDatabase(sourceConnectionString);
// 根據分析結果決定是否遷移數據
if (analysis.needMigration) {
  await postgresqlMcpServer.migrateData(sourceConnectionString, targetConnectionString);
}

🔧 技術細節

開發相關命令

• npm run dev - 啟動開發服務器，帶有熱重載
• npm run lint - 運行 ESLint
• npm test - 運行測試

安全注意事項

連接安全

• 使用連接池
• 實現連接超時
• 驗證連接字符串
• 支持 SSL/TLS 連接

查詢安全

• 驗證 SQL 查詢
• 防止危險操作
• 實施查詢超時
• 記錄所有操作

身份驗證

• 支持多種身份驗證方法
• 實現基於角色的訪問控制
• 執行密碼策略
• 安全管理連接憑證

最佳實踐

1. 始終使用安全的連接字符串，包含適當的憑據
2. 遵循生產環境的安全建議
3. 定期監控和分析數據庫性能
4. 保持 PostgreSQL 版本更新
5. 實施適當的數據備份策略
6. 使用連接池以優化資源管理
7. 實現適當的錯誤處理和日誌記錄
8. 定期進行安全審核和更新

錯誤處理

服務器實現全面的錯誤處理，包括連接失敗、查詢超時、身份驗證錯誤和鎖定問題等。

🤝 貢獻指南

請參考項目倉庫中的貢獻指南，瞭解如何為 PostgreSQL MCP 服務器做貢獻。

📄 許可證

該項目遵循 LICENSE 協議。