Skip to main content
Glama

create_pa_indicator

Creates a Performance Analytics indicator/KPI by defining its facts table, aggregation, and conditions; run a PA job afterward to collect data.

Instructions

Create a Performance Analytics (PA) indicator / KPI on pa_indicators (requires WRITE_ENABLED=true). Define the source facts table, aggregation and conditions; collect data via a PA job afterward.

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_indicator"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesIndicator name (e.g. "Open P1 incidents")
unitNoUnit (pa_units name or sys_id)
fieldNoField to aggregate (required for sum/average/max/min; ignored for count)
activeNoActivate immediately (default: true)
aggregateNoAggregation function
directionNoDesired trend
conditionsNoEncoded query on the facts table (e.g. "active=true^priority=1")
descriptionNoWhat the indicator measures
facts_tableNoSource/facts table the indicator counts (e.g. "incident"); an indicator source for it is reused or created
indicator_sourceNoOptional indicator source (pa_cubes) sys_id; overrides facts_table

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv5.0.1
    • changedInput schema / properties / facts_table / description
      Previous value: -"Source/facts table the indicator counts (e.g. \"incident\")"New value: +"Source/facts table the indicator counts (e.g. \"incident\"); an indicator source for it is reused or created"
    • addedInput schema / properties / indicator_source
      Added value: +{
      +  "description": "Optional indicator source (pa_cubes) sys_id; overrides facts_table",
      +  "type": "string"
      +}
  2. Addedv4.9.0

TDQS

A3.8/5.0
Behavior4/5

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

The annotations already declare a non-read-only, non-idempotent, open-world write, so the safety profile is covered. The description adds genuinely new context: the WRITE_ENABLED=true gate and the fact that data collection is a separate PA job step. It does not say what happens on duplicate names or what the call returns, keeping it below a 5.

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

Conciseness5/5

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

Two tight sentences: the action and target come first, then the configuration summary and the follow-up step. Every clause carries information an agent needs, with no filler.

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 ten-parameter write tool with no output schema, the description covers what gets created, the required enablement flag, the key configuration axes, and the necessary follow-up job. It omits return-value expectations and duplicate/conflict behavior, which is a minor gap given the rich schema.

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 ten parameters are already documented (including the facts_table/indicator_source override relationship and field's irrelevance for count). The description only restates the categories 'source facts table, aggregation and conditions' without adding syntax or precedence rules, so the baseline 3 applies.

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?

The description uses a specific verb and resource — 'Create a Performance Analytics (PA) indicator / KPI' — and names the target table `pa_indicators`, which clearly separates it from the read-side siblings (get_pa_indicator, list_pa_indicators). It does not explicitly distinguish itself from create_pa_breakdown or other create_* tools, so it stops short of a 5.

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?

It gives one useful workflow cue — 'collect data via a PA job afterward' — which tells the agent this call alone does not produce data. However, there is no explicit when-to-use/when-not guidance versus create_pa_breakdown, nor any statement of what prerequisites beyond WRITE_ENABLED are needed before calling.

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