🚀 Ollama MCP 数据库助手
Ollama MCP 数据库助手结合了 Ollama 的大语言模型 (LLM) 功能与 PostgreSQL 数据库，通过 Model Context Protocol (MCP) 协议实现了交互式聊天界面。用户可以用自然语言提问关于数据的问题，获得由真实 SQL 查询支持的 AI 驱动响应。
🚀 快速开始
本工具可让你以自然语言与 PostgreSQL 数据库交互，获取数据洞察。按以下步骤操作，即可快速开启数据探索之旅。
✨ 主要特性
- 🌐 自然语言接口：支持使用自然语言访问 PostgreSQL 数据库。
- 🤖 自动生成 SQL：自动生成 SQL 查询，无需手动编写。
- 📊 基于模式响应：根据数据库模式生成准确响应。
- 💬 交互式界面：提供交互式聊天界面，操作便捷。
- 🔒 安全访问：仅提供只读数据库访问，保障数据安全。
📦 安装指南
先决条件
- Node.js 16 或更高版本
- 正在运行的 PostgreSQL 数据库
- Ollama 已安装并正在本地运行
- Ollama 中拉取了 qwen2.5-coder:7b-instruct 模型
安装步骤
- 克隆仓库：
git clone [your-repo-url]
cd [your-repo-name]
- 安装依赖项：
npm install
- 拉取所需的 Ollama 模型：
ollama pull qwen2.5-coder:7b-instruct
- 在项目根目录中创建一个
.env文件：
DATABASE_URL=postgresql://user:password@localhost:5432/dbname
OLLAMA_MODEL=qwen2.5-coder:7b-instruct # 可选，默认值为 qwen2.5-coder:7b-instruct
💻 使用示例
基础用法
- 启动聊天界面：
npm start
- 提问关于您数据的问题，以自然语言形式输入：
已连接到数据库。您可以现在提问关于您的数据。
输入 "exit" 退出。
您想了解的数据是什么？上个月哪些产品产生了最多的收入？
正在分析...
[AI 将生成并执行一个 SQL 查询，然后解释结果]
- 输入 'exit' 退出应用程序。
📚 详细文档
工作原理
- 应用程序通过 PostgreSQL MCP 服务器 连接到您的 PostgreSQL 数据库。
- 加载并缓存您的数据库模式。
- 当您提问时：
- 模式和问题发送到 Ollama。
- Ollama 生成适当的 SQL 查询。
- 查询通过 MCP 执行。
- 结果返回到 Ollama 进行解释。
- 您收到自然语言的响应。
环境变量
| 属性 | 详情 |
|---|---|
| 变量名 | 描述 |
| DATABASE_URL | PostgreSQL 连接字符串，必需 |
| OLLAMA_MODEL | Ollama 模型名称，默认值为 qwen2.5-coder:7b-instruct |
安全
- 仅限只读访问。
- SQL 查询限制。
开发信息
使用的技术：TypeScript、MCP、Node.js 等。
故障排除
常见问题
- 无法连接到数据库
- 检查 DATABASE_URL 是否正确。
- 确保 PostgreSQL 服务正在运行。
- Ollama 未响应
- 确保 Ollama 已安装并运行。
- 检查网络连接。
- 环境变量配置错误
- 核对 .env 文件中的值是否正确。
📄 许可证
[此处填写许可证信息]
🤝 贡献指南
欢迎贡献！请参考 贡献指南