PostgreSQL MCP 服务器

一个提供 PostgreSQL 数据库管理功能的 Model Context Protocol (MCP) 服务器。此服务器帮助分析现有 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": []
       }
     }
   }
   

开发

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