关键词

数据库工具JSON-RPCSSE编辑器集成会话管理

项目简介

DB MCP Server 是一个实现了数据库模型上下文协议（DB MCP）的高性能服务器。它旨在为VS Code、Cursor等LLM客户端应用提供数据库操作的标准化接口，使得客户端可以通过一致的方式发现和调用数据库工具，从而简化数据库访问和管理。

主要功能点:

  • 灵活的传输方式: 支持服务器发送事件（SSE）传输协议，提供稳定的连接处理。
  • 标准化的消息格式: 基于JSON-RPC的消息格式，保证互操作性。
  • 动态工具注册: 允许在运行时注册、发现和调用数据库工具。
  • 编辑器集成: 为VS Code和Cursor等编辑器提供原生支持。
  • 会话管理: 提供完善的会话跟踪和持久化机制。
  • 结构化错误处理: 提供全面的错误报告，方便调试。
  • 性能优化: 设计为高吞吐量和低延迟。

安装步骤:

  1. 安装Go环境: 确保已安装 Go 1.18 或更高版本。
  2. 克隆仓库: 使用 'git clone https://github.com/FreePeak/db-mcp-server.git' 命令克隆仓库到本地。
  3. 配置环境变量: 复制 '.env.example' 文件并重命名为 '.env'，根据需要修改配置文件中的数据库连接信息、端口等。
  4. 构建服务器: 在仓库根目录下运行 'make build' 命令编译服务器。
  5. 运行服务器:
    • 本地运行: 运行编译生成的可执行文件 './mcp-server'。
    • Docker运行: 可以使用 'docker-compose up -d' 命令通过Docker Compose 启动包含MySQL数据库的服务，或者使用 'docker build -t db-mcp-server .' 和 'docker run -p 9090:9090 db-mcp-server' 命令构建并运行Docker镜像。

服务器配置:

MCP客户端需要配置 MCP 服务器的连接信息。以Cursor 编辑器为例，需要在 '.cursor/mcp.json' 文件中添加如下配置：

{
    "mcpServers": {
        "db-mcp-server": {
            "url": "http://localhost:9090/sse"
        }
    }
}

配置参数说明：

  • server name: 'db-mcp-server' (服务器名称，可以自定义)
  • command: 无需配置，服务器已在运行，客户端通过URL连接
  • args: 无需配置，通过URL参数传递会话信息
  • url: 'http://localhost:9090/sse' (DB MCP Server 的 SSE 接口地址，端口号根据实际服务器配置修改)

基本使用方法:

  1. 启动 DB MCP Server: 根据安装步骤启动 DB MCP Server。
  2. 配置 MCP 客户端: 在 MCP 客户端（如 Cursor 编辑器）中配置 DB MCP Server 的连接信息（如上面的 'mcp.json' 配置）。
  3. 连接数据库: 在 MCP 客户端中，通过配置好的 DB MCP Server 连接到您的数据库。
  4. 使用数据库工具: 利用客户端提供的数据库工具（例如查询执行、数据修改等）进行数据库操作。DB MCP Server 将处理客户端请求，提供增强的数据库操作能力，例如更好的错误报告、事务管理、参数绑定等。

信息

分类

数据库与文件

访问项目