Save Catalog Content (Preview)

oracle_analytics-save_catalog_content

Input Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "content": {
      "type": [
        "object",
        "string"
      ],
      "description": "Canonical workbook payload is content.json. Connector shortcut for workbooks: content.jsonPath (or content.path) may be an absolute local JSON file path; the parsed object is converted to content.json before save.",
      "properties": {
        "json": {
          "description": "Canonical workbook JSON object. Takes precedence over jsonPath/path when present."
        },
        "jsonPath": {
          "type": "string",
          "description": "Connector-side absolute local UTF-8 JSON file path for workbook JSON. Allowed roots apply."
        },
        "path": {
          "type": "string",
          "description": "Alias for content.jsonPath for workbook JSON file input. Allowed roots apply."
        }
      }
    },
    "description": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "parentId": {
      "type": "string"
    },
    "type": {
      "type": "string"
    },
    "userApproved": {
      "type": "boolean"
    }
  }
}

Creates or replaces catalog content for workbooks or connections.

This is a modification tool. Use userApproved: true only after the user has approved the exact target and intended operation.

Modes

• Create mode: supply type, name, parentId, and content.
• Replace mode: supply type, id, and optionally content, name, or description.

Important Parameters

Parameter	Type	Notes
type	string	workbooks or connections.
name	string	Required for create. Optional for replace.
description	string	Optional metadata.
content	object or string	Content JSON. For workbooks, prefer canonical { "json": { ... }, "blobs": [] }.
parentID	string	Destination folder ID for create mode.
id	string	Existing catalog item ID for replace mode.
userApproved	boolean	Must be true or confirmed through approval.

Example - Canonical Workbook Create

This example shows the canonical save envelope for workbook content. The criteria, layouts, and views fields are shown in abbreviated form. A real workbook must populate these sections with the data model, visual layout, and visualization definitions generated from discovered metadata.

{
  "jsonrpc": "2.0",
  "id": 50,
  "method": "tools/call",
  "params": {
    "name": "oracle_analytics-save_catalog_content",
    "arguments": {
      "type": "workbooks",
      "name": "Revenue Overview",
      "description": "Revenue overview generated from MCP metadata.",
      "parentId": "base64url-folder-id",
      "content": {
        "json": {
          "projectVersion": "26.03",
          "criteria": {
            "...": "data source, columns, calculations, and filters"
          },
          "layouts": [
            {
              "...": "canvas layout and visualization placement"
            }
          ],
          "views": [
            {
              "...": "visualization definitions and data bindings"
            }
          ]
        },
        "blobs": []
      },
      "userApproved": true
    }
  }
}

Workbook Content Fields

Field	Purpose	Typical Contents
projectVersion	Workbook format version expected by OAC.	Version string such as 26.03; usually copied from a known-good exported workbook template or generated by workbook authoring logic.
criteria	Defines the workbook data model usage.	Subject area or dataset references, selected columns, calculated expressions, column IDs, display names, aggregation metadata, filters, and Logical SQL expressions used by visualizations.
layouts	Defines canvas/page structure and placement.	Canvases, sections, visualization containers, coordinates, sizing, layout IDs, filter bar placement, and the relationship between canvases and views.
views	Defines the actual visualizations.	Chart type, table, pivot, map, or KPI configuration; bound data columns; grammar roles such as category, value, and color; titles; formatting; sorting; and visualization-specific properties.
blobs	Optional binary or embedded resources.	Usually empty for simple generated workbooks. May contain referenced assets or workbook resources when required by the workbook format.

WARNING:

Don't hand-author these fields from scratch unless you're following a known good workbook template. The safest pattern is to export an existing workbook, reuse its structural conventions, and replace the data model references, criteria columns, layout objects, and view bindings using metadata returned by oracle_analytics-describe_data.

Example - Workbook Replace

{
  "jsonrpc": "2.0",
  "id": 51,
  "method": "tools/call",
  "params": {
    "name": "oracle_analytics-save_catalog_content",
    "arguments": {
      "type": "workbooks",
      "id": "base64url-workbook-id",
      "content": {
        "json": {
          "projectVersion": "26.03",
          "criteria": {
            "...": "updated data source, columns, calculations, and filters"
          },
          "layouts": [
            {
              "...": "updated canvas layout and visualization placement"
            }
          ],
          "views": [
            {
              "...": "updated visualization definitions and data bindings"
            }
          ]
        },
        "blobs": []
      },
      "userApproved": true
    }
  }
}

Local Workbook JSON File Shortcut

{
  "jsonrpc": "2.0",
  "id": 52,
  "method": "tools/call",
  "params": {
    "name": "oracle_analytics-save_catalog_content",
    "arguments": {
      "type": "workbooks",
      "id": "base64url-workbook-id",
      "content": {
        "jsonPath": "/absolute/path/to/workbook.json"
      },
      "userApproved": true
    }
  }
}

Notes

• content.json is canonical and takes precedence over jsonPath.
• jsonPath must be readable by the connector process and under an allowed file root.
• Workbook validation failures are returned as VALIDATION_ERROR.
• Non-validation upstream failures are returned as UPSTREAM_ERROR.
• Direct workbook root objects may be auto-wrapped into { "json": ... }, but explicit canonical shape is preferred.