PostgreSQL Alchemy

🚀 使用MCP与您的数据库对话

本项目可让您借助MCP与数据库进行交互。通过设置MCP服务器，您能使用Claude Desktop与PostgreSQL数据库实现交互，同时该项目底层使用sqlalchemy，也适用于MySQL、MariaDB、SQLite。本项目基于https://github.com/runekaagaard/mcp-alchemy构建。

🚀 快速开始

✨ 主要特性

• 支持通过Claude Desktop与多种数据库（如PostgreSQL、MySQL、MariaDB、SQLite）进行交互。
• 基于sqlalchemy实现，具有良好的兼容性。
• 借助Docker Compose和环境变量配置，方便快捷地搭建服务。

📦 安装指南

前提条件

• Docker Compose：安装说明
• Claude Desktop：此处下载
• uv：一个现代、高性能的Python包管理器。如果没有安装，请按照以下说明操作。

具体步骤

1. 设置环境变量
   • 复制并重命名环境文件，将提供的.env.example文件复制并命名为.env：

   cp .env.example .env
   

2. 设置Claude Desktop
   • 访问Claude Desktop下载页面并安装该应用程序。
3. 使用Dummy数据启动PostgreSQL数据库
   • 确保Docker Compose已安装并运行，执行以下命令：

   docker-compose up -d
   

   • 此命令将在localhost:5432启动一个PostgreSQL数据库，并使用Dummy数据进行填充。
4. 安装uv（如果没有安装）
   • 执行以下命令以安装uv：

   curl -LsSf https://astral.sh/uv/install.sh | sh
   

5. 配置并启动MCP服务器
   • 创建/更新MCP服务器配置，将以下JSON配置保存到您的MCP服务器配置文件中（根据需要调整路径）：

   {
   "mcpServers": {
   "my_database": {
   "command": "uv",
   "args": [
   "--directory",
   "/directory/where/this/app/is/located/app/",
   "run",
   "server.py"
   ],
   "env": {
   "DB_URL": "postgresql://postgres:password@localhost:5432/mydatabase"
   }
   }
   }
   }
   

   • 提示：如果uv安装在非标准位置，请更新"command"值以反映可执行文件的完整路径。
   • 配置就绪后，每次启动Claude Desktop时，MCP服务器都会自动启动。

💻 使用示例

完成上述安装和配置步骤后，您就可以开始使用MCP与数据库进行交互了：

1. 打开Claude Desktop。
2. 工具将自动调用您的MCP服务器，从而让您无缝地与数据库交互。

📚 详细文档

总结

1. 设置环境变量：复制.env.example到.env。
2. 安装并运行Claude Desktop：从Claude Desktop下载。
3. 使用Docker Compose启动PostgreSQL：运行docker-compose up以启动带有Dummy数据的数据库。
4. 安装uv：运行提供的安装命令（如果需要）。
5. 配置MCP服务器：更新配置文件，并确保路径和环境变量正确。
6. 启动并享受乐趣：启动Claude Desktop开始通过MCP与您的数据库交互。

🔧 注意事项

⚠️ 重要提示

本指南假设您对Docker、环境变量和CLI使用有基本的了解。

如果您遇到任何问题或需要进一步帮助，请参考相关文档或联系支持团队。祝您编程愉快！