Skip to main content

Available Tools

ToolCommand NameDescription
Execute SQLexecute_sql or execute_sql_{id}Execute single or multiple SQL statements (separated by semicolons)
Search Objectssearch_objects or search_objects_{id}Search and list database objects (schemas, tables, columns, procedures, indexes) with pattern matching and token-efficient progressive disclosure

Tool Naming

The tool name varies based on your configuration: Single database without --id:
npx @bytebase/dbhub --dsn "postgres://..."
Tool name: execute_sql Single database with --id:
npx @bytebase/dbhub --id prod --dsn "postgres://..."
Tool name: execute_sql_prod Multiple databases via TOML config:
[[sources]]
id = "prod-pg"
dsn = "postgres://..."

[[sources]]
id = "staging.mysql"
dsn = "mysql://..."
Tool names: execute_sql_prod_pg and execute_sql_staging_mysql
Special characters in source IDs (hyphens, dots, etc.) are converted to underscores in tool names. For example, prod-pg becomes execute_sql_prod_pg.

Next Steps