Redshift Js MCP Server

🚀 Amazon Redshift MCP Server (TypeScript)

This is a Model Context Protocol (MCP) server implemented for Amazon Redshift, written in TypeScript. Following Anthropic's implementation pattern, this server provides rich database context information for Cursor IDE and other MCP-compatible clients. It enables large language models (LLMs) to view the database schema and execute read-only queries.

🚀 Quick Start

Integration with MCP Clients

Project-Specific Configuration

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

{
  "mcpServers": {
    "redshift-mcp": {
      "command": "node",
      "args": ["src/index.ts"],
      "env": {
        "DATABASE_URL": "redshift://user:password@host:port/database"
      }
    }
  }
}

Global Configuration

Create a .cursor/mcp.json file in the global directory:

{
  "mcpServers": {
    "redshift-mcp": {
      "command": "node",
      "args": ["src/index.ts"],
      "env": {
        "DATABASE_URL": "redshift://user:password@host:port/database"
      }
    }
  }
}

Installation and Building

Use the following commands to install dependencies and build the project:

npm install
npm run build

For the development environment, you can use the following command to directly run the TypeScript file:

npm run dev

✨ Features

Tool Implementations

1. Query Execution (query):
   • Execute any SQL query and return the results.
   • Support complex query operations such as unions and aggregations.
2. Table Structure Description (describe_table):
   • Return column information for a specified table, including data types and constraints.
   • For example: DESCRIBE customers
3. Table Search (find_tables):
   • Search for tables based on keywords or patterns.
   • Support fuzzy queries and regular expressions.
4. Sample Data (sample_data):
   • Return sample data rows from a specified table to help users understand the data content.
   • Automatically redact sensitive information (e.g., emails, phone numbers).

Resource Definitions

• Schema Listings: List all schemas in the database.
• Table Schemas: Return detailed schema information for a specific table.
• Sample Data: Provide sample data rows from a specified table.

📦 Installation

Use the following commands to install dependencies and build the project:

npm install
npm run build

For the development environment, you can use the following command to directly run the TypeScript file:

npm run dev

💻 Usage Examples

Basic Usage

Here are some example questions users can ask in Cursor:

1. "Show all tables in the public schema."
2. "What is the structure of the customers table?"
3. "Find all tables containing customer information."
4. "Write a query to count the number of orders by state."
5. "Show sample data from the products table."

🔧 Technical Details

Project Structure

• src/index.ts: The main entry file of the project, responsible for starting the server and handling requests.
• tsconfig.json: TypeScript configuration file.
• package.json: Project dependencies and script definitions.

Security Considerations

1. Input Sanitization: Prevent SQL injection and other malicious requests.
2. Redact Sensitive Data: Hide sensitive information such as emails and phone numbers in sample data.
3. SSL Connection: Ensure secure communication with the database through SSL.

Extension and Development

Feature Extension

1. Add New Resource Types: Define new resource types and implement their processing logic.
2. Customize Tools: Add more features, such as advanced query analysis or data export.
3. Enhance Security: Implement authentication and access control mechanisms.

Development Suggestions

• Use environment variables to manage sensitive information and avoid hard-coding.
• Track server status and requests through logging and monitoring tools.
• Regularly test and update dependencies to ensure system security and stability.

📄 License

No license information provided in the original document, so this section is skipped.