{"openapi":"3.1.0","info":{"title":"Databricks Unity Catalog (BYOK) API","version":"0.1.0","description":"Databricks Unity Catalog (BYOK) lets an AI assistant read your own Databricks Unity Catalog data through the Databricks Unity Catalog API with a key you supply (personal access token). Read-only: 9 tools (get_metastore_summary, get_table, list_table_summaries, list_volumes, list_functions, list_registered_models, list_model_versions, list_external_locations, list_connections). The BYOK key...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-databricks-unity-catalog.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-databricks-unity-catalog/docs"},"termsOfService":"https://connectorbay.com/byok-databricks-unity-catalog/terms"},"servers":[{"url":"https://byok-databricks-unity-catalog.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-databricks-unity-catalog/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/get_metastore_summary":{"post":{"operationId":"get_metastore_summary","summary":"Show the Unity Catalog metastore of the workspace: name, cloud, region, owner, creation time and Delta Sharing scope. Us","description":"Show the Unity Catalog metastore of the workspace: name, cloud, region, owner, creation time and Delta Sharing scope. Use for \"Which Unity Catalog metastore is my Databricks workspace attached to\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"}},"required":["workspace"],"title":"get_metastore_summaryArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_table":{"post":{"operationId":"get_table","summary":"Get one Unity Catalog table or view by its three-level name: type, format, owner, comment, storage location and the colu","description":"Get one Unity Catalog table or view by its three-level name: type, format, owner, comment, storage location and the column list (name, type, comment, nullability, position). Use for \"What columns does the Unity Catalog table main.default.orders have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"full_name":{"description":"Three-level table name catalog.schema.table, for example main.default.orders.","maxLength":200,"title":"Full Name","type":"string"}},"required":["workspace","full_name"],"title":"get_tableArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_table_summaries":{"post":{"operationId":"list_table_summaries","summary":"List the full names and types of tables in a catalog, optionally narrowed by SQL LIKE patterns for schema and table name","description":"List the full names and types of tables in a catalog, optionally narrowed by SQL LIKE patterns for schema and table names. Token paginated. Use for \"Which tables in the main catalog have 'order' in the name\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"catalog_name":{"description":"Name of the parent catalog.","maxLength":200,"title":"Catalog Name","type":"string"},"schema_name_pattern":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"SQL LIKE pattern for schema names (% and _); empty means all schemas.","title":"Schema Name Pattern"},"table_name_pattern":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"SQL LIKE pattern for table names (% and _); empty means all tables.","title":"Table Name Pattern"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items per page; 0 lets the server choose (recommended). A page can hold fewer items than asked.","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace","catalog_name"],"title":"list_table_summariesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_volumes":{"post":{"operationId":"list_volumes","summary":"List the volumes of a Unity Catalog schema with type, owner, comment, storage location and timestamps. Use for \"Which vo","description":"List the volumes of a Unity Catalog schema with type, owner, comment, storage location and timestamps. Use for \"Which volumes exist in main.default\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"catalog_name":{"description":"Name of the parent catalog.","maxLength":200,"title":"Catalog Name","type":"string"},"schema_name":{"description":"Name of the parent schema.","maxLength":200,"title":"Schema Name","type":"string"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items per page; 0 lets the server choose (recommended). A page can hold fewer items than asked.","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace","catalog_name","schema_name"],"title":"list_volumesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_functions":{"post":{"operationId":"list_functions","summary":"List the user-defined functions of a Unity Catalog schema with data type, language, determinism, owner, comment and time","description":"List the user-defined functions of a Unity Catalog schema with data type, language, determinism, owner, comment and timestamps. Function bodies are not requested. Use for \"Which functions are defined in main.default\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"catalog_name":{"description":"Name of the parent catalog.","maxLength":200,"title":"Catalog Name","type":"string"},"schema_name":{"description":"Name of the parent schema.","maxLength":200,"title":"Schema Name","type":"string"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items per page; 0 lets the server choose (recommended). A page can hold fewer items than asked.","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace","catalog_name","schema_name"],"title":"list_functionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_registered_models":{"post":{"operationId":"list_registered_models","summary":"List Unity Catalog registered models, optionally within one schema (give both catalog and schema), with owner, comment a","description":"List Unity Catalog registered models, optionally within one schema (give both catalog and schema), with owner, comment and timestamps. Use for \"Which registered ML models are in Unity Catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"catalog_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only models in this catalog; requires schema_name.","title":"Catalog Name"},"schema_name":{"anyOf":[{"maxLength":200,"type":"string"},{"type":"null"}],"default":null,"description":"Only models in this schema; requires catalog_name.","title":"Schema Name"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum models per page (server default 100 when no schema is given, up to 1000).","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_registered_modelsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_model_versions":{"post":{"operationId":"list_model_versions","summary":"List the versions of one Unity Catalog registered model with status, source run, comment and timestamps. Use for \"What v","description":"List the versions of one Unity Catalog registered model with status, source run, comment and timestamps. Use for \"What versions does the registered model main.default.churn_model have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"full_name":{"description":"Three-level model name catalog.schema.model, for example main.default.churn_model.","maxLength":200,"title":"Full Name","type":"string"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum versions per page (server default 100, up to 1000).","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace","full_name"],"title":"list_model_versionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_external_locations":{"post":{"operationId":"list_external_locations","summary":"List Unity Catalog external locations (cloud storage paths governed by Unity Catalog) with URL, credential name, owner, ","description":"List Unity Catalog external locations (cloud storage paths governed by Unity Catalog) with URL, credential name, owner, read-only flag and timestamps. Use for \"Which external storage locations are registered in Unity Catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum items per page; 0 lets the server choose (recommended). A page can hold fewer items than asked.","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_external_locationsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_connections":{"post":{"operationId":"list_connections","summary":"List Lakehouse Federation connections (links to external databases) with type, URL, owner, read-only flag and comment. C","description":"List Lakehouse Federation connections (links to external databases) with type, URL, owner, read-only flag and comment. Connection options and secrets are not returned. Use for \"Which federated database connections exist in Unity Catalog\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"workspace":{"description":"Your AWS Databricks workspace host label: the part before .cloud.databricks.com, for example dbc-a1b2c3d4-e5f6.","maxLength":200,"pattern":"^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$","title":"Workspace","type":"string"},"max_results":{"anyOf":[{"maximum":1000,"minimum":0,"type":"integer"},{"type":"null"}],"default":50,"description":"Maximum connections per page; 0 lets the server choose (recommended).","title":"Max Results"},"page_token":{"anyOf":[{"maxLength":500,"type":"string"},{"type":"null"}],"default":null,"description":"Token from next_page_token of the previous answer; leave empty for the first page.","title":"Page Token"}},"required":["workspace"],"title":"list_connectionsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}