Skip to main content
Glama

report_get_definition

Read-only

Extracts a report's complete definition (PBIR or PBIR-Legacy), saves all report files to a target directory, and returns the written file list.

Instructions

Get the full definition of a report (PBIR or PBIR-Legacy format). Writes all definition files (report.json, pages, visuals, etc.) to the specified output directory and returns the list of files written.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reportIdYesThe report ID
workspaceIdYesThe workspace ID
outputDirectoryPathYesDirectory path where report definition files will be written

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv2.8.0

TDQS

A4/5.0
Behavior4/5

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

Despite readOnlyHint=true, the description transparently discloses that the tool writes all definition files to an output directory and returns the list of written files. This adds context beyond the annotations, though it does not mention details like whether existing files are overwritten or whether the directory must already exist.

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 sentences with no filler: the first states the core purpose, and the second describes the side effect and return value. This is appropriately front-loaded and concise.

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?

The description names the output behavior, the return value, and the relevant formats, which is sufficient for a moderate-complexity tool. A small gap is that it does not specify whether the output directory is created automatically or must already exist.

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 documents each parameter. The description adds a bit of clarity by explaining that outputDirectoryPath receives the written definition files, but it does not add deeper semantics for reportId or workspaceId beyond what the schema provides.

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 clearly states a specific verb and resource: 'Get the full definition of a report' in PBIR or PBIR-Legacy format. It also distinguishes itself from sibling tools like report_get by emphasizing that it writes the complete definition files and returns the list of files written.

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 'full definition' implies use cases involving export of the complete report definition, but the description does not explicitly contrast it with alternatives such as report_get, report_get_pages, or report_get_datasources. Usage context is implied rather than explicitly stated.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/mkoziel2000/mcp-fabric-api'

If you have feedback or need assistance with the MCP directory API, please join our Discord server