PostgreSQL MCP Server

PostgreSQL MCP Server

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

Overview

基本能力

产品定位

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

核心功能

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

  4. 设置指导 (get_setup_instructions)

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

  7. 数据库调试 (debug_database)

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

适用场景

  1. 数据库性能优化:通过分析性能指标,提供优化建议。
  2. 数据库设置与配置:为新项目或现有项目提供 PostgreSQL 的安装和配置指导。
  3. 问题排查与调试:快速定位和解决数据库运行中的问题。

工具列表

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

常见问题解答

  1. 连接问题:检查连接字符串和网络访问权限。
  2. 性能问题:使用性能分析工具识别瓶颈。
  3. 安全问题:遵循安全最佳实践,如使用 SSL/TLS 连接。

使用教程

使用依赖

  1. Node.js >= 18.0.0 bash node --version
  2. PostgreSQL 服务器 bash psql --version
  3. 网络访问权限:确保可以访问目标 PostgreSQL 实例。

安装教程

  1. 克隆仓库 bash git clone <repository-url>
  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": [] } } }

调试方式

  1. 启动开发服务器 bash npm run dev
  2. 运行测试 bash npm test
  3. 检查代码规范 bash npm run lint

许可证

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