Planning Connector — Tool Reference¶

The Planning connector exposes 12 tools for querying Oracle EPM Planning Cloud (EPBCS/PBCS).

mcp_connector_status¶

Returns connector health, version, uptime, backend connectivity, SDK version, and authentication mode.

Parameters: None

test_datasource¶

Tests connectivity to the configured Planning Cloud instance. Returns connection status, server URL, and authenticated user.

Parameters: None

list_applications¶

Lists all Planning applications the authenticated user can access.

Parameters: None

get_application_details¶

Returns detailed information about a Planning application, including plan types, dimensions, and configuration.

Parameters:

list_plan_types¶

Lists all plan types (cubes) in an application, including both ASO and BSO types.

Parameters:

get_plan_type_schema¶

Returns the dimension schema for a plan type, including dimension class (Account, Period, Entity, etc.), attribute status, and plan type validity. Attribute dimensions are included if metadata has been synchronized (see synchronize_metadata).

Parameters:

list_dimension_members¶

Lists members of a dimension with optional parent filter and pagination. Use offset and max_results to page through large dimensions; the response includes has_more to indicate additional pages.

Parameters:

Example:

{
  "application_name": "Vision",
  "dimension_name": "Account",
  "parent_member": "Total Revenue"
}

get_member_info¶

Returns detailed information about a specific dimension member. Member names are preferred, but aliases are also accepted — if an alias is provided, it is resolved to the member name before retrieving details.

Parameters:

get_substitution_variables¶

Returns substitution variables for an application. Substitution variables are named labels (e.g., &CurYr, &CurScenario) that resolve to dimension member names. They are commonly used to identify the current year, period, scenario, or version.

Parameters:

Example Response:

[
  {"name": "CurYr", "value": "FY26"},
  {"name": "CurScenario", "value": "Forecast"},
  {"name": "CurPeriod", "value": "Mar"}
]

query_data_grid¶

Queries Planning data using a grid specification. The connector sends the grid directly to Oracle without modification.

The grid has three components:

• pov — One member per dimension (fixed context)
• rows — One or more members per dimension (row axis)
• columns — One or more members per dimension (column axis)

Every dimension in the plan type must appear in exactly one of pov, rows, or columns.

Parameters:

Example:

{
  "application_name": "Vision",
  "plan_type": "Plan1",
  "pov": {
    "Scenario": "Actual",
    "Version": "Working",
    "Currency": "Local Currency",
    "Entity": "Total Entity"
  },
  "rows": {
    "Account": ["Total Revenue", "Total Expenses", "Net Income"]
  },
  "columns": {
    "Period": ["Jan", "Feb", "Mar"]
  }
}

get_attribute_members¶

Returns attribute dimension associations for base dimension members. Three query modes:

1. Given attribute_value — returns base members with that attribute value
2. Given base_member — returns the attribute value for that member
3. Neither — returns a summary of all attribute values with member counts

Parameters:

synchronize_metadata¶

Refreshes the attribute dimension cache from the latest metadata export. Run this when attribute dimension data appears stale or after dimension metadata changes in Planning.

Prerequisites: The AgentCube_metadata Export Metadata job must be pre-configured in Planning. This is a one-time admin setup.

Parameters: