article
README
🚀 模型上下文协议 PostgreSQL 服务器
本项目实现了一个支持与 PostgreSQL 数据库连接的模型上下文协议 (MCP) 服务器,可让 AI 模型通过标准化协议与数据库进行交互,为数据交互提供了便捷且高效的解决方案。
🚀 快速开始
本服务器允许 AI 模型通过标准化协议与您的 PostgreSQL 数据库交互。以下是启动服务器的步骤:
先决条件
- Node.js 20 或更高版本
- PostgreSQL 数据库
- 数据库访问凭证
安装
- 克隆此仓库
- 安装依赖:
npm install
配置
服务器从项目根目录的 .env 文件中读取配置。请确保文件包含以下内容:
DB_HOST=your-database-host
DB_PORT=your-database-port
DB_NAME=your-database-name
DB_USER=your-database-user
DB_PASSWORD=your-database-password
启动服务器
- 启动服务器:
node server.js
- 访问管理界面:在浏览器中打开
http://localhost:3000
✨ 主要特性
- 使用连接池连接到 PostgreSQL 数据库
- 实现了用于 AI 模型交互的 Model Context Protocol (MCP)
- 提供数据库表结构信息作为资源
- 支持执行 SQL 查询并带有重试逻辑
- 平滑处理连接错误
📦 安装指南
克隆仓库
首先,将项目仓库克隆到本地:
git clone [仓库地址]
安装依赖
进入项目目录,安装所需的依赖:
npm install
💻 使用示例
基础用法
启动服务器:
node server.js
启动后,您可以在浏览器中打开 http://localhost:3000 访问管理界面。
📚 详细文档
环境变量配置
请确保以下环境变量已正确设置:
DB_HOST: 数据库主机地址DB_PORT: 数据库端口号DB_NAME: 数据库名称DB_USER: 数据库用户名DB_PASSWORD: 数据库用户密码
项目结构
project/
├── server.js # 主服务器文件
├── package.json # 依赖管理文件
└── .env # 环境变量配置文件
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group