Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| CLICKHOUSE_HOST | Yes | The host address of the ClickHouse server | |
| CLICKHOUSE_PORT | Yes | The port number of the ClickHouse server | |
| CLICKHOUSE_USER | Yes | The username to connect to the ClickHouse server | |
| CLICKHOUSE_PASSWORD | Yes | The password to connect to the ClickHouse server |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| list_databases | List available ClickHouse databases |
| list_tables | List available ClickHouse tables in a database, including schema, comment, row count, and column count. Args: database: The database to list tables from like: Optional LIKE pattern to filter table names not_like: Optional NOT LIKE pattern to exclude table names page_token: Token for pagination, obtained from a previous call page_size: Number of tables to return per page (default: 50) include_detailed_columns: Whether to include detailed column metadata (default: True). When False, the columns array will be empty but create_table_query still contains all column information. This reduces payload size for large schemas. Returns: A dictionary containing: - tables: List of table information (as dictionaries) - next_page_token: Token for the next page, or None if no more pages - total_tables: Total number of tables matching the filters |
| run_select_query | Run a SELECT query in a ClickHouse database |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |