🚀 适用于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（生产环境中需配置）。
- 数据库凭证应安全管理。
贡献指南
- 分叉仓库。
- 创建功能分支 (
git checkout -b feature/amazing-feature)。 - 提交更改 (
git commit -m 'Add some feature')。 - 推送到分支 (
git push origin feature/amazing-feature)。 - 打开拉取请求。
📄 许可证
项目在MIT License下发布。
致谢
本项目基于PostgreSQL MCP服务器，在此向原作者表示感谢。