Skip to main content
Human guide: work with your agent → Inspect one ClickHouse Cloud action before starting provider-backed work. Your first result is a verified input and output contract.

​
Provider-specific requirements

Use this provider only with the workspace’s own ClickHouse Cloud API Key ID and key secret. Configure both in Dashboard > Integrations, not as Play secrets. An org admin can also call POST /api/v2/integrations/connect with provider: "clickhouse" and credentials: { "api_key": "<key-id>", "api_secret": "<key-secret>" }. Start with list or get operations to discover organization and service IDs. To access warehouse data, first create a saved Query Endpoint in ClickHouse, then call clickhouse_query_endpoint_run_get for simple scalar variables or clickhouse_query_endpoint_run_post for complex variables. These actions execute saved SQL, not arbitrary SQL. The selected database role controls the endpoint’s data access. Treat writes with care. Service, backup, API-key, member, ClickPipe, ClickStack, and Postgres operations can change or delete customer resources. A saved Query Endpoint can also write data when its configured SQL and database role allow it. Use a least-privilege API key: ClickHouse developer keys are read-only for assigned services, while admin keys can make changes.

​
Find an applicable action

Confirm your effective workspace, then search the live catalog:
Search returns candidates. Check the returned provider and operation rather than selecting a similar title automatically.

​
Inspect the selected contract

Replace <returned-tool-id> with the identifier returned by discovery:
These commands do not execute the selected provider action. Read its required inputs, supported access mode, pricing unit, outputs, and limits. A connection does not establish that every action supports BYOK. Follow the provider-specific requirements above and the live action contract.

​
Prepare one reviewed input

Use one authorized record that matches the inspected schema. Preserve its source identity and define the result you will accept. Open the action reference for its payload and response shape. Provider-backed execution can incur usage or external effects. For reusable logic, follow Write Plays. For direct-call recovery, use Tool execution recovery.
Continue only when the workspace, provider, required fields, acceptance rule, and applicable price are understood. Keep unavailable access separate from no-result evidence.