Skip to main content
Glama

get_visual

Retrieve a Power BI visual's details and current role-grouped field bindings by ID or title, using page or workspace filters to disambiguate duplicate titles.

Instructions

Get a visual's details and current role-grouped field bindings by ID or title.

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": "get_visual"
  }
}

Input Schema

NameRequiredDescriptionDefault
pageNoOptional page name or ID to disambiguate visuals with identical titles.
workspaceNoWorkspace identifier returned by list_workspaces (prefer workspace_id or unique name). Optional when the server is bound to a single workspace.
visual_id_or_titleYesVisual ID or human-readable visual title.

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.2.0

TDQS

A3.5/5.0
Behavior3/5

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

With no annotations at all, the description must carry the behavioral burden. 'Get' signals a read operation and 'current role-grouped field bindings' usefully hints at what is returned, but there is nothing about permission requirements, whether the binding data can be stale, or behavior when the title is ambiguous (that is left entirely to the schema).

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 no filler; the resource and the payload are stated before the lookup mechanism, so every clause earns its place.

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?

An output schema exists, so return values need not be spelled out, and the three parameters are fully documented in the schema. However, for a tool with no annotations the definition says nothing about mutation safety, ambiguity resolution, or how it relates to the listing sibling, leaving gaps an agent would want closed.

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 the schema already explains page, workspace, and visual_id_or_title. The description's 'by ID or title' merely restates the required parameter and adds no disambiguation syntax or format detail beyond what the schema provides.

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 verb 'Get' plus resource 'visual' and the specific return content ('details and current role-grouped field bindings') make the purpose concrete, and the lookup key (ID or title) is stated. It stops short of distinguishing itself from list_visuals or get_table, leaving the reader to infer the single-item vs enumeration split.

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 only implied: retrieve one visual when you already have an ID or title. There is no explicit when-to-use, no mention of when to prefer list_visuals, and no stated preconditions such as needing a bound workspace.

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