Skip to main content
Glama

define_kpi_catalog

Create, merge, and validate a versioned YAML KPI catalog for Power BI/Fabric, with optional process presets and dry-run diff preview before writing changes.

Instructions

Create, merge, and validate a versioned YAML KPI catalog.

Args: catalog_path: Target YAML path inside PBI_WORKSPACE_ROOT. kpis: Optional list (or JSON string) of KPI definition objects. version: Catalog semantic version string. approver: Optional human approver / owner tag. merge: Merge incoming KPIs into existing catalog when True. include_process_preset: Seed the 7 built-in operational/process KPIs. dry_run: Preview diff/validation without writing to disk (default True).

Returns: Dict with validation result, catalog SHA-256, and unified YAML diff.

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": {
      "catalog_path": "<catalog_path>"
    },
    "name": "define_kpi_catalog"
  }
}

Input Schema

NameRequiredDescriptionDefault
kpisNo
mergeNo
dry_runNo
versionNo1.0.0
approverNo
catalog_pathYes
include_process_presetNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.25.1

TDQS

A3.9/5.0
Behavior4/5

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

With no annotations provided, the description carries the full burden and does disclose meaningful behavior: dry_run defaults to True and previews diff/validation without writing to disk, merge controls incorporation into an existing catalog, and the return value includes validation result, catalog SHA-256, and a unified YAML diff. It still does not clarify what happens when merge is False, whether files are overwritten, or what permissions are required.

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?

The purpose is front-loaded in the first sentence, followed by a structured Args list and return summary. The content is appropriately sized for a seven-parameter tool and contains no obvious 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 seven-parameter mutation tool with no annotations and no schema descriptions, the definition covers purpose, every argument, dry-run behavior, merging, presets, and return contents. It is still incomplete around the kpis object schema and the precise side effects of merge=False or dry_run=False.

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

Parameters4/5

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

Schema description coverage is 0%, so the Args section is doing substantial work and it explains all seven parameters with useful meaning such as workspace-root-relative catalog_path, semantic version, approver tag, merge behavior, process preset seeding, and dry-run default. The main gap is that kpis is only described as "KPI definition objects" without the fields those objects require.

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 states specific verbs and a specific resource: "Create, merge, and validate a versioned YAML KPI catalog." An agent can understand the core operation without opening the schema. It does not explicitly distinguish this tool from siblings such as compute_process_kpis or export_kpi_report_bundle, 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?

Usage is implied by the purpose and by parameters such as merge and dry_run: use it when creating or updating a KPI catalog and previewing changes. However, there is no explicit guidance about when to choose this tool versus related KPI tools, nor are prerequisites or exclusions stated.

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