Redshift MCP Server (typescript) Xqy

🚀 Amazon Redshift MCP Server (TypeScript)

This is a Model Context Protocol (MCP) server for Amazon Redshift, implemented in TypeScript. It follows Anthropic's implementation pattern and provides rich context information about your Redshift data warehouse for Cursor IDE and other MCP-compatible clients. This server enables LLMs to examine the database schema and execute read-only queries.

🚀 Quick Start

Integration with MCP Clients

Project-Specific Configuration

Create a .cursor/mcp.json file in your project directory:

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

Global Configuration

To use it across all projects, create a ~/.cursor/mcp.json file in your home directory with the same configuration.

Client-Specific Settings

Cursor IDE

1. If the server is configured in mcp.json, it will be detected automatically.
2. The tool will appear under the "Available Tools" section.
3. The agent will use these tools automatically when relevant content appears.

Other MCP Clients

Configure the server using stdio transport:

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

📦 Installation

Prerequisites

• Node.js 16 or higher
• TypeScript
• Access to an Amazon Redshift cluster
• Basic knowledge of Redshift and SQL
• Cursor IDE installed

Steps

1. Clone this repository or copy the files to your local system.
2. Install the dependencies:

npm install

3. Compile the TypeScript code:

npm run build

💻 Usage Examples

Basic Usage

The server requires the DATABASE_URL environment variable to be provided:

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

Where:

• username: Redshift username
• password: Redshift password
• hostname: Redshift server address
• port: Port (default is 5432)
• database: Name of the database to connect to

Advanced Usage

Start the server:

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

Then you can access the API documentation at http://localhost:4000.

📚 Documentation

For more information about the MCP protocol, refer to MCP Protocol Documentation.

🔧 Technical Details

During development, you can use the npm run dev command, which uses ts-node to run the TypeScript code directly without pre-compilation.