README
🚀 雪花 MCP 服务器
一个模型上下文协议(MCP)服务器实现,可与 Snowflake 数据库进行交互。借助该服务器,你能通过工具运行 SQL 查询,还能将数据见解和模式上下文作为资源公开。
🚀 快速开始
雪花 MCP 服务器是一个用于与 Snowflake 数据库交互的 MCP 服务器实现。要使用该服务器,你需要完成安装、配置环境变量和启动服务器等步骤。以下是详细的操作指南。
✨ 主要特性
资源
memo://insights:这是一个持续更新的备忘录,会汇总已发现的数据见解。当新的见解通过append_insight工具添加时,它会自动更新。context://table/{table_name}:如果启用了预取功能,该资源会为每个表公开有关表的信息。
📦 安装指南
1. 通过 Smithery 安装
访问 smithery.ai 下载并安装 MCP 雪花服务器。
2. 使用 UVX 安装
步骤如下:
- 克隆仓库:
git clone https://github.com/your-username/mcp-snowflake-server.git
cd mcp-snowflake-server
- 创建并激活虚拟环境(可选但推荐):
python -m venv venv
source venv/bin/activate # 在 Unix/MacOS 中
# 或者
.\venv\Scripts\activate # 在 Windows 中
- 安装依赖项:
pip install -r requirements.txt
- 运行服务器:
python run.py
💻 使用示例
1. 配置环境变量
在运行服务器之前,确保设置以下环境变量:
SNOWFLAKE_ACCOUNTSNOWFLAKE_USERSNOWFLAKE_PASSWORDSNOWFLAKE_DATABASESNOWFLAKE_SCHEMASNOWFLAKE_WAREHOUSE
2. 启动服务器
运行以下命令启动 MCP 雪花服务器:
uv --directory /absolute/path/to/mcp_snowflake_server run mcp_snowflake_server
3. 在 Claude Desktop 中配置
在 claude_desktop_config.json 文件中添加以下内容:
"mcpServers": {
"snowflake_local": {
"command": "/absolute/path/to/uv",
"args": [
"--python=3.12", // 可选参数
"--directory", "/absolute/path/to/mcp_snowflake_server",
"run", "mcp_snowflake_server"
// 其他可选参数:
// --allow-write
// --log_dir, /absolute/path/to/logs
// --log_level, DEBUG/INFO/WARNING/ERROR/CITICAL
]
}
}
📚 详细文档
注意事项
⚠️ 重要提示
- 默认情况下,写入操作被禁用。请通过
--allow-write显式启用。- 服务器支持通过排除模式过滤特定数据库、模式或表。
- 如果启用了预取功能,服务器会公开额外的每个表上下文资源。
append_insight工具会动态更新memo://insights资源。
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group