Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| READONLY | No | If set to true, disables write operations (insert, update, delete, etc.). | true |
| SQL_PORT | No | The port number for the SQL Server (default is 1433). | 1433 |
| SQL_USER | Yes | The username for SQL Server authentication. | |
| SQL_SERVER | Yes | The SQL Server hostname or IP address. | |
| SQL_ENCRYPT | No | Whether to use encryption for the connection (true/false). | false |
| SQL_DATABASE | Yes | The name of the database to connect to. | |
| SQL_PASSWORD | Yes | The password for SQL Server authentication. | |
| SQL_TRUST_SERVER_CERTIFICATE | No | Whether to trust the server certificate (true/false). | true |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_tables | Lists tables in an MSSQL Database, or list tables in specific schemas |
| describe_table | Describes the complete schema of a specified MSSQL Database table, including columns, types, constraints, indexes, and foreign keys. |
| read_data | Executes a SELECT query on an MSSQL Database table. The query must start with SELECT and cannot contain any destructive SQL operations for security reasons. |
| insert_data | Inserts data into an MSSQL Database table. Supports both single record insertion and multiple record insertion using standard SQL INSERT with VALUES clause. FORMAT EXAMPLES: Single Record Insert: { "tableName": "Users", "data": { "name": "John Doe", "email": "john@example.com", "age": 30, "isActive": true, "createdDate": "2023-01-15" } } Multiple Records Insert: { "tableName": "Users", "data": [ { "name": "John Doe", "email": "john@example.com", "age": 30, "isActive": true, "createdDate": "2023-01-15" }, { "name": "Jane Smith", "email": "jane@example.com", "age": 25, "isActive": false, "createdDate": "2023-01-16" } ] } GENERATED SQL FORMAT:
|
| update_data | Updates data in an MSSQL Database table using a WHERE clause. The WHERE clause must be provided for security. |
| delete_data | Executes a physical DELETE operation on table records. WARNING: This database uses soft delete patterns (__deleted flag). Consider using update_data to set __deleted = 1 instead for most use cases. |
| create_table | Creates a new table in the MSSQL Database with the specified columns. |
| create_index | Creates an index on a specified column or columns in an MSSQL Database table |
| drop_table | Drops a table from the MSSQL Database. |
| get_table_ddl | Generates CREATE TABLE DDL script for an existing table, including columns, constraints, and optionally indexes. |
| get_table_alter_ddl | Generates ALTER TABLE DDL statements to add columns and constraints from an existing table. |
| execute_stored_proc | Executes a stored procedure with optional parameters. Supports input parameters and returns result sets, output parameters, and return values. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |