Supported tools

Prev Next

Connecting Pigment’s MCP Server to AI systems gives access to the following tools.

get_applications

Description

Sample Prompt

List all Pigment applications the user can access, with their id, name, and description. Call this first to obtain application ids required by other tools.

“List all my Pigment Applications.”

get_ai_metrics

Description

Sample Prompt

List AI-enabled metrics in an application. A metric holds values organized along dimensions (e.g., month, region, product). Not all metrics may be AI-enabled. Returns metric ids and names. Use to discover available data and obtain metric ids for get_metric_description and query_data.

“Show me Metrics available for analysis in the Financial Planning application.”

get_metric_description

Description

Sample Prompt

Get the structure of a metric: name, data type, description, dimensions (with sample items), and scenarios. Use to understand how a metric is organized.

"Describe the Revenue Metric."

"Show me the structure of the Headcount Metric."

"What are the Dimension Items for Product in the Revenue Metric?"

query_data

Description

Sample Prompt

Retrieve data from a single metric using a natural-language query. Returns values and metadata (name, link, dimensions, filters). One metric per call.

“Show me Revenue.”
“Show me Revenue for EMEA and AMER regions.”

“Show me Sales for top 10 products by Year.”