MCP 服务器

Redshift MCP Server (TypeScript)

paschmaria

开发者工具

README

Redshift MCP 服务器 (TypeScript)

这是一个用 TypeScript 实现的 Amazon Redshift 的模型上下文协议 (MCP) 服务器。它遵循 Anthropic 的实现模式，并为 Cursor IDE 和其他 MCP 兼容的客户端提供关于您的 Redshift 数据仓库的丰富的上下文信息。该服务器使 LLM 能够检查数据库模式并执行只读查询。

与 MCP 客户端集成

项目特定配置

在您的项目目录中创建一个 .cursor/mcp.json 文件：

{
  "mcpServers": {
    "redshift-mcp": {
      "command": "node",
      "args": ["path/to/dist/index.js"],
      "env": {
        "DATABASE_URL": "redshift://username:password@hostname:port/database?ssl=true"
      }
    }
  }
}

全局配置

为了在所有项目中使用，在您的主目录中创建 ~/.cursor/mcp.json 文件，并使用相同的配置。

客户端特定设置

Cursor IDE

如果在 mcp.json 中配置，服务器将被自动检测到
工具将出现在 MCP 设置中的 "Available Tools" 下
Agent 将在相关时自动使用这些工具

其他 MCP 客户端

使用 stdio 传输配置服务器：

{
  "servers": [
    {
      "name": "redshift-mcp",
      "transport": {
        "kind": "stdio",
        "command": ["node", "path/to/dist/index.js"]
      }
    }
  ]
}

前提条件

Node.js 16 或更高版本
TypeScript
访问 Amazon Redshift 集群的权限
Redshift 和 SQL 的基本知识
已安装 Cursor IDE

安装

克隆此存储库或将文件复制到您的本地系统
安装依赖项：

npm install

构建 TypeScript 代码：

npm run build

用法

服务器需要通过 DATABASE_URL 环境变量提供 Redshift 连接 URL：

export DATABASE_URL="redshift://username:password@hostname:port/database?ssl=true"
npm start

或者您可以直接运行：

DATABASE_URL="redshift://username:password@hostname:port/database?ssl=true" node dist/index.js

对于开发，您可以使用：

DATABASE_URL="redshift://username:password@hostname:port/database?ssl=true" npm run dev

连接 URL 格式

redshift://username:password@hostname:port/database?ssl=true

username: 您的 Redshift 用户名
password: 您的 Redshift 密码
hostname: 您的 Redshift 集群端点
port: Redshift 通常为 5439
database: 您的数据库名称
ssl: 设置为 "true" 以进行安全连接（推荐）

其他连接参数：

ssl=true: 安全连接必需（推荐）
timeout=10: 连接超时时间（秒）
keepalives=1: 启用 TCP keepalive
keepalives_idle=130: TCP keepalive 空闲时间

项目结构

src/index.ts: 主要的 TypeScript 实现
dist/: 编译后的 JavaScript 输出
package.json: 项目依赖项和脚本
tsconfig.json: TypeScript 配置

组件

Cursor 中可用的工具

query
- 对连接的 Redshift 数据库执行只读 SQL 查询
- 示例: "编写一个查询来显示 public schema 中的所有表"
describe_table
- 获取关于特定表的详细信息
- 示例: "显示 users 表的结构"
find_column
- 查找包含具有特定名称模式的列的表
- 示例: "查找所有包含 'email' 列的表"

Cursor 可用的资源

服务器提供 Cursor 可以使用的模式信息：

Schema Listings (redshift://<host>/schema/<schema_name>)
- 列出特定 schema 中的所有表
- 从数据库元数据自动发现
Table Schemas (redshift://<host>/<schema>/<table>/schema)
- 每个表的 JSON 模式信息
- 包括列名、数据类型和 Redshift 特定的属性（分布键和排序键）
Sample Data (redshift://<host>/<schema>/<table>/sample)
- 每个表的示例行（限制为 5 行）
- 敏感数据被自动编辑
Statistics (redshift://<host>/<schema>/<table>/statistics)
- 表统计信息，包括大小、行数和创建时间
- 分布和压缩信息