Partition Manifest | Pricefx Knowledge Base

The partition_manifest tool returns an overview of your Pricefx partition: its name and environment, the installed accelerators, the Datamarts, the main sales Datamart fields, and the Agents. The AI assistant uses this overview at the start of a conversation to learn what exists on the partition before it uses other tools.

Tool Name – partition_manifest

Title – Partition Manifest

Type – Private

Access Profile – Operator

Permissions

The partition_manifest tool reads the partition overview with your Pricefx session. The tool does not change any data.

The partition_manifest runs as a Groovy tool on your Pricefx partition, not centrally on the Pricefx MCP Server. To make it available to your MCP clients, the tool must be deployed to your partition:

The Groovy logic that implements the tool must be deployed to the partition.
The tool must be declared in an Advanced Configuration Option named MCP_tool_partition_manifest. For more information, see Partition Tools Declaration.

If the tool is not deployed, it does not appear in the tool list of your MCP client. The tool is planned to move to the Pricefx MCP Server in an upcoming release, after which no deployment will be needed.

Parameters

The partition_manifest tool has no parameters.

Output

The partition_manifest tool returns five sections:

Section	Description
`identity`	Partition name, link, environment, locale, and currency.
`modules`	Installed accelerators.
`datamarts`	All Datamarts on the partition.
`schema`	Key fields of the main sales Datamart.
`agents`	Agents on the partition and their status.

Identity

Attribute	Description
`partitionName`	Name of the partition.
`partitionUrl`	Link that opens the partition in Pricefx.
`environment`	Type of the partition, for example prod, qa, or demo. Empty when not set.
`locale`	Locale of the partition. Empty when not set.
`currency`	Base currency of the main sales Datamart. Empty when there is no main sales Datamart.
`manifestVersion`	Version of the output format, for example 1.0.
`generatedAt`	Date and time when the overview was created.

Modules

Attribute	Description
`list`	Names of the installed accelerators, for example Sales Insights or Pricefx Agents.
`totalCount`	Number of accelerators in `list`.
`warning`	Technical names of installed accelerators that the tool does not recognize. These are not included in `list`.

Datamarts

Attribute	Description
`list`	All Datamarts, sorted by unique name. Each has `uniqueName`, `label`, `id`, `metaDescription`, and `isPrimary` (true for the main sales Datamart).
`totalCount`	Number of Datamarts.
`warning`	Shown when the partition has no Datamarts.

Schema

Attribute	Description
`primaryDatamart`	Unique name of the main sales Datamart, as set in the Sales Insights configuration.
`invoicePriceField`	Field that holds the invoice price (revenue).
`quantityField`	Field that holds the quantity.
`dimensionCount`	Number of dimension fields in the main sales Datamart.
`measureCount`	Number of measure fields in the main sales Datamart.
`waterfallConfigs`	Unique names of the price waterfall configurations on the partition.
`warning`	Shown when the Sales Insights configuration is missing. The other attributes are then not returned.

Agents

Attribute	Description
`totalCount`	Number of all Agents.
`byStatus`	Number of Agents per status.
`list`	Up to 20 Agents, newest first. Each has `uniqueName`, `label`, `modelClassUN`, `lastRunTime` (empty if the Agent never ran), `openActionCount` (number of open action items), and `deepLink` (a link that opens the Agent in Pricefx).
`truncated`	true when the partition has more than 20 Agents.

Each section can also have timedOut with the value true and a warning with the reason, when the tool could not read that section.

Behavior and Limitations

The tool returns the same overview for every call. It has no filters.
The main sales Datamart and its fields come from the Sales Insights configuration. Without Sales Insights, schema has only a warning, currency is empty, and no Datamart is marked as primary.
modules lists only accelerators that the tool recognizes. Other installed packages appear only in warning. An accelerator and its upgrade package are listed once.
datamarts lists all Datamarts, with no limit. On partitions with many Datamarts, the output is long.
agents lists at most 20 Agents. totalCount and byStatus count all Agents.
lastRunTime is the start of the Agent's most recent calculation job, whether or not the job succeeded.
If one section cannot be read, the tool still returns the other sections. The failed section has timedOut set to true and a warning with the reason.

Errors

The tool does not return an error when a section cannot be read. Instead, it reports the problem in that section's warning field, for example:

Situation	Warning
The Sales Insights configuration is missing	`SIP_AdvancedConfiguration not found on this partition.` (in `schema`)
The partition has no Datamarts	`No datamarts configured on this partition.` (in `datamarts`)
An installed accelerator is not recognized	`Unrecognized accelerator packages detected (display name mapping missing): …` (in `modules`)
A section cannot be read	`Section 'X' could not be retrieved: …` (in that section, with `timedOut` set to true)

The whole tool fails only when the Sales Insights or CRM configuration, or the main sales Datamart, cannot be read at all.