Skip to main content
Glama

update_visual_fields

Add or remove measures and columns on a Power BI visual while preserving its existing styling and layout. Supports field roles and dry-run change plans before writing.

Instructions

Add or remove measures and columns on a visual without modifying visual styling or layout.

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": {
      "visual_id_or_title": "<visual_id_or_title>"
    },
    "name": "update_visual_fields"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoOptional page name or ID.
dry_runNoWhen true, return the proposed ChangePlan without modifying files. Defaults to true. Set false to execute the write with post-write validation.
workspaceNoWorkspace identifier returned by list_workspaces (prefer workspace_id or unique name). Optional when the server is bound to a single workspace.
add_fieldsNoFields to add, e.g. ['Sales[Total Revenue]'] or [{'field': 'Customer[Region]', 'role': 'Category'}].
remove_fieldsNoFields to remove, e.g. ['Sales[Total Cost]'] or ['Total Cost'].
visual_id_or_titleYesVisual ID or human-readable title of the visual to edit.

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.6/5.0
Behavior3/5

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

No annotations are provided, so the description carries the full behavioral burden. It usefully discloses a scoping guarantee — styling and layout are untouched — which tells the agent this is a narrowly-scoped mutation, but it says nothing about permission requirements, whether removals are reversible, ordering of add vs remove, or that the schema's dry_run defaults to a non-writing preview.

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?

A single front-loaded sentence with the action first and the scope constraint second; every clause earns its place and there is no boilerplate or redundancy.

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

Completeness3/5

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

With an output schema present and 100% schema coverage, the description need not explain returns or parameters. However, for a mutation tool with zero annotations, six parameters, and a dry_run flag that gates writes, the definition is thin on write-safety context (validation, reversibility, failure behavior), leaving that burden entirely to the schema.

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 100%, so parameter documentation is already covered by the schema; the description only needs to frame the intent, which it does by tying 'add or remove' to the add_fields/remove_fields pair. It does not restate field-reference syntax or the dry_run default, but the schema handles both, making the baseline-plus framing adequate.

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 concrete verb pair (add/remove) and resource (measures and columns on a visual), which clearly distinguishes it from read-only siblings like get_visual or list_visuals and from update_measure_dax. It stops short of naming a sibling tool or the alternative to use for styling/layout changes, so differentiation is implicit rather than explicit.

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 phrase 'without modifying visual styling or layout' implicitly carves out a boundary — use this only for field changes, not formatting — which is a mild when-not signal. There is no explicit when-to-use statement, no mention of prerequisites (e.g. needing the visual to exist or a workspace binding), and no guidance on validating before writing.

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