Snowflake MCP

🚀 Snowflake MCPServer

Snowflake MCPServer is a server implementation following the MCP protocol, primarily used for interacting with Snowflake databases. It offers secure data access, flexible authentication mechanisms, and robust error handling capabilities.

🚀 Quick Start

Snowflake MCPServer is a server implementation that adheres to the MCP protocol, designed to interact with Snowflake databases. It provides secure data access, flexible authentication mechanisms, and robust error handling capabilities.

✨ Features

• Compatibility: Supports all clients compliant with the MCP protocol.
• Security: Implements two - way SSL encrypted communication, enabled by default.
• Performance Optimization: Comes with a built - in query optimizer and result caching mechanism.
• High Availability: Supports automatic failover and load balancing.

📦 Installation

Quick Installation

pip install snowflake-mcpservice

Compile from Source

1. Clone the code repository:

   git clone https://github.com/snowflakedb/mcpservice.git
   cd mcpservice
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Start the service:

   python server.py --config config.yaml
   

📚 Documentation

Configuration File

# Basic configuration
host: 0.0.0.0
port: 9999

# Database connection parameters
database:
  host: your-snowflake-account.snowflakecomputing.com
  warehouse: YOUR_WAREHOUSE
  database: YOUR_DATABASE
  schema: YOUR_SCHEMA
  username: YOUR_USERNAME
  password: YOUR_PASSWORD
  role: YOUR_ROLE

# Security settings
security:
  enable_ssl: true
  certificate: path/to/certificate.pem
  private_key: path/to/private_key.pem
  truststore: path/to/truststore.jks
  keystore_password: your_keystore_password

# Logging configuration
logging:
  level: INFO
  file: mcpservice.log
  max_size: 10MB
  backup_count: 3

💻 Usage Examples

Basic Usage

1. After configuration, start the service:

   python server.py --config config.yaml
   

2. Example of client connection (Python):

   from mcpservice.client import MCPClient
   
   client = MCPClient('localhost', 9999)
   result = client.execute_query("SELECT * FROM your_table LIMIT 10")
   print(result)
   

Docker Deployment

1. Build the image:

   docker build -t snowflake-mcpservice .
   

2. Run the container:

   docker run -d --name mcpservice -p 9999:9999 snowflake-mcpservice
   

Functional Modules

Core Components

• Server: Responsible for handling client connections and request distribution.
• DatabaseConnection: Manages the connection to the Snowflake database, supporting automatic reconnection and transaction management.
• QueryProcessor: Parses and executes SQL queries, supporting result set caching.
• SecurityManager: Provides authentication and authorization functions, supporting multi - factor authentication.

Execution Flow

1. The client sends a request to the server.
2. The server performs authentication.
3. The request is distributed to the corresponding processing module.
4. The processing result is returned to the client.

Logging and Monitoring

• Logging: Supports structured log output, compatible with the ELK stack.
• Performance Monitoring: Comes with a built - in Prometheus export interface for easy metric collection and analysis.

Troubleshooting

Problem Diagnosis

1. Check the network connection.
2. View the service logs.
3. Ensure the configuration file is correct.
4. Update to the latest version.

Frequently Asked Questions

• Can't connect to the database? Check if the credentials are correct and ensure network connectivity.
• Poor performance? Optimize query statements, add indexes, or adjust the caching strategy.

Project Documentation

• Official Documentation
• Developer Guide

Thank you for using Snowflake MCPServer! If you need help, please contact our support team.