PostgreSQL MCP 服务器

一个允许用户通过 MCP 协议连接到 PostgreSQL 数据库的模型上下文协议 (MCP) 服务器。此服务器通过 MCP 协议公开资源、工具和提示，用于与 PostgreSQL 数据库交互。

概述

该 MCP 服务器允许外部应用程序通过 POST 请求将数据库凭证共享到 SSE（服务器发送事件）端点。然后服务器建立到指定 PostgreSQL 数据库的连接，并提供多种方式与其交互。

架构

服务器遵循模块化架构，职责分明：

• 服务器核心 - 处理 MCP 协议实现和协调
• 资源 - 提供数据库实体的数据和元数据
• 工具 - 实现数据库操作（查询、连接、表管理）
• 提示 - 提供自然语言处理提示

功能

资源

查询历史记录

• 内存存储：开发中使用
• Redis 存储：生产环境中当提供 REDIS_URL 时使用

工具

1. 生成查询：

   • 基于描述生成 SQL 查询。
   • 参数：描述、表名、数据库类型（默认值：'postgresql'）

2. 分析查询：

   • 分析 SQL 查询的性能和问题。
   • 参数：查询、数据库类型（默认值：'postgresql'）

3. 解释架构：

   • 用自然语言解释数据库架构。
   • 参数：架构 JSON

安装说明

环境变量

API 端点

资源相关

• GET /api/stats：获取数据库统计信息
• POST /api/query: 执行查询
• DELETE /api/clear-history: 清除查询历史

使用说明

MCP 检查器测试

使用 MCP 检查器 测试服务器：

# 安装 MCP 检查器
npm install -g @modelcontextprotocol/inspector

# 启动检查器
mcp-inspector --server-url http://localhost:3000

贡献指南

欢迎贡献！请随意提交 Pull Request。

许可证

本项目使用 MIT 许可证，详情见 LICENSE 文件。