Connecting Pigment's MCP Server to AI systems gives access to tools in two modes.
Permissions and access rights
⚠️ Important
You need the Role and access rights of Security Administrator, Workspace Administrator or Primary Owner to set up MCP.
Ensure "AI data access" is activated on key Metrics that you want MCP to read from.
When a user accesses Pigment through an MCP connector, they must authenticate with their Pigment account. All existing Pigment permissions and access rights apply to external AI systems using tools supported over MCP:
Users can only access Applications, Metrics, or data they already have access to in Pigment.
No additional access is granted through MCP.
The default mode and advanced mode outlined below govern which tools are available to external AI systems. However, access to MCP tools does not supersede user access rights and permissions. Switching on MCP does not provide modeling rights to users that they don't have in Pigment.
For example:
If advanced mode is enabled, the AI system can see and use the tool "create_metric".
But if the user doesn't have the "Configure Blocks" permission, it just returns an error. Even if the AI can use the tool, it can't perform the action because the user doesn't have the permission.
Default mode
Default mode provides read-only tools for querying and exploring data. Only Metrics with AI data access enabled are accessible.
get_applications
get_applicationsDescription | 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
get_ai_metricsDescription | 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
get_metric_descriptionDescription | 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
query_dataDescription | 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 Sales for top 10 products by Year.” |
Advanced mode
In advanced mode, you can access write tools allowing modeling in Pigment Applications: create and edit Dimensions, Metrics, Views and Boards.
⚠️ Important
We recommend using advanced mode with AI tools that support Skills, such as Claude, ChatGPT and Cursor. Skills are domain-knowledge files that give AI systems the context they need to work effectively with Pigment, including Pigment formula syntax and modeling best practices.
Skills are available in this public repository. The repository also provides Claude Code and Cursor plugins that package the MCP Server configuration together with Skills. Once installed, your AI system loads and uses them automatically.
To enable advanced mode:
Request activation on your Workspace by submitting a Support ticket,
Each user must enable it individually in Settings > Advanced features > Enable advanced tools on MCP server. Advanced mode is off by default.
ℹ️ Note
Advanced mode includes a search tool that lets the AI systems scan and understand your entire Application logic. This helps the systems provide better answers. The search tool exposes all Block metadata (e.g. names, data types, Dimensions, formulas) to users, but no actual data is accessible through it. We recommend that you do not put any sensitive information in Block metadata as it is not subject to access rights. If you want to prevent a user from accessing Block metadata, you must remove that user’s access to the Block’s Application in Pigment.