项目简介

Sequel MCP Server 是一个专为数据库设计的 Model Context Protocol (MCP) 服务器实现。它允许你通过支持 MCP 协议的客户端（如 Claude, Cursor, WindSurf）直接查询和访问你的数据库。该服务器支持 PostgreSQL, MySQL, ClickHouse 三种主流数据库，旨在为 AI 应用提供结构化数据的便捷访问能力，提升 LLM 在处理数据库相关任务时的效率和准确性。

主要功能点

数据库连接与查询: 支持连接到 PostgreSQL, MySQL, ClickHouse 数据库，并允许通过 MCP 客户端执行 SQL 查询。
Schema 上下文提供: 自动提取数据库 schema 信息，并以结构化的方式提供给 MCP 客户端，帮助 LLM 理解数据库结构，生成更准确的 SQL 查询或进行上下文学习。
资源管理: 将数据库 Schema 作为资源进行管理，MCP 客户端可以请求读取 Schema 信息。
工具注册与执行: 注册 "query" 和 "schema" 两个工具，分别用于执行 SQL 查询和获取数据库 Schema，允许 MCP 客户端调用这些工具来完成数据库操作。
JSON-RPC 通信: 通过标准的 JSON-RPC 协议与 MCP 客户端通信。
Stdio 传输协议: 使用 Stdio 作为默认的传输协议，简化部署和集成。
配置灵活: 支持通过环境变量 'DATABASE_URL' 配置数据库连接字符串。

安装步骤

安装 Sequel MCP Server CLI: 打开终端，运行以下命令安装 Sequel MCP Server 的命令行工具：
```
npx -y @sequelsh/mcp@latest install
```
或者，如果需要安装特定数据库类型的 MCP 服务器，可以使用 '-d' 参数指定数据库类型，例如安装 PostgreSQL 的 MCP 服务器：
```
npx -y @sequelsh/mcp@latest install -d postgresql
```
支持的数据库类型包括：'postgresql', 'mysql', 'clickhouse'。
配置 MCP 客户端: 安装完成后，Sequel MCP Server 会自动尝试配置你选择的 MCP 客户端（目前支持 Claude, Cursor, WindSurf）。配置信息会被写入到对应客户端的配置文件中。

服务器配置

Sequel MCP Server 的配置主要体现在 MCP 客户端的配置文件中。安装命令 'npx -y @sequelsh/mcp@latest install' 会自动根据你选择的数据库和 MCP 客户端生成并写入配置。以下是一个配置示例（以 PostgreSQL 和 Claude 客户端为例），展示了 MCP 客户端需要配置的关键信息：

{
  "mcpServers": {
    "sequel_postgresql_随机ID": {  // server name，客户端内唯一标识，由 sequel-mcp 自动生成
      "command": "npx",          // 启动 MCP Server 的命令
      "args": [                  // 命令参数
        "-y",
        "@sequelsh/mcp@latest",
        "run",                   // 运行 run 命令启动 server
        "postgresql",            // 指定数据库类型为 postgresql
        "--transport",           // 指定传输协议
        "io"                     // 使用 io (Stdio) 传输协议，Claude 客户端默认使用 io
      ],
      "env": {                   // 环境变量
        "DATABASE_URL": "你的 PostgreSQL 数据库连接字符串" // 数据库连接字符串，需要替换为实际的连接信息
      }
    }
  }
}

配置说明:

'mcpServers': MCP 客户端配置中的 MCP 服务器列表。
'sequel_数据库类型_随机ID': 自动生成的服务器名称，用于在客户端中唯一标识该 MCP 服务器实例。
'command': 启动 MCP 服务器的命令，通常为 'npx' 或 'node' (开发环境)。
'args': 传递给启动命令的参数，包括：
- '"-y", "@sequelsh/mcp@latest"': 使用 'npx' 执行 '@sequelsh/mcp' 包的最新版本。
- '"run"': 指定运行 'sequel-mcp' 的 'run' 命令，即启动 MCP 服务器。
- '"数据库类型"': 指定要连接的数据库类型 (例如 'postgresql', 'mysql', 'clickhouse')。
- '"--transport", "传输协议"': 指定 MCP 服务器使用的传输协议，例如 'io' (Stdio) 或 'sse' (SSE)。
'env': 环境变量配置。
- 'DATABASE_URL': 必须配置。数据库连接字符串，用于连接到你的数据库。你需要将其替换为实际的数据库连接字符串，例如 PostgreSQL 的连接字符串格式为 'postgres://用户名:密码@主机:端口/数据库名'。

注意:

实际配置文件的路径和结构可能因 MCP 客户端而异。'sequel-mcp install' 命令会尝试自动查找并配置，但如果自动配置失败，你可能需要手动编辑客户端的配置文件，并参考上述示例进行配置。
请务必将 '"DATABASE_URL"' 替换为你实际的数据库连接字符串。

基本使用方法

启动 MCP 客户端: 打开并启动你配置的 MCP 客户端 (例如 Claude, Cursor, WindSurf)。
连接 MCP 服务器: 客户端通常会自动检测并连接到配置的 MCP 服务器。你可能需要在客户端的设置或扩展管理中启用或选择 "Sequel MCP Server"。
使用工具: 在 MCP 客户端中，你可以通过自然语言指令或特定的调用方式来使用 Sequel MCP Server 提供的工具：
- 'query' 工具: 用于执行 SQL 查询。例如，你可以指示客户端 "使用 query 工具查询 'SELECT * FROM users LIMIT 10'"。
- 'schema' 工具: 用于获取数据库 schema 信息。例如，你可以指示客户端 "使用 schema 工具获取数据库结构"。
查看结果: 查询结果或 schema 信息将会在 MCP 客户端中显示。

Sequel MCP Server 允许你直接在支持 MCP 协议的 AI 客户端中使用数据库数据，极大地扩展了 LLM 的应用场景。

关键词

项目简介

主要功能点

安装步骤

服务器配置

基本使用方法

信息