Catalog Discovery (Preview)
oracle_analytics-search_catalog
Input Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"cursor": {
"type": "string"
},
"limit": {
"type": "integer"
},
"rootFolder": {
"type": "string"
},
"search": {
"type": "string"
},
"sortBy": {
"type": "string"
},
"sortOrder": {
"type": "string"
},
"type": {
"type": "string"
},
"types": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Searches OAC catalog objects across one or more catalog types. Use this before workbook operations, catalog modifications, or dataset Logical SQL work because it returns catalog IDs, resource URIs, and deep links where available.
Common Uses
- Find a workbook by name.
- List folders under a known root folder ID.
- Find datasets and retrieve their
xsaExpr. - Find subject areas before
describe_data. - Locate connections before replacing or copying them.
Supported Catalog Types Include
-
workbooks -
folders -
datasets -
connections -
dataflows -
models -
sequences -
subjectAreas -
analysis -
reports -
dashboardgroupfolders -
dashboardfolders -
dashboardpages -
dashboards -
scripts
subjectareas is accepted as an alias for subjectAreas.
Important Parameters
| Parameter | Type | Notes |
|---|---|---|
search |
string | Query string. Defaults to *.
|
type |
string | Single catalog type. |
types |
string[] | Multiple catalog types. If type and types are both supplied, the tool uses the union.
|
rootFolder |
string | Base64url folder ID. Folder paths are not accepted. |
limit |
integer | Page size. Default 50, maximum 200.
|
sortBy |
string | One of name, lastModified, type, owner, description.
|
sortOrder |
string | ASC or DESC.
|
cursor |
string | Pass nextCursor from a previous response to fetch the next page. Ignore other args when using a cursor.
|
Example - Find Subject Areas
{
"jsonrpc": "2.0",
"id": 10,
"method": "tools/call",
"params": {
"name": "oracle_analytics-search_catalog",
"arguments": {
"types": ["subjectAreas"],
"limit": 20,
"sortBy": "name",
"sortOrder": "ASC"
}
}
}Example - Search for Workbooks by Name
{
"jsonrpc": "2.0",
"id": 11,
"method": "tools/call",
"params": {
"name": "oracle_analytics-search_catalog",
"arguments": {
"search": "Sales",
"type": "workbooks",
"limit": 25
}
}
}Typical Response Fields
| Field | Notes |
|---|---|
items |
Matching catalog objects. |
items[].id |
Base64url catalog ID. Use this for save, export, copy, move, delete, and ACL calls. |
items[].objectId |
Upstream object ID when available. Useful for datasets. |
items[].xsaExpr |
Dataset Extended Subject Area expression, when available. Use this in Logical SQL FROM.
|
items[].metadataResource |
MCP resource URI for raw metadata, if exposed by the client. |
items[].contentResource |
MCP resource URI for workbook or connection content, if exposed by the client. |
items[].viewUrl |
Browser deep link where available. |
nextCursor |
Cursor for the next page. |
hasMore |
Whether more pages are available. |