Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| MSSQL_PORT | No | The SQL Server port. Defaults to 9123. | 9123 |
| MSSQL_USER | No | The SQL login username. Required unless using Windows Integrated authentication. | |
| MSSQL_CLIENT | No | Client key under 'clients' (e.g. a specific database name) used when loading configuration from a connections map file. | |
| MSSQL_DOMAIN | No | The NTLM domain for domain\user authentication. | |
| MSSQL_SERVER | No | The SQL Server host address (e.g. 192.168.100.65). | |
| MSSQL_ENCRYPT | No | Whether to use encryption for the connection ('true' or 'false'). | false |
| MSSQL_DATABASE | No | The database name to connect to. Defaults to 'master'. | master |
| MSSQL_PASSWORD | No | The SQL login password. Required unless using Windows Integrated authentication. | |
| MSSQL_TRUST_CERT | No | Set to 'true' to trust self-signed or development certificates. | |
| MSSQL_CONFIG_PATH | No | Path to the JSON connections file. Defaults to 'connections.json' in the current working directory. | |
| MSSQL_ENVIRONMENT | No | Environment key (e.g. staging, prod) used when loading configuration from a connections map file. | |
| MSSQL_WINDOWS_INTEGRATED | No | Set to 'true' to use the current Windows OS user for authentication (requires msnodesqlv8). | |
| MSSQL_TRUST_SERVER_CERTIFICATE | No | Alternative environment variable to 'MSSQL_TRUST_CERT'; set to 'true' to trust the server certificate. |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| query | Execute a read-only SQL query (SELECT) against the configured SQL Server database. |
| list_tables | List tables in the current database, optionally filtered by schema. |
| describe_table | Return column names and types for a table. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |