PostgreSQL MCP Server

PostgreSQL MCP Server

site icon
2025.04.10 10
TypeScript数据库管理PostgreSQL数据库
PostgreSQL MCP Server 是一个基于模型上下文协议(MCP)的服务,专门用于提供 PostgreSQL 数据库管理能力。该服务能够帮助用户分析现有的 PostgreSQL 配置、提供实施指导以及调试数据库问题。
View on GitHub

Overview

基本能力

产品定位

PostgreSQL MCP Server 是一个专注于 PostgreSQL 数据库管理的工具,提供分析、设置指导和调试功能。

核心功能

  1. 数据库分析 (analyze_database)
  2. 分析 PostgreSQL 数据库的配置和性能指标
  3. 提供配置分析、性能指标、安全评估和优化建议

  4. 设置指导 (get_setup_instructions)

  5. 提供 PostgreSQL 安装和配置的逐步指导
  6. 包括平台特定的安装步骤、配置建议、安全最佳实践和安装后任务

  7. 数据库调试 (debug_database)

  8. 调试常见的 PostgreSQL 问题
  9. 包括连接问题、性能瓶颈、锁冲突和复制状态

适用场景

  • 数据库管理员需要快速分析和优化 PostgreSQL 数据库
  • 开发人员需要指导如何正确安装和配置 PostgreSQL
  • 运维人员需要调试和解决数据库运行中的问题

工具列表

  1. 数据库分析工具:提供详细的数据库配置和性能分析报告。
  2. 设置指导工具:生成平台特定的安装和配置步骤。
  3. 调试工具:帮助诊断和解决数据库运行中的问题。

常见问题解答

  • 如何确保连接安全? 使用 SSL/TLS 连接和验证连接字符串。
  • 如何防止 SQL 注入? 服务器会验证 SQL 查询并防止危险操作。
  • 如何处理认证错误? 服务器支持多种认证方法并实施基于角色的访问控制。

使用教程

使用依赖

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

安装教程

  1. 克隆仓库
  2. 安装依赖: bash npm install
  3. 构建服务器: bash npm run build
  4. 添加到 MCP 设置文件: json { "mcpServers": { "postgresql-mcp": { "command": "node", "args": ["/path/to/postgresql-mcp-server/build/index.js"], "disabled": false, "alwaysAllow": [] } } }

调试方式

  • 启动开发服务器: bash npm run dev
  • 运行测试: bash npm test
  • 运行 ESLint: bash npm run lint

许可证

该项目遵循 AGPL-3.0 开源许可条款,请参阅 AGPL-3.0 了解完整条款。