Redshift MCP Server (typescript) Xqy

🚀 Amazon Redshift MCP 服务器（TypeScript）

这是一个用 TypeScript 实现的、用于 Amazon Redshift 的 Model Context Protocol (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

1. 若在 mcp.json 中配置了该服务器，系统会自动检测。
2. 工具将在“可用工具”部分显示。
3. 代理会在相关内容出现时自动使用这些工具。

其他 MCP 客户端

使用 stdio 传输配置服务器，配置如下：

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

✨ 主要特性

• 遵循 Anthropic 的实现模式，为 MCP 兼容客户端提供 Redshift 数据仓库的丰富上下文信息。
• 支持 LLM 检查数据库架构并执行只读查询。

📦 安装指南

先决条件

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

安装步骤

1. 克隆此仓库或将文件复制到本地系统。
2. 安装依赖项：

npm install

3. 编译 TypeScript 代码：

npm run build

💻 使用示例

基础用法

服务器需要通过 DATABASE_URL 环境变量提供相关信息，启动命令如下：

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

其中：

• username：Redshift 用户名
• password：Redshift 密码
• hostname：Redshift 服务器地址
• port：端口（默认为 5432）
• database：要连接的数据库名称

高级用法

启动服务器示例：

DATABASE_URL=redshift://myuser:mypassword@redshift-cluster-1.c1234567890.us-east-1.redshift.amazonaws.com:5432/mydb?ssl=true npm start

启动后，可在 http://localhost:4000 访问 API 文档。

📚 详细文档

开发

在开发时，可使用 npm run dev 命令，该命令使用 ts - node 直接运行 TypeScript 代码，无需预编译。

延伸阅读

有关 MCP 协议的更多信息，请参考 MCP Protocol Documentation。