clickhouse-list-databases

A “clickhouse-list-databases” tool lists all databases in a ClickHouse instance.

About

A clickhouse-list-databases tool lists all available databases in a ClickHouse instance. It’s compatible with the clickhouse source.

This tool executes the SHOW DATABASES command and returns a list of all databases accessible to the configured user, making it useful for database discovery and exploration tasks.

Example

tools:
  list_clickhouse_databases:
    kind: clickhouse-list-databases
    source: my-clickhouse-instance
    description: List all available databases in the ClickHouse instance

Return Value

The tool returns an array of objects, where each object contains:

  • name: The name of the database

Example response:

[
  {"name": "default"},
  {"name": "system"},
  {"name": "analytics"},
  {"name": "user_data"}
]

Reference

fieldtyperequireddescription
kindstringtrueMust be “clickhouse-list-databases”.
sourcestringtrueName of the ClickHouse source to list databases from.
descriptionstringtrueDescription of the tool that is passed to the LLM.
authRequiredarray of stringfalseAuthentication services required to use this tool.
parametersarray of ParameterfalseParameters for the tool (typically not used).