Simple Snowflake MCP Server to work behind a corporate proxy
Project description
Simple Snowflake MCP server
Enhanced Snowflake MCP Server with comprehensive configuration system and full MCP protocol compliance.
A production-ready MCP server that provides seamless Snowflake integration with advanced features including configurable logging, resource subscriptions, and comprehensive error handling. Designed to work seamlessly behind corporate proxies.
🆕 What's new in v0.3.0
This release focuses on security hardening and reliability. See CHANGELOG.md for the full list.
- Server-governed read-only mode. Read-only is decided solely by server config /
MCP_READ_ONLY; the clientread_onlyargument has been removed. All SQL funnels through one guard that strips comments and rejects multi-statement and CTE-fronted DML. - No silent data loss. Row-producing reads without a
LIMITare capped atdefault_query_limit, and a capped result now returns an explicit "results were truncated" notice instead of dropping rows silently. - Stays responsive under load. Blocking Snowflake I/O runs on a worker thread, plus an in-process rate limit and a server-side statement timeout.
- Hardened inputs.
pattern/databaseare allow-list validated beforeLIKE;limitis a bounded integer applied at the driver (never concatenated into SQL). Snowflake errors are not leaked to clients. - New
securityconfig block (rate_limit,notesbounds) andsnowflake.statement_timeout_seconds/connection_reuse. - Documentation and in-code comments are now entirely in English.
⚠️ Breaking: the client
read_onlytool argument has been removed — read-only mode is now governed solely by the server.execute-snowflake-sqlis now subject to the read-only guard (it was previously unguarded), so write/DDL statements are rejected while the server is in read-only mode. (The README previously documented several tools —query-view,list-schemas,describe-table, etc. — that were never actually implemented; the tool list above reflects what the server really exposes.)
Tools
The server exposes the following MCP tools to interact with Snowflake:
Database Operations:
- execute-snowflake-sql: Executes a SQL query on Snowflake and returns the result. Supports
json(default),markdown, andcsvoutput via theformatargument. - execute-query: Executes a SQL query with server-enforced read-only protection. In read-only mode (the default) only
SELECT,SHOW,DESCRIBE,EXPLAIN, andWITHstatements (without DML) are allowed. Read-only mode is governed solely by server configuration and cannot be relaxed by the caller. Supports alimitandmarkdown(default)/json/csvoutput viaformat.
Discovery and Metadata:
- get-connection-info: Returns current Snowflake connection information and server status.
- list-snowflake-warehouses: Lists available Data Warehouses (DWH) on Snowflake. Pass
include_details: falsefor names only. - list-databases: Lists all accessible Snowflake databases. Supports a
patternfilter (wildcards) andinclude_details. - export-schema: Exports database schema information. Supports
json(default),yaml, andsqlviaformat, an optionaldatabasefilter, andinclude_data_samples.
Notes (in-memory session state):
- add-note: Adds or updates a note (
name,content) kept in server memory for the session. - delete-note: Deletes an existing note by
name.
🔒 Security Model
This server executes client-supplied SQL against Snowflake using a single set of credentials. Treat the MCP client as untrusted (an LLM can be prompt-injected) and deploy accordingly.
The real security boundary is a least-privilege Snowflake role, not the server's keyword filter. The built-in read-only check is defense-in-depth only. Always connect with a role scoped to exactly what you need.
Required deployment posture:
- Use a least-privilege, read-only Snowflake role. For read-only deployments,
grant only
USAGE/SELECT(and the relevantSHOW/DESCRIBEvisibility) — noINSERT/UPDATE/DELETE/DDL/GRANT. If the role cannot write, no bypass of the keyword filter can cause damage. - Keep
read_only: true(the default). Read-only mode is governed solely by server configuration / theMCP_READ_ONLYenvironment variable. It is not client-controllable — there is noread_onlytool argument. - Set a statement timeout and rate limit (see
config.yaml) to bound runaway or abusive queries and warehouse-credit consumption.
What the server enforces:
- Read-only mode applies to every SQL-executing tool through a single guard;
comments are stripped, multi-statement input and CTE-fronted DML (e.g.
WITH ... DELETE) are rejected. pattern/databasearguments are validated against a strict allow-list before being placed intoLIKEclauses;limitis coerced to a bounded integer and applied at the driver, never concatenated into SQL.- Row-producing reads without an explicit
LIMITare capped atdefault_query_limitrows (applied at the driver). When a result is capped the response includes an explicit "results were truncated" notice — rows are never dropped silently. Pass a largerlimit(up tomax_query_limit) or add your ownLIMITclause to retrieve more. - Snowflake errors are not returned verbatim to the client; a generic message with a reference id is returned and full detail is logged server-side.
- Query text is not logged at
INFO(only a length + hash); full SQL isDEBUG-only.
🆕 Configuration System (v0.2.0)
The server now includes a comprehensive YAML-based configuration system that allows you to customize all aspects of the server behavior.
Configuration File Structure
Create a config.yaml file in your project root:
# Logging Configuration
logging:
level: INFO # DEBUG, INFO, WARNING, ERROR, CRITICAL (overridable via LOG_LEVEL)
format: "%(asctime)s - %(name)s - %(levelname)s - %(message)s"
file_logging:
enabled: false # Set to true to enable file logging
filename: "logs/server.log"
max_bytes: 10485760 # Rotate after 10 MB
backup_count: 5
# Server Configuration
server:
name: "simple_snowflake_mcp"
version: "0.3.0"
description: "Enhanced Snowflake MCP Server with full protocol compliance"
connection:
test_on_startup: true
timeout: 30
# Snowflake Configuration
snowflake:
# Read-only mode is read from here (and the MCP_READ_ONLY env var), NOT from
# the server block. Set to false to allow write operations.
read_only: true
default_query_limit: 1000
max_query_limit: 50000
statement_timeout_seconds: 300
connection_reuse: true
# Security controls
security:
rate_limit:
enabled: true
max_calls: 60
window_seconds: 60
notes:
max_count: 100
max_content_length: 10000
# MCP Protocol Settings
mcp:
experimental_features:
resource_subscriptions: true # Enable resource change notifications
completion_support: false # Set to true when MCP version supports it
notifications:
resources_changed: true
tools_changed: true
prompts_changed: true
Using Custom Configuration
You can specify a custom configuration file using the CONFIG_FILE environment variable:
Windows:
set CONFIG_FILE=config_debug.yaml
python -m simple_snowflake_mcp
Linux/macOS:
CONFIG_FILE=config_production.yaml python -m simple_snowflake_mcp
Configuration Override Priority
Configuration values are resolved in this order (highest to lowest priority):
- Environment variables (e.g.,
LOG_LEVEL,MCP_READ_ONLY) - Custom configuration file (via
CONFIG_FILE) - Default
config.yamlfile - Built-in defaults
🚀 Quick Install
Method 1: Install with uvx (Recommended)
# Install and run directly
uvx simple-snowflake-mcp
Method 2: Install from source
# Clone the repo
git clone https://github.com/YannBrrd/simple_snowflake_mcp
cd simple_snowflake_mcp
# Install with uv (creates a venv automatically)
uv sync
# Run
uv run simple-snowflake-mcp
Method 3: Development
# Install with development dependencies
uv sync --all-extras
# Run the tests
uv run pytest
# Lint with ruff
uv run ruff check .
uv run ruff format .
Configuration Claude Desktop
On MacOS: ~/Library/Application\ Support/Claude/claude_desktop_config.json
On Windows: %APPDATA%/Claude/claude_desktop_config.json
Development/Unpublished Servers Configuration
"mcpServers": {
"simple_snowflake_mcp": {
"command": "uv",
"args": [
"--directory",
".",
"run",
"simple_snowflake_mcp"
]
}
}
Published Servers Configuration
"mcpServers": {
"simple_snowflake_mcp": {
"command": "uvx",
"args": [
"simple_snowflake_mcp"
]
}
}
Docker Setup
Prerequisites
- Docker and Docker Compose installed on your system
- Your Snowflake credentials
Quick Start with Docker
-
Clone the repository
git clone <your-repo> cd simple_snowflake_mcp
-
Set up environment variables
cp .env.example .env # Edit .env with your Snowflake credentials
-
Build and run with Docker Compose
# Build the Docker image docker-compose build # Start the service docker-compose up -d # View logs docker-compose logs -f
Docker Commands
Using Docker Compose directly:
# Build the image
docker-compose build
# Start in production mode
docker-compose up -d
# Start in development mode (with volume mounts for live code changes)
docker-compose --profile dev up simple-snowflake-mcp-dev -d
# View logs
docker-compose logs -f
# Stop the service
docker-compose down
# Clean up (remove containers, images, and volumes)
docker-compose down --rmi all --volumes --remove-orphans
Using the provided Makefile (Windows users can use make with WSL or install make for Windows):
# See all available commands
make help
# Build and start
make build
make up
# Development mode
make dev-up
# View logs
make logs
# Clean up
make clean
Docker Configuration
The Docker setup includes:
- Dockerfile: Multi-stage build with Python 3.11 slim base image
- docker-compose.yml: Service definition with environment variable support
- .dockerignore: Optimized build context
- Makefile: Convenient commands for Docker operations
Environment Variables
All Snowflake configuration can be set via environment variables:
Required:
SNOWFLAKE_USER: Your Snowflake usernameSNOWFLAKE_PASSWORD: Your Snowflake passwordSNOWFLAKE_ACCOUNT: Your Snowflake account identifier
Optional:
SNOWFLAKE_WAREHOUSE: Warehouse nameSNOWFLAKE_DATABASE: Default databaseSNOWFLAKE_SCHEMA: Default schemaMCP_READ_ONLY: Set to "TRUE" for read-only mode (default: TRUE)
Configuration System (v0.2.0):
CONFIG_FILE: Path to custom configuration file (default: config.yaml)LOG_LEVEL: Override logging level (DEBUG, INFO, WARNING, ERROR, CRITICAL)
Development Mode
For development, use the development profile which mounts your source code:
docker-compose --profile dev up simple-snowflake-mcp-dev -d
This allows you to make changes to the code without rebuilding the Docker image.
Development
Installing dependencies
# Sync all dependencies (prod + dev)
uv sync --all-extras
# Update dependencies
uv lock --upgrade
# Add a new dependency
uv add <package-name>
# Add a dev dependency
uv add --dev <package-name>
Build and Publish
# Build
uv build
# Publish to PyPI
uv publish --token $UV_PUBLISH_TOKEN
Debugging with MCP Inspector
Since MCP servers run over stdio, debugging can be challenging. For the best debugging experience, we strongly recommend using the MCP Inspector.
You can launch the MCP Inspector via npm with this command:
npx @modelcontextprotocol/inspector uv run simple-snowflake-mcp
Upon launching, the Inspector will display a URL that you can access in your browser to begin debugging.
New Feature: Snowflake SQL Execution
The server exposes an MCP tool execute-snowflake-sql to execute a SQL query on Snowflake and return the result.
Usage
Call the MCP tool execute-snowflake-sql with a sql argument containing the SQL query to execute. The result will be returned as a list of dictionaries (one per row).
Example:
{
"name": "execute-snowflake-sql",
"arguments": { "sql": "SELECT CURRENT_TIMESTAMP;" }
}
The result will be returned in the MCP response.
Installation and configuration in VS Code
-
Clone the project and install dependencies
git clone https://github.com/YannBrrd/simple_snowflake_mcp cd simple_snowflake_mcp # Install with uv (creates a venv automatically) uv sync --all-extras
-
Configure Snowflake access
- Copy
.env.exampleto.envand fill in your credentials:SNOWFLAKE_USER=... SNOWFLAKE_PASSWORD=... SNOWFLAKE_ACCOUNT=... # SNOWFLAKE_WAREHOUSE Optional: Snowflake warehouse name # SNOWFLAKE_DATABASE Optional: default database name # SNOWFLAKE_SCHEMA Optional: default schema name # MCP_READ_ONLY=true|false Optional: true/false to force read-only mode
- Copy
-
Configure the server (v0.2.0)
- If no
config.yamlis present, the server uses its built-in defaults (no file is created automatically) - Customize logging, limits, and MCP features by editing
config.yaml(an example is provided in the repository) - Use
CONFIG_FILE=custom_config.yamlto specify a different file (resolved within the repository only, to prevent path traversal)
- If no
-
Configure VS Code for MCP debugging
- The
.vscode/mcp.jsonfile is already present:{ "servers": { "simple-snowflake-mcp": { "type": "stdio", "command": "uv", "args": ["run", "simple-snowflake-mcp"] } } }
- Open the command palette (Ctrl+Shift+P), type
MCP: Start Server, and selectsimple-snowflake-mcp.
- The
-
Usage
- The exposed MCP tools let you query Snowflake (list-databases, list-snowflake-warehouses, execute-query, execute-snowflake-sql, export-schema, etc.).
- For more examples, see the MCP protocol documentation: https://github.com/modelcontextprotocol/create-python-server
Enhanced MCP Features (v0.2.0)
Advanced MCP Protocol Support
This server now implements comprehensive MCP protocol features:
🔔 Resource Subscriptions
- Real-time notifications when Snowflake resources change
- Automatic updates for database schema changes
- Tool availability notifications
📋 Enhanced Resource Management
- Dynamic resource discovery and listing
- Detailed resource metadata and descriptions
- Support for resource templates and prompts
⚡ Performance & Reliability
- Configurable query limits and a server-side statement timeout
- Comprehensive error handling with generic client messages and a server-side reference id
- Single-connection reuse with automatic reconnect on a stale connection
🔧 Development Features
- Multiple output formats (JSON, Markdown, CSV)
- In-process rate limiting across all tool calls
- Comprehensive logging with configurable levels (and an explicit truncation notice on capped results)
MCP Capabilities Advertised
The server advertises these MCP capabilities:
- ✅ Tools: Full tool execution with comprehensive schemas
- ✅ Resources: Dynamic resource discovery and subscriptions
- ✅ Prompts: Enhanced prompts with resource integration
- ✅ Notifications: Real-time change notifications
- 🚧 Completion: Ready for future MCP versions (configurable)
Supported MCP Functions
The server exposes the following MCP tools (see the Tools section above for full argument details):
Database Operations:
- execute-snowflake-sql: Executes a SQL query and returns results as JSON, markdown, or CSV
- execute-query: Query execution with read-only protection, row limit, and multiple output formats
Discovery and Metadata:
- get-connection-info: Current connection information and server status
- list-snowflake-warehouses: Lists available Data Warehouses with status
- list-databases: Lists all accessible databases, with optional pattern filtering
- export-schema: Exports database schema in JSON, YAML, or SQL format
Session Notes:
- add-note / delete-note: Manage in-memory notes for the session
The server also implements MCP resources (Snowflake objects with subscription support) and prompts. For parameter schemas, inspect handle_list_tools in src/simple_snowflake_mcp/server.py.
🚀 Getting Started Examples
Basic Usage
# Execute a simple query
{
"name": "execute-query",
"arguments": {
"sql": "SELECT CURRENT_TIMESTAMP;",
"format": "markdown"
}
}
# List all databases
{
"name": "list-databases",
"arguments": {}
}
Advanced Configuration
# config_production.yaml
logging:
level: WARNING
file_logging:
enabled: true
filename: "/var/log/mcp_server.log"
snowflake:
# Keep true unless the connecting Snowflake role is itself read-only.
read_only: true
default_query_limit: 5000
max_query_limit: 100000
statement_timeout_seconds: 120
connection_reuse: true
security:
rate_limit:
enabled: true
max_calls: 60
window_seconds: 60
notes:
max_count: 100
max_content_length: 10000
mcp:
experimental_features:
resource_subscriptions: true
Debugging and Troubleshooting
Enable Debug Logging:
# Method 1: Environment variable
export LOG_LEVEL=DEBUG
python -m simple_snowflake_mcp
# Method 2: Custom config file
export CONFIG_FILE=config_debug.yaml
python -m simple_snowflake_mcp
Common Issues:
- Connection errors: Check your Snowflake credentials and network connectivity
- Permission errors: Ensure your user has appropriate Snowflake privileges
- Query limits: Adjust
default_query_limitin config.yaml for large result sets - MCP compatibility: Update to latest MCP client version for full feature support
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file simple_snowflake_mcp-0.3.0.tar.gz.
File metadata
- Download URL: simple_snowflake_mcp-0.3.0.tar.gz
- Upload date:
- Size: 118.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ee77237d8f5f7d4075e38eb633ef053ab4d61604b18aebdfa6f049dcaa5591d1
|
|
| MD5 |
f23cdd9cc4789bb136e71ea45979414f
|
|
| BLAKE2b-256 |
7f289e51af989710522d3ff2daf513094b2c6eff8100762e412595a20a562474
|
File details
Details for the file simple_snowflake_mcp-0.3.0-py3-none-any.whl.
File metadata
- Download URL: simple_snowflake_mcp-0.3.0-py3-none-any.whl
- Upload date:
- Size: 26.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.11.21 {"installer":{"name":"uv","version":"0.11.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2a2348074bbe09b9b1e1048c539d605e1d58c6c18990f327d8558f13def813b
|
|
| MD5 |
ce5e011b2e70152800e3fbcbc0b2fa8b
|
|
| BLAKE2b-256 |
493d1e58e4b2256930e41aacd74f4f94200d8f5f7fe071dbc0cc4a9c4bc7d16e
|