Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| DB_HOST | Yes | Database hostname | |
| DB_PORT | No | Database port | 9030 |
| DB_USER | Yes | Database username | |
| LOG_DIR | No | Directory for log files | ./logs |
| LOG_LEVEL | No | Log level (e.g., INFO, DEBUG, WARNING, ERROR) | INFO |
| DB_DATABASE | Yes | Default database name | |
| DB_PASSWORD | Yes | Database password | |
| SERVER_HOST | No | Host address the server listens on | 0.0.0.0 |
| SERVER_PORT | No | Port the server listens on | 3000 |
| ALLOWED_ORIGINS | No | CORS allowed origins (comma-separated, * allows all) | |
| CONSOLE_LOGGING | No | Whether to output logs to the console | false |
| MCP_ALLOW_CREDENTIALS | No | Whether to allow CORS credentials | false |
| ENABLE_SQL_SECURITY_CHECK | No | Whether to enable security checks for SQL queries |
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 |
|---|---|
| exec_query | [Function Description]: Execute SQL query and return result command (executed by the client). [Parameter Content]:
|
| get_table_schema | [Function Description]: Get detailed structure information of the specified table (columns, types, comments, etc.). [Parameter Content]:
|
| get_db_table_list | [Function Description]: Get a list of all table names in the specified database. [Parameter Content]:
|
| get_db_list | [Function Description]: Get a list of all database names on the server. [Parameter Content]:
|
| get_table_comment | [Function Description]: Get the comment information for the specified table. [Parameter Content]:
|
| get_table_column_comments | [Function Description]: Get comment information for all columns in the specified table. [Parameter Content]:
|
| get_table_indexes | [Function Description]: Get index information for the specified table. [Parameter Content]:
|
| get_recent_audit_logs | [Function Description]: Get audit log records for a recent period. [Parameter Content]:
|