PostgreSQL MCP Server

PostgreSQL MCP 服务器

提供 PostgreSQL 数据库管理功能的模型上下文协议 (MCP) 服务器。该服务器可协助分析现有 PostgreSQL 设置、提供实施指导以及调试数据库问题。

特征

1.数据库分析（ analyze_database ）

分析 PostgreSQL 数据库配置和性能指标：

• 配置分析
• 性能指标
• 安全评估
• 优化建议

2. 设置说明（ get_setup_instructions ）

提供分步 PostgreSQL 安装和配置指南：

• 特定于平台的安装步骤
• 配置建议
• 安全最佳实践
• 安装后任务

3. 数据库调试（ debug_database ）

调试常见的 PostgreSQL 问题：

• 连接问题
• 性能瓶颈
• 锁冲突
• 复制状态

先决条件

• Node.js >= 18.0.0
• PostgreSQL 服务器（用于目标数据库操作）
• 对目标 PostgreSQL 实例的网络访问

安装

通过 Smithery 安装

要通过Smithery自动为 Claude Desktop 安装 PostgreSQL MCP 服务器：

手动安装

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. 定期安全审核和更新

错误处理

服务器实现了全面的错误处理：

• 连接失败
• 查询超时
• 身份验证错误
• 权限问题
• 资源限制

运行评估和测试

evals 包会加载一个 mcp 客户端，然后运行 index.ts 文件，因此测试之间无需重新构建。您可以在此处查看完整文档。

贡献

1. 分叉存储库
2. 创建功能分支
3. 提交你的更改
4. 推送到分支
5. 创建拉取请求

执照

该项目根据 AGPLv3 许可证获得许可 - 有关详细信息，请参阅 LICENSE 文件。