Skip to main content
Adaptive Planning
Last Updated: 2023-06-23
Reference: Adaptive Planning MCP Tools

Reference: Adaptive Planning MCP Tools

The Adaptive Planning MCP server provides a secure interface for external AI agents to interact with Adaptive Planning data and planning capabilities. The MCP tool list varies by user permissions, access rules, and tenant configuration.
Tool
Description
Permission Required
data-dimensional-query
Execute a dimensional data query to retrieve multidimensional financial data from Adaptive Planning. This tool executes the query and returns data. The response contains coordinates that map dimensions to values. Each coordinate carries entity ids and element ids that can be resolved to names using metadata tools. Tenant is resolved automatically from the authenticated session.
Create Personal Reports
data-modeled-query
Retrieve rows from a modeled planning sheet. Read-only query tool for modeled sheet data, the modeled-sheet counterpart of data-dimensional-query.
Create Personal Reports
execute_matrix_report
Execute a saved Matrix Report by id or name and return its data. Runs an existing, previously saved report. Provide exactly one of reportId or reportName. reportName must be an exact, case-sensitive match.
Access Reports
get_activity_audit_events
Retrieves Activity Audit events for the caller's own tenant, via Planning's activity audit search API. Returns MCP, UI, API, and scheduled activity. By default includes every request origin (UI, API, SCHEDULED, AI_AGENT, ALM).
Activity Auditing
metadata-search-by-ids
Looks up metadata details (names, codes, and attributes) for specific dimension value IDs. Use when you already have dimension value IDs and need their human-readable names or codes. Resolving a name to an ID is metadata-search-by-term.
None
metadata-search-by-term
Searches planning metadata by keyword and returns matching elements with their IDs, names, and metadata types. Use to resolve human-readable names (accounts, levels, versions, time periods, currencies, attributes) to numeric IDs for downstream tool calls.
None
model-account-get-downstreams
Get the accounts downstream of an input account — every output affected when it changes, traced transitively through intervening formulas, including dependents that reference a rollup the account belongs to.
None
model-account-get-driver-leafs
Get the leaf account IDs under a driver account, narrowed to those the source account's formula draws on. When the source formula references the driver with an account-attribute filter, only matching leaves are returned.
None
model-account-get-drivers
Get the terminal driver accounts behind a calculated account's formula, traced recursively through intermediate formulas and returning only endpoints that are not themselves calculated.
None
model-account-get-formula
Get the formula overview for accounts in the planning model. Returns each account's id, code, name, parent, group, formula info, and data-entry eligibility, including shared formulas, calculated accounts, and link accounts.
None
model-dimension-get-overview
Get which custom dimensions apply to each model in the planning instance. Returns user-created models with their custom dimensions, plus GL accounts that inherit dimensions through links.
  • Model Management Access
  • Model includes: sheets, accounts, dimensions, and formulas
model-links-get
Get the data links between models: which model and account provides data to which receiver, and how dimensions map across each link. Covers explicit account links and merge-cube relationships.
  • Model Management Access
  • Model includes: sheets, accounts, dimensions, and formulas
report_matrix_get
Discover saved Matrix Reports by folder scope and/or name. folderType defaults to All; other scopes include Favorites, Personal, Shared, and Reusable. searchTerm filters names; limit and offset paginate. Use execute_matrix_report to execute a saved report.
Access Reports
sheet-get
Lists all planning sheets visible to the authenticated user, including cube, standard, and modeled sheets. Use to discover sheets, resolve a sheet name to its numeric id, or determine sheet type. Returns id, name, and type for each sheet.
  • Model Management Access
  • Model includes: sheets, accounts, dimensions, and formulas
sheet-get-definition
Retrieves the definition of a planning sheet. Call sheet-get first, then pass the id, name, and type exactly as returned. Supports modeled, cube, and standard sheets.
  • Model Management Access
  • Model includes: sheets, accounts, dimensions, and formulas
load_skill
Load a business-workflow skill's step-by-step, multi-tool guidance by name. Available skills: data_exploration (query, compare, or break down financial data, or explain account formulas) and execute_existing_report (run a saved report by name).
variance-relevant-dimensions-get
Rank custom dimensions and attributes by how relevant they are for breaking down a pinned variance cell, without running per-dimension drill-in. Use this to decide which dimensions to use for further analyzing variance.
Access Reports