Postgresql MCP Server

🚀 PostgreSQL MCP 服務器

PostgreSQL MCP 服務器是一個提供 PostgreSQL 數據庫管理功能的 Model Context Protocol (MCP) 服務器。它能夠幫助分析現有 PostgreSQL 設置，提供實現指導，並調試數據庫問題。

🚀 快速開始

此服務器可幫助你輕鬆管理 PostgreSQL 數據庫。你可以使用它分析數據庫配置和性能、獲取安裝指導以及調試常見問題。

✨ 主要特性

1. 數據庫分析 (analyze_database)

分析 PostgreSQL 數據庫配置和性能指標，具體包括：

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

2. 安裝說明 (get_setup_instructions)

提供 PostgreSQL 安裝和配置的分步指導，涵蓋：

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

3. 數據庫調試 (debug_database)

調試常見 PostgreSQL 問題，例如：

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

💻 使用示例

基礎用法

數據庫分析

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

安裝說明

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

數據庫調試

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

高級用法

錯誤處理

try {
  const result = await postgresqlMCPService.analyzeDatabase({
    connectionString: "postgresql://user:password@localhost:5432/dbname",
    analysisType: "performance"
  });
  console.log(result);
} catch (error) {
  console.error("發生錯誤：", error.message);
}

📦 安裝指南

先決條件

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

通過 Smithery 安裝

要通過 Smithery 自動安裝：

npm install -g @nahmanmate/postgresql-mcp-server

手動安裝

克隆倉庫並運行：

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm start

🔧 技術細節

開發

如果你想進行開發，可以按照以下步驟操作：

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm run dev

安全考慮

• 確保 PostgreSQL 服務器的安全配置
• 使用強密碼和訪問控制
• 定期備份數據庫
• 監控性能和錯誤

最佳實踐

• 使用連接池管理數據庫連接
• 配置適當的查詢超時
• 使用基於角色的訪問控制
• 啟用日誌記錄和監控

📄 許可證

MIT License

Copyright (c) 2024 nahmanmate

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

🤝 貢獻指南

要貢獻代碼，請 fork 倉庫並在主分支上提交您的更改。