Nahmanmate Postgresql MCP Server

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP 服務器基於 Model Context Protocol (MCP) 構建，為 PostgreSQL 數據庫提供專業的管理功能。它能夠深入分析現有 PostgreSQL 設置，提供詳細的實現指導，還能高效調試各類數據庫問題。

✨ 主要特性

1. 數據庫分析 (analyze_database)

此功能可對 PostgreSQL 數據庫的配置和性能指標進行全面分析，具體包括：

• 配置分析
• 性能指標評估
• 安全評估
• 優化建議

// 示例用法
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance" // 可選： "configuration" | "performance" | "security"
}

2. 安裝說明 (get_setup_instructions)

該功能提供 PostgreSQL 安裝和配置的詳細分步指導，涵蓋：

• 平臺特定安裝步驟
• 配置推薦
• 安全最佳實踐
• 安裝後任務

// 示例用法
{
  "platform": "linux", // 必需： "linux" | "macos" | "windows"
  "version": "15", // 可選： PostgreSQL 版本
  "useCase": "production" // 可選： "development" | "production"
}

3. 數據庫調試 (debug_database)

此功能可調試常見的 PostgreSQL 問題，例如：

• 連接問題
• 性能瓶頸
• 鎖衝突
• 複製狀態

// 示例用法
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance", // 必需： "connection" | "performance" | "locks" | "replication"
  "logLevel": "debug" // 可選： "info" | "debug" | "trace"
}

📦 安裝指南

先決條件

• 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": []
       }
     }
   }
   

💻 使用示例

基礎用法

// 數據庫分析示例
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "analysisType": "performance"
}

// 安裝說明示例
{
  "platform": "linux",
  "version": "15",
  "useCase": "production"
}

// 數據庫調試示例
{
  "connectionString": "postgresql://user:password@localhost:5432/dbname",
  "issue": "performance",
  "logLevel": "debug"
}

🔧 技術細節

開發相關

• npm run dev：啟動開發服務器並帶有熱重載功能。
• npm run lint：運行 ESLint 進行代碼檢查。
• npm test：運行測試。

安全注意事項

1. 連接安全
   • 使用連接池，提高連接效率。
   • 實現連接超時，避免資源浪費。
   • 驗證連接字符串，確保連接的安全性。
   • 支持 SSL/TLS 連接，保障數據傳輸安全。
2. 查詢安全性
   • 驗證 SQL 查詢，防止惡意查詢。
   • 防止危險操作，保護數據庫安全。
   • 實施查詢超時，避免長時間佔用資源。
   • 記錄所有操作，便於後續審計。
3. 身份驗證
   • 支持多種身份驗證方法，增強安全性。
   • 實現基於角色的訪問控制，精確管理權限。
   • 執行密碼策略，保障密碼安全。
   • 安全管理連接憑證，防止憑證洩露。

最佳實踐

1. 始終使用安全的連接字符串和適當的憑據。
2. 遵循生產環境的安全推薦。
3. 定期監控和分析數據庫性能。
4. 保持 PostgreSQL 版本更新，獲取最新功能和安全補丁。
5. 實施正確的備份策略，防止數據丟失。
6. 使用連接池以優化資源管理。
7. 實現適當的錯誤處理和日誌記錄，便於問題排查。
8. 定期進行安全審核和更新，確保系統安全。

錯誤處理

服務器實現了全面的錯誤處理機制，可應對以下情況：

• 連接失敗
• 查詢超時
• 身份驗證錯誤
• 權限問題
• 資源限制

🤝 貢獻指南

1. 叉存倉庫。
2. 創建功能分支。
3. 提交更改。
4. 推送到分支。
5. 創建 Pull Request。

📄 許可證

本項目根據 AGPLv3 許可證發佈 - 有關詳細信息，請參閱 LICENSE 文件。