MCP Server for Amazon Redshift

A Model Context Protocol (MCP) server implementation for Amazon Redshift, allowing AI models to interact with Redshift databases through a standardized interface.

Features

• Connect to Amazon Redshift databases
• List tables, views, and materialized views
• Retrieve schema information for database objects
• Execute read-only SQL queries
• Environment variable configuration
• Schema filtering support

Prerequisites

• Node.js 18.x or higher
• npm 9.x or higher
• Access to an Amazon Redshift cluster

Installation

1. Clone the repository:

   git clone https://github.com/snahmod/mcp-server-redshift.git
   cd mcp-server-redshift
   

2. Install dependencies:

   npm install
   

3. Create a .env file based on the example:

   cp .env.example .env
   

4. Edit the .env file with your Redshift connection details:

   REDSHIFT_HOST=your-cluster.region.redshift.amazonaws.com
   REDSHIFT_PORT=5439
   REDSHIFT_DATABASE=your_database
   REDSHIFT_USER=your_username
   REDSHIFT_PASSWORD=your_password
   REDSHIFT_SCHEMAS=public,schema1,schema2
   
   # Transport configuration (optional)
   TRANSPORT_TYPE=stdio  # or 'sse'
   PORT=3000            # Only used with SSE transport
   

Usage

Starting the Server

The server supports two transport types:

1. stdio (default):

   npm start
   # or explicitly
   TRANSPORT_TYPE=stdio npm start
   

2. SSE (Server-Sent Events):

   TRANSPORT_TYPE=sse PORT=3000 npm start
   

When using SSE transport, the server exposes two endpoints:

• GET /sse - Establishes an SSE connection
• POST /messages - Handles MCP messages

Testing

Run the test client to verify the server functionality:

npm test

The test client will:

1. Start the MCP server
2. List all tables, views, and materialized views
3. Get schema information for a table
4. Get schema information for a view (if available)
5. Execute a count query on a table
6. Execute a simple query

Building

Build the TypeScript code:

npm run build

Using with MCP

This server can be used with any MCP-compatible client, including AI assistants like Claude. To use it:

1. Build the server:

   npm run build
   

2. Set up your environment variables in .env

3. Start the server:

   npm start
   

4. Connect to the server using an MCP client. The server will provide access to database resources and the query tool.

Example MCP Interactions

1. List all tables and views:

   {
     "type": "list_resources",
     "params": {}
   }
   

2. Get table schema:

   {
     "type": "read_resource",
     "params": {
       "uri": "redshift://your-cluster/schema/table"
     }
   }
   

3. Execute a query:

   {
     "type": "call_tool",
     "params": {
       "name": "query",
       "arguments": {
         "sql": "SELECT * FROM schema.table LIMIT 5"
       }
     }
   }
   

Development

Project Structure

• src/ - Source code
  • index.ts - Main server implementation
  • types.ts - TypeScript type definitions
• test/ - Test files
  • client.ts - Test client for verifying server functionality
• dist/ - Compiled JavaScript code (generated)

Adding New Features

1. Implement new functionality in src/index.ts
2. Add appropriate tests in test/client.ts
3. Update documentation in README.md

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Acknowledgments

This project is based on the PostgreSQL MCP server from the Model Context Protocol project. Special thanks to the original authors for their work.