🚀 PostgreSQL MCP 服务器
一个允许用户通过 MCP 协议连接到 PostgreSQL 数据库的模型上下文协议 (MCP) 服务器。此服务器借助 MCP 协议公开资源、工具和提示，以实现与 PostgreSQL 数据库的交互，为用户提供便利的数据库操作体验。
🚀 快速开始
该 MCP 服务器允许外部应用程序通过 POST 请求将数据库凭证共享到 SSE（服务器发送事件）端点。随后，服务器会建立到指定 PostgreSQL 数据库的连接，并提供多种交互方式。
✨ 主要特性
架构特性
服务器采用模块化架构，各部分职责明确：
- 服务器核心：负责处理 MCP 协议的实现与协调工作。
- 资源：提供数据库实体的数据和元数据。
- 工具：实现各类数据库操作，如查询、连接、表管理等。
- 提示：提供自然语言处理提示。
功能特性
资源
- 查询历史记录：
- 内存存储：适用于开发阶段。
- Redis 存储：当在生产环境中提供 REDIS_URL 时使用。
工具
- 生成查询：
- 依据描述生成 SQL 查询。
- 参数：描述、表名、数据库类型（默认值：'postgresql'）
- 分析查询：
- 分析 SQL 查询的性能和潜在问题。
- 参数：查询、数据库类型（默认值：'postgresql'）
- 解释架构：
- 以自然语言解释数据库架构。
- 参数：架构 JSON
📦 安装指南
环境变量
| 变量名 | 详情 |
|---|---|
| NODE_ENV | 设置环境（development/production），示例：'development' |
| PORT | 应用程序端口，示例：3000 |
| REDIS_URL | Redis 服务 URL，示例：'redis://localhost:6379' |
📚 详细文档
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 文件。