Power BI Report MCP Server

Overview Schema Source Related Servers Discussions Admin

Get Visual

pbir_get_visual

Read-only

Retrieve details of a Power BI visual by ID, returning position, type, title, and bindings summary, or full PBIR JSON with verbose option.

Instructions

Get visual details. Default returns id/type/position/title/bindings summary. verbose:true returns full PBIR JSON.

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": {
      "visualId": "<visualId>"
    },
    "name": "pbir_get_visual"
  }
}

Input Schema

Name	Required	Description
`slim`	No	Deprecated alias for !verbose.
`pageId`	No	Page ID. Auto-resolved when only one page exists.
`verbose`	No	Full raw PBIR JSON (heavy).
`visualId`	Yes	The visual ID

Output Schema

Name	Required	Description	Default
`h`	No
`w`	No
`x`	No
`y`	No
`id`	No
`name`	No
`type`	No
`error`	No
`title`	No
`_cache`	No
`success`	No
`bindings`	No
`slicerMode`	No
`visualType`	No
`filterCount`	No
`multiSelect`	No

Schema Changelog

Changes observed during successful MCP inspections.

First observedv0.9.6Jul 30, 2026

TDQS

A4.3/5.0

Behavior4/5

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

Annotations already mark readOnlyHint=true. The description adds valuable behavioral context: default returns a summary, verbose returns full raw PBIR JSON. No contradictions.

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 concise sentences, front-loaded with purpose, minimal waste. Every sentence adds value.

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

Completeness5/5

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

Given the output schema exists, the description adequately covers default and verbose output. No missing information for a read tool with rich schema and annotations.

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 coverage is 100%, so baseline 3. The description adds meaning by stating 'slim' is deprecated alias for '!verbose', and explains verbose effect beyond schema. Provides useful nuance.

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

Purpose5/5

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

The description 'Get visual details' clearly states the action and resource, with specific details on default output and the verbose option, distinguishing it from listing or mutation tools.

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?

No explicit guidance on when to use this tool versus alternatives like pbir_list_visuals for listing all visuals or other getters. The context implies it's for reading a single visual, but lacks explicit when-not or alternative references.

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

Deploy Server