MCP Server Redshift

🚀 適用於Redshift的MCP服務器

本項目是一個用於Amazon Redshift的模型上下文協議（MCP）服務器實現，藉助AI模型為與Redshift數據庫的交互提供標準接口，極大地提升了數據庫操作的便捷性與規範性。

🚀 快速開始

本項目是一個用於Amazon Redshift的模型上下文協議（MCP）服務器實現，藉助AI模型為與Redshift數據庫的交互提供標準接口，極大地提升了數據庫操作的便捷性與規範性。

✨ 主要特性

• 可列出多個模式下的表、視圖和物化視圖。
• 能夠獲取多個表格的詳細模式信息。
• 支持執行針對Redshift的只讀SQL查詢。
• 支持stdio和SSE（服務器發送事件）傳輸。
• 採用類型安全的TypeScript實現。

📦 安裝指南

克隆倉庫

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

安裝依賴項

npm install

構建項目

npm run build

📚 詳細文檔

配置

在根目錄下創建一個.env文件，包含以下變量：

# Redshift連接配置
REDSHIFT_HOST=your-redshift-host
REDSHIFT_PORT=5439
REDSHIFT_DATABASE=your-database
REDSHIFT_USER=your-username
REDSHIFT_PASSWORD=your-password
REDSHIFT_SCHEMAS=public,schema1,schema2  # 逗號分隔的模式列表

# 服務器配置
TRANSPORT_TYPE=stdio  # 或 'sse' 使用服務器發送事件
PORT=3000  # 僅在TRANSPORT_TYPE=sse時使用

使用方法

運行服務器

# 開發環境
npm run dev

# 生產環境
npm run build
npm start

可用工具

列出表 (list_tables)

• 列出指定模式下的所有表、視圖和物化視圖。
• 可選的schemas參數用於按特定模式過濾。

{
  "schemas": ["public", "analytics"]
}

獲取表格模式 (get_tables_schema)

• 獲取多個不同模式下表格的模式信息。

{
  "tables": [
    { "schema": "public", "table": "users" },
    { "schema": "analytics", "table": "events" }
  ]
}

查詢 (query)

• 執行針對數據庫的只讀SQL查詢。

{
  "sql": "SELECT * FROM public.users LIMIT 5"
}

測試

運行測試套件：

npm test

架構

項目按以下結構組織：

src/
├── config/         # 配置和數據庫設置
├── tools/          # 各個工具的實現
├── server/         # 服務器設置和傳輸配置
└── index.ts        # 入口文件

安全注意事項

• 所有查詢都在只讀事務中執行。
• 環境變量應妥善保護。
• SSE傳輸啟用了CORS（生產環境中需配置）。
• 數據庫憑證應安全管理。

貢獻指南

1. 分叉倉庫。
2. 創建功能分支 (git checkout -b feature/amazing-feature)。
3. 提交更改 (git commit -m 'Add some feature')。
4. 推送到分支 (git push origin feature/amazing-feature)。
5. 打開拉取請求。

📄 許可證

項目在MIT License下發布。

致謝

本項目基於PostgreSQL MCP服務器，在此向原作者表示感謝。