Server Configuration
Describes the environment variables required to run the server.
Name | Required | Description | Default |
---|---|---|---|
HOST | No | Host for the server to listen on, e.g., 'localhost' or '0.0.0.0' | 0.0.0.0 |
PORT | No | Port for the HTTP/SSE server to listen on | 3333 |
DEBUG | No | Set to 'true' for detailed logging (helpful for troubleshooting) | false |
DB_USER | Yes | SQL Server username | |
DB_SERVER | Yes | Your server name or IP | |
TRANSPORT | No | Connection method: 'stdio' (for Claude Desktop) or 'sse' (for network connections) | stdio |
SERVER_URL | No | Base URL when using SSE transport | http://localhost:3333 |
DB_DATABASE | Yes | Your database name | |
DB_PASSWORD | Yes | SQL Server password | |
QUERY_RESULTS_PATH | No | Directory where query results will be saved as JSON files |
Schema
Prompts
Interactive templates invoked by user choice
Name | Description |
---|---|
No prompts |
Resources
Contextual data attached and managed by the client
Name | Description |
---|---|
No resources |
Tools
Functions exposed to the LLM to take actions
Name | Description |
---|---|
No tools |