🚀 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 文件。