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 实例的网络访问

安装

通过 Smithery 安装

要通过 Smithery 自动安装：

npm install -g @nahmanmate/postgresql-mcp-server

手动安装

克隆仓库并运行：

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm start

开发

git clone https://github.com/nahmanmate/postgresql-mcp-server.git
cd postgresql-mcp-server
npm install
npm run dev

安全考虑

• 确保 PostgreSQL 服务器的安全配置
• 使用强密码和访问控制
• 定期备份数据库
• 监控性能和错误

最佳实践

• 使用连接池管理数据库连接
• 配置适当的查询超时
• 使用基于角色的访问控制
• 启用日志记录和监控

错误处理

try {
  const result = await postgresqlMCPService.analyzeDatabase({
    connectionString: "postgresql://user:password@localhost:5432/dbname",
    analysisType: "performance"
  });
  console.log(result);
} catch (error) {
  console.error("发生错误：", error.message);
}

贡献指南

要贡献代码，请 fork 仓库并在主分支上提交您的更改。

许可证

MIT License

Copyright (c) 2024 nahmanmate

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.