Skip to main content
Glama

create_pa_breakdown

Create a Performance Analytics breakdown to slice an indicator by a dimension such as Assignment group or Category, enabling targeted analysis of PA data.

Instructions

Create a Performance Analytics (PA) breakdown on pa_breakdowns (requires WRITE_ENABLED=true). Breakdowns slice an indicator by a dimension (e.g. by Assignment group or Category).

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "name": "<name>"
    },
    "name": "create_pa_breakdown"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesBreakdown name (e.g. "By Assignment group")
activeNoActivate immediately (default: true)
descriptionNoWhat this breakdown slices by
related_fieldNoOptional dotted field path the breakdown maps to (e.g. "assignment_group")
breakdown_sourceNoOptional breakdown source (pa_dimensions) sys_id

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv5.0.1
    • addedInput schema / properties / breakdown_source
      Added value: +{
      +  "description": "Optional breakdown source (pa_dimensions) sys_id",
      +  "type": "string"
      +}
  2. Addedv4.9.0

TDQS

A3.5/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=false, destructiveHint=false, idempotentHint=false and openWorldHint=true, so the safety profile is largely covered. The description adds the WRITE_ENABLED=true gate, which is real context the annotations do not convey. It does not warn that non-idempotent creation may produce duplicates, nor does it describe what the call returns.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences with the action and the precondition front-loaded, and no filler. The conceptual definition of a breakdown earns its place by disambiguating the resource. Slightly denser than ideal since the precondition is buried in a parenthetical mid-sentence.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a five-parameter create tool with a fully documented schema, no output schema and clear annotations, the description covers the essentials: what is created, where, the write gate, and the domain meaning. The main omission is what the tool returns (e.g. a sys_id) and whether an existing breakdown should be reused instead, but neither is critical to calling it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all five parameters including related_field and breakdown_source are documented in the schema itself, establishing a baseline of 3. The description's 'slice an indicator by a dimension' framing adds conceptual meaning that helps interpret those fields, but it gives no field-level detail beyond what the schema already supplies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Create a Performance Analytics (PA) breakdown on pa_breakdowns') and adds a one-line conceptual definition of what a breakdown is. An agent can distinguish it from create_pa_indicator because the description says breakdowns slice an indicator by a dimension. It stops short of explicitly contrasting with list_pa_breakdowns, so sibling differentiation is only partial.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The parenthetical '(requires WRITE_ENABLED=true)' gives a genuine precondition for use, which is more than most create tools offer. However, there is no guidance on when to use this versus checking existing breakdowns via list_pa_breakdowns first, and no exclusion conditions are stated. Usage is implied rather than fully specified.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools