Skip to main content
Glama
README.md
# pbirb-mcp

[![CI](https://github.com/mafaq229/pbirb-mcp/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/mafaq229/pbirb-mcp/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/pbirb-mcp.svg)](https://pypi.org/project/pbirb-mcp/)
[![Python versions](https://img.shields.io/pypi/pyversions/pbirb-mcp.svg)](https://pypi.org/project/pbirb-mcp/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

An MCP server for editing **Power BI Report Builder paginated reports** (`.rdl`)
through Claude (Desktop, CLI, or any MCP client). 140+ tools cover the gaps
that otherwise force hand-written XML: report creation, data sources and
datasets, calculated fields, dataset and tablix filters, groupings (row,
column, matrix), sorting, charts, headers and footers, body composition,
layout containers, positioning, styling, page setup, pagination, advanced
parameters, embedded images, interactivity (actions, tooltips, document
map), transactions, and validation.

The server speaks MCP (JSON-RPC 2.0) over stdio, MCP protocol revisions
2024-11-05 through 2026-07-28. It opens an `.rdl` from disk, mutates it in
place via lxml, validates structure, and writes atomically — a failed save
never leaves a half-written report or scrubs the original.

> **Security defaults.** The `pbirb-mcp` server only opens files under the
> directory it was started in, and refuses destructive tools (removals,
> `convert_to_matrix`, `raw_xml_replace` / `raw_xml_remove`,
> `restore_from_backup`) until the
> call carries `confirm=true`. MCP clients often start servers in `/` or in
> their own app directory, so **set `PBIRB_MCP_ALLOWED_ROOTS` to your
> reports folder** (see [Security defaults](#security-defaults)).

## Stability

Pre-1.0. The tool surface — tool names, `inputSchema`, output shapes, error
semantics — is the contract. While on `0.x`, MINOR releases may include a
small breaking change with a migration note in
[CHANGELOG.md](CHANGELOG.md); after v1.0, breaking changes require MAJOR.
See [CONTRIBUTING.md](CONTRIBUTING.md#versioning) for the full bump rules
adapted from SemVer for an MCP tool surface.

Pin to a MINOR while on `0.x` (e.g. `pbirb-mcp~=0.1`) if your prompts
depend on specific tool names or schemas.

---

## Quick start

### 1. Install

The simplest path is [uv](https://docs.astral.sh/uv/) + PyPI — no clone, no
venv, no install step:

```bash
uvx pbirb-mcp
```

uvx fetches the package into a throwaway environment, runs the
`pbirb-mcp` console script, and exits. The MCP server speaks JSON-RPC
over stdio, so any MCP client (Claude Desktop, Claude Code, etc.) can
spawn it directly.

For local development against this codebase instead:

```bash
git clone https://github.com/mafaq229/pbirb-mcp
cd pbirb-mcp
uv venv .venv
uv pip install --python .venv/bin/python -e ".[dev]"
```

Verify the binary works:

```bash
printf '%s\n' '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"smoke","version":"1"}}}' \
  | .venv/bin/pbirb-mcp
```

You should see a single JSON-RPC response with `protocolVersion`,
`capabilities.tools`, and `serverInfo.name = "pbirb-mcp"`.

### 2. Wire into Claude Desktop

Edit `~/Library/Application Support/Claude/claude_desktop_config.json` (macOS)
or `%APPDATA%\Claude\claude_desktop_config.json` (Windows):

```json
{
  "mcpServers": {
    "pbirb": {
      "command": "uvx",
      "args": ["pbirb-mcp"],
      "env": {
        "PBIRB_MCP_ALLOWED_ROOTS": "/Users/you/Reports"
      }
    }
  }
}
```

Claude Desktop may start the server with its working directory set to `/` or
to the app's own directory, and by default the server only opens files under
its working directory — so set `PBIRB_MCP_ALLOWED_ROOTS` to the folder(s)
holding your reports (on Windows e.g. `"C:\\Users\\you\\Reports"`; separate
several with `:` on macOS/Linux, `;` on Windows). See
[Security defaults](#security-defaults).

Restart Claude Desktop. The hammer icon should show `pbirb` and the 140+ tools
listed below.

To enable file logging, add `PBIRB_MCP_LOG_FILE` to the `env` block — but keep
it platform-appropriate: it takes an OS-native path, so a Unix path like
`/tmp/pbirb-mcp.log` only works on macOS/Linux. On Windows use a Windows path
(e.g. `%TEMP%\\pbirb-mcp.log`). See [Logging](#logging). When unset, logs go to
stderr, which Claude Desktop captures in its MCP debug pane on every platform.

For development against a local checkout, swap the `args` for
`["--from", "/absolute/path/to/pbirb-mcp", "pbirb-mcp"]` so uvx runs
your working tree instead of the published version.

### 3. Wire into Claude Code

```bash
claude mcp add pbirb -- uvx pbirb-mcp
```

Or add to `.mcp.json` at the workspace root:

```json
{
  "mcpServers": {
    "pbirb": {
      "command": "uvx",
      "args": ["pbirb-mcp"]
    }
  }
}
```

**Or install it as a Claude Code plugin** — one command instead of editing
config by hand (it wires up the same `uvx pbirb-mcp` server for you):

```bash
/plugin marketplace add mafaq229/pbirb-mcp
/plugin install pbirb-mcp@pbirb
```

### 4. Smoke test

In any chat, ask the model:

> Open `~/path/to/some-report.rdl` and tell me what datasets and parameters it has.

The model should call `describe_report`, `get_datasets`, and `get_parameters`
and summarise the result. If it doesn't, your client probably hasn't loaded
the server — check the client's MCP debug log.

---

## Configuration

### Security defaults

The `pbirb-mcp` command (what MCP clients launch) is locked down by default:

- **File access is limited to the working directory.** Every path argument
  (`path` and every `*_path`) must resolve — symlinks and `..` followed —
  inside an allowed root, or the call is refused with `PathNotAllowed`
  before anything is read or written. Set `PBIRB_MCP_ALLOWED_ROOTS` to the
  directories to allow (`os.pathsep`-separated: `:` on macOS/Linux, `;` on
  Windows); `*` means unrestricted. Clients such as Claude Desktop may start
  the server in `/` or their app directory, so set it explicitly (see the
  config example in the Quick start).
- **Destructive tools need `confirm=true`.** Tools that delete report
  content or overwrite a file (every `remove_*`, `convert_to_matrix`,
  `raw_xml_replace` / `raw_xml_remove`, `restore_from_backup`, and an `apply_edits` batch that
  contains one) are refused with `ConfirmationRequired` until the call
  carries `confirm=true`; 2026-07-28 clients that support elicitation are
  asked to confirm instead. `PBIRB_MCP_REQUIRE_CONFIRM=0` turns this off.
- **Audit log (opt-in).** `PBIRB_MCP_AUDIT_LOG=/path/to/audit.jsonl` appends
  one JSON line per edit and per transaction commit.

An `MCPServer` embedded in Python (tests, the eval harness, library use)
defaults to unrestricted roots and no confirmation; the same environment
variables opt it in.

### Toolsets and read-only mode

By default the server lists every tool. To give the model fewer tool
definitions to read (and fewer to choose from), enable only the toolsets a
task needs, and/or run read-only:

```json
{
  "mcpServers": {
    "pbirb": {
      "command": "uvx",
      "args": ["pbirb-mcp", "--toolsets", "data,parameters", "--read-only"]
    }
  }
}
```

| Toolset | Covers |
|---------|--------|
| `core` | Always on: `describe_report`, `validate_report` / `verify_report` / `lint_report`, `diff_report`, `apply_edits`, `dry_run_edit`, transactions, expression helpers |
| `data` | Data sources, datasets, DAX queries, query parameters, fields, dataset filters |
| `parameters` | Report parameters: declarations, available/default values, prompts, pane layout |
| `tablix` | Tables and matrices: groups, columns, rows, subtotals, spans, filters, sorting, group visibility, pagination |
| `chart` | Charts: series, axes, legend, data labels, palette, colours, title |
| `style` | Textbox text and formatting, finding textboxes, row styling |
| `layout` | Page setup, body/header/footer items, positions and sizes, containers, images, embedded images, element visibility |
| `interactivity` | Actions (links, drill-through, bookmarks), tooltips, document map |
| `admin` | `create_report`, `duplicate_report`, backups, the raw-XML escape hatch |

- `--toolsets` takes comma-separated names, `all`, or `default`
  (`PBIRB_MCP_TOOLSETS` sets the same; the flag wins). Unknown names are
  an error. `pbirb-mcp --list-toolsets` prints every toolset's tools.
- `--read-only` (or `PBIRB_MCP_READ_ONLY=1`) exposes only tools published
  with `readOnlyHint: true` — readers, validation, expression helpers and
  `dry_run_edit`, which previews an edit on a temp copy.
- The limits are enforced when a tool is *called*, not only in
  `tools/list`: a call outside the enabled toolsets, or an edit in
  read-only mode, returns an `isError` result (`ToolNotEnabled` /
  `ReadOnlyMode`) naming the setting to change. `apply_edits` /
  `dry_run_edit` ops are held to the same toolsets.

Every tool also carries MCP annotations (`readOnlyHint`, `destructiveHint`,
`idempotentHint`, `openWorldHint: false`) and a display `title`, so clients
can auto-approve the readers and flag the destructive tools.

### Environment variables

| Variable | Default | Purpose |
|----------|---------|---------|
| `PBIRB_MCP_ALLOWED_ROOTS` | `pbirb-mcp`: the working directory; embedded `MCPServer`: unrestricted | Directories report paths must be inside (`os.pathsep`-separated); `*` = unrestricted. See [Security defaults](#security-defaults). |
| `PBIRB_MCP_REQUIRE_CONFIRM` | `pbirb-mcp`: on; embedded: off | Destructive tools need `confirm=true`. `0` / `false` turns it off. |
| `PBIRB_MCP_AUDIT_LOG` | off | File to append one JSON line to per edit and per transaction commit. |
| `PBIRB_MCP_TOOLSETS` | every toolset | Comma-separated toolsets to expose (`--toolsets` overrides it). See [Toolsets](#toolsets-and-read-only-mode). |
| `PBIRB_MCP_READ_ONLY` | off | `1` exposes only read-only tools (`--read-only` turns it on). |
| `PBIRB_MCP_AUTO_VERIFY` | off | `1` runs `verify_report` after every successful edit outside a transaction; the result becomes `{result, verify}`. Transactions verify at commit. |
| `PBIRB_MCP_TRANSACTION_TIMEOUT_S` | `600` | Seconds an editing transaction lives without a commit or cancel; an expired one is discarded (nothing saved). |
| `PBIRB_MCP_LOG_LEVEL` | `WARNING` | `DEBUG` / `INFO` / `WARNING` / `ERROR`. |
| `PBIRB_MCP_LOG_FILE` | stderr | Log file path (see [Logging](#logging)). |
| `PBIRB_MCP_AUTO_BACKUP` | off | `1` backs the report up (`<path>.bak.<UTC-timestamp>`) before every removal, rename, query rewrite, `raw_xml_replace` / `raw_xml_remove` and `convert_to_matrix`; the result's `auto_backup` is the backup path. A backup that already holds the file's bytes is reused. |

Truthy values are `1`, `true`, `yes`, `on` (case-insensitive).

### Logging

| Variable | Default | Purpose |
|----------|---------|---------|
| `PBIRB_MCP_LOG_LEVEL` | `WARNING` | `DEBUG` / `INFO` / `WARNING` / `ERROR` |
| `PBIRB_MCP_LOG_FILE` | stderr | Path to a log file; otherwise logs go to stderr (where Claude Desktop captures them in its MCP debug pane) |

```bash
PBIRB_MCP_LOG_LEVEL=DEBUG PBIRB_MCP_LOG_FILE=/tmp/pbirb-mcp.log pbirb-mcp
```

---

## Working with a report

The recommended flow is **read first, then edit by name**. Every mutating
tool addresses elements by their RDL `Name` attribute (Tablix name,
Textbox name, ReportParameter name, DataSet name) — never by index.
Indices break across multi-step edits.

A typical session:

```text
You:    Bind the existing report at ~/Reports/sales.rdl to the Finance
        workspace's "FY26 Sales" dataset, change the body DAX to a date-
        ranged query, and add a header with a logo and a parameter line.

Claude: → describe_report(path=…)
        → set_datasource_connection(name="PBIDataset",
              workspace_url="Finance", dataset_name="FY26 Sales")
        → update_dataset_query(dataset_name="MainDataset",
              dax_body="EVALUATE FILTER('Sales',
                'Sales'[OrderDate] >= @DateFrom &&
                'Sales'[OrderDate] <= @DateTo)")
        → add_query_parameter(dataset_name="MainDataset",
              name="DateFrom",
              value_expression="=Parameters!DateFrom.Value")
        → add_query_parameter(dataset_name="MainDataset",
              name="DateTo",
              value_expression="=Parameters!DateTo.Value")
        → add_embedded_image(name="Logo",
              mime_type="image/png", image_path="~/brand/logo.png")
        → set_page_header(height="0.75in",
              print_on_first_page=True, print_on_last_page=True)
        → add_header_image(name="HeaderLogo",
              image_source="Embedded", value="Logo",
              top="0in", left="0in", width="1in", height="0.5in")
        → add_header_textbox(name="DateLine",
              text='="From: " & Parameters!DateFrom.Value & "  To: "
                    & Parameters!DateTo.Value',
              top="0.1in", left="1.2in", width="4in", height="0.25in")
```

Open the resulting `.rdl` in Report Builder; the change is visible in the
designer and renders in Preview against the bound dataset.

---

## Tool reference

The tools, grouped by RDL concern. The highlights of each group are tabled
below; the authoritative, always-current list with full schemas is the
server's `tools/list` output (`pbirb-mcp --list-toolsets` prints the names by
toolset), and [docs/TOOLS.md](docs/TOOLS.md) has every tool's full behaviour
notes. Every report tool takes a `path` argument (absolute path to the
`.rdl`).

Every tool that takes a report path also accepts an optional
`transaction_id`, so a multi-step edit batches into a single atomic save —
see [Transactions](#transactions--validation) and
[docs/TRANSACTIONS.md](docs/TRANSACTIONS.md).

### Read-only inventory

The "what's in this report?" tools. Always the first calls when planning a
multi-step edit.

| Tool | Returns |
|------|---------|
| `describe_report` | Top-level inventory: data sources, datasets, parameters, tablixes, page setup |
| `get_datasets` / `get_dataset` | Full DAX command text, fields, query parameters, dataset filters (all, or one by name) |
| `list_data_sources` / `get_data_source` | Data source inventory; one source's connection details |
| `get_parameters` | Report parameters with data type, prompt, and flags (multi-value, hidden, nullable, allow-blank) |
| `get_tablixes` | Tablix layout: columns, row/column groups, sort expressions, filters, visibility |
| `list_tablix_filters` / `list_dataset_filters` | Filters in document order with stable indices |
| `list_body_items` / `list_header_items` / `list_footer_items` | Named report items in each region |
| `get_textbox` / `get_image` / `get_rectangle` / `get_chart` | Full properties of a named report item |
| `list_embedded_images` / `get_embedded_image_data` | Embedded image names + MIME types; base64 bytes of one |
| `get_expression_reference` | Cheat-sheet of common RDL expression patterns (`count_where`, `sum_where`, `iif_format` helpers build these) |

### Datasource & dataset

| Tool | What it edits |
|------|---------------|
| `set_datasource_connection` | Repoint a `<DataSource>` at a Power BI XMLA endpoint. `DataProvider=SQL` (the AS provider id). |
| `add_data_source` / `remove_data_source` / `rename_data_source` | Manage `<DataSource>` elements |
| `update_dataset_query` | Replace `<DataSet>/<Query>/<CommandText>` with a DAX expression |
| `add_query_parameter` | Append `<QueryParameter>` (e.g. `=Parameters!DateFrom.Value`) |
| `update_query_parameter` | Change the value expression of an existing query parameter |
| `remove_query_parameter` | Drop a query parameter (and clean up empty `<QueryParameters>`) |
| `add_dataset_field` / `remove_dataset_field` | Manage `<Field>` entries on a dataset |
| `add_calculated_field` / `remove_calculated_field` | Manage `<Value>`-backed calculated fields |
| `refresh_dataset_fields` | Re-derive the `<Fields>` list from the query's column metadata |
| `add_dataset_filter` / `remove_dataset_filter` | Filters applied at the dataset level (vs. tablix) |
| `add_dataset` / `remove_dataset` / `rename_dataset` | Manage `<DataSet>` elements; a rename rewrites every reference to the dataset |
| `set_dataset_data_source` / `set_dataset_options` | Point a dataset at another data source; query timeout, collation and case/accent/kana/width sensitivity |
| `rename_dataset_field` / `set_field_type` | Rename a field (rewriting `Fields!X` references) or set its `rd:TypeName` |

### Tablix

| Tool | What it edits |
|------|---------------|
| `add_tablix_filter` | Append a `<Filter>`. Operators: Equal, NotEqual, GreaterThan, In, Between, Like, TopN, ... |
| `remove_tablix_filter` | Remove by ordinal index from `list_tablix_filters` |
| `add_row_group` / `remove_row_group` | Wrap the row hierarchy in a new outer group + header row (and its inverse) |
| `add_column_group` / `remove_column_group` | Same, on the column axis |
| `convert_to_matrix` | Promote a table to a matrix (row + column groups) — see [docs/MATRIX-cookbook.md](docs/MATRIX-cookbook.md) |
| `set_tablix_corner` | Set the matrix corner cell text/expression |
| `set_group_sort` / `set_column_group_sort` | Replace `<SortExpressions>` on a group |
| `set_group_visibility` / `set_column_group_visibility` | Set `<Visibility>` on a group's TablixMember |
| `set_detail_row_visibility` | Set `<Visibility>` on the Details group |
| `add_tablix_column` / `remove_tablix_column` | Add/drop a column across the tablix grid |
| `add_static_row` / `add_static_column` | Insert a non-grouped row/column |
| `add_subtotal_row` / `add_subtotal_column` | Insert an aggregate row/column on a group |
| `set_cell_span` | Set `RowSpan` / `ColSpan` on a cell |
| `set_column_width` / `set_row_height` | Set `<Width>` / `<Height>` on the Nth column/row |
| `set_tablix_size` | Set the tablix's overall `<Width>` / `<Height>` (`distribute=true` rescales the columns to a new width; column edits keep `<Width>` in sync on their own) |
| `set_repeat_header_rows` | Repeat the column header rows on every page |

### Page

| Tool | What it edits |
|------|---------------|
| `set_page_setup` | Page dimensions, margins, columns. All fields optional. |
| `set_page_orientation` | Swap PageHeight/PageWidth to match `Portrait` or `Landscape`. Idempotent. |

### Page header & footer

Same set of operations for each region, each accepts named items so
follow-up edits don't drift on indices.

| Tool | What it edits |
|------|---------------|
| `set_page_header` / `set_page_footer` | Section height + `PrintOnFirstPage` / `PrintOnLastPage` |
| `add_header_textbox` / `add_footer_textbox` | Append a Textbox (static text or `=expression`) |
| `add_header_image` / `add_footer_image` | Append an Image (External URL, Embedded name, or Database expression) |
| `remove_header_item` / `remove_footer_item` | Remove by name; tidies empty `<ReportItems>` |

### Body composition

| Tool | What it edits |
|------|---------------|
| `add_body_textbox` | Append a Textbox to `<Body>/<ReportItems>` |
| `add_body_image` | Append an Image to the body |
| `remove_body_item` | Remove a named report item from the body; refuses while other items still reference it unless `force=true` |
| `rename_report_item` | Rename a report item or group and rewrite every reference to it |

### Snippet templates

Single-call inserts of common report items, programmatically built and
appended to the body.

| Tool | What it builds |
|------|----------------|
| `insert_tablix_from_template` | A basic Tablix mirroring the fixture's shape — header row with the column name as a static label, detail row binding to `=Fields!<column>.Value`. One column per requested field. |
| `insert_chart_from_template` | A basic Column chart: single category axis grouped by `category_field`, single Y series `=Sum(Fields!<value_field>.Value)`. Change `<Type>` post-insert (Bar / Line / Pie / etc.). |

### Charts

Refine a chart after `insert_chart_from_template` (or any existing `<Chart>`).

| Tool | What it edits |
|------|---------------|
| `add_chart_series` / `remove_chart_series` | Manage Y-axis `<ChartSeries>` |
| `set_chart_series_type` | Column / Bar / Line / Area / Pie / ... per series |
| `set_chart_series_grouping` | Category/series grouping expression |
| `set_chart_axis` | Category / value axis title, scale, format |
| `set_chart_legend` | Legend visibility and placement |
| `set_chart_data_labels` | Toggle and format data labels |
| `set_chart_title` | Chart title text/expression |
| `set_chart_palette` / `set_series_color` | Any of the 16 RDL palettes or custom colours; explicit per-series or per-point colour |
| `set_chart_series_properties` | Legend entry, secondary axis, chart area, order, tooltip, markers, empty points of one series |
| `set_chart_category_group` | Edit a category group's label, sort or field, or add a nested level |

### Styling

| Tool | What it edits |
|------|---------------|
| `set_textbox_style` | Routes properties to the right nested `<Style>` node automatically: box-level (BackgroundColor, Border, VerticalAlign), paragraph-level (TextAlign), run-level (FontFamily, FontSize, FontWeight, Color, Format) |
| `set_textbox_style_bulk` | Apply one style to many textboxes in a single call |
| `copy_textbox_style` | Copy one textbox's formatting onto others |
| `set_textbox_runs` / `set_textbox_value` | Rich multi-run paragraph content; or replace the value |
| `find_textboxes_by_style` / `find_textbox_by_value` | Locate textboxes to target follow-up edits |
| `style_tablix_row` | Style every cell of a tablix row at once (header / detail / footer) |
| `set_alternating_row_color` | Zebra-stripe a tablix's detail row with `BackgroundColor=IIf(RowNumber(Nothing) Mod 2, "<a>", "<b>")` |
| `set_conditional_row_color` | Drive detail-row `BackgroundColor` from an expression |
| `set_image_sizing` / `set_image_source` | Image `<Sizing>`; switch External / Embedded / Database source |

### Visibility

| Tool | What it edits |
|------|---------------|
| `set_element_visibility` | Set `<Visibility>` on any named ReportItem (Tablix, Textbox, Image, Rectangle, Subreport, Chart). Group / detail-row visibility have their own tools. |

### Layout containers

| Tool | What it builds |
|------|----------------|
| `add_rectangle` | A `<Rectangle>` container (group other items, control page breaks) |
| `add_list` | A list region (single-column tablix template) |
| `add_line` | A `<Line>` report item |
| `ungroup_rectangle` | Remove a rectangle, moving its items out to its container in place |

### Positioning & sizing

Move and resize named items in each region. Coordinates are RDL sizes
(`"1in"`, `"2.5cm"`, ...).

| Tool | What it edits |
|------|---------------|
| `set_body_item_position` / `set_header_item_position` / `set_footer_item_position` | `Top` / `Left` of a named item |
| `set_body_item_size` / `set_header_item_size` / `set_footer_item_size` | `Width` / `Height` of a named item |
| `set_body_size` | The `<Body>` region's overall height |
| `move_report_item` / `center_item` / `fit_page_to_body` | Move an item between the body, header, footer and rectangles; centre it in its container; fix a body wider than the page |

### Interactivity

| Tool | What it edits |
|------|---------------|
| `set_textbox_action` / `set_image_action` / `set_chart_series_action` | `<Action>`: hyperlink, drill-through, or bookmark |
| `set_item_action` | The same, on any Textbox / Image / Rectangle / Line |
| `set_textbox_tooltip` / `set_item_tooltip` | `<ToolTip>` on a textbox / any report item |
| `set_bookmark` | `<Bookmark>` on any report item (target of BookmarkLink actions) |
| `set_document_map_label` | `<DocumentMapLabel>` for the navigation pane |

### Pagination

| Tool | What it edits |
|------|---------------|
| `set_group_page_break` | `<Group><PageBreak>` (Start / End / Between) |
| `set_repeat_on_new_page` | Repeat a group header/footer on each page |
| `set_keep_together` / `set_keep_with_group` | Keep-together rendering hints |

### Parameters (advanced)

| Tool | What it edits |
|------|---------------|
| `add_parameter` / `remove_parameter` / `rename_parameter` | Manage `<ReportParameter>` elements |
| `set_parameter_prompt` / `set_parameter_type` | Prompt text; data type (Boolean / DateTime / Integer / Float / Text) |
| `set_parameter_available_values` | Static `<ParameterValues>` list (strings or `{value, label}` dicts) **or** `<DataSetReference>` to a lookup dataset |
| `set_parameter_default_values` | Static `<Values>` list **or** `<DataSetReference>` (defaults take ValueField only — defaults are values, not display strings) |
| `update_parameter_advanced` | Toggle the four boolean flags: `multi_value`, `hidden`, `allow_null` (writes `<Nullable>`), `allow_blank` |
| `reorder_parameters` | Reorder `<ReportParameters>` (controls prompt order) |
| `set_parameter_layout` / `sync_parameter_layout` | Position parameters in the `<ReportParametersLayout>` grid |

#### Cascading parameters

RDL has no `<DependsOn>` element — cascading is inferred from
`=Parameters!X.Value` references in a lookup dataset's `<QueryParameters>`.
To wire parameter `B` to depend on parameter `A`:

1. `set_parameter_available_values(name="B", source="query", query_dataset="LookupB", ...)`
2. `add_query_parameter(dataset_name="LookupB", name="@A", value_expression="=Parameters!A.Value")`

Report Builder figures out the dependency graph by parsing those expressions.

### Embedded images

| Tool | What it edits |
|------|---------------|
| `add_embedded_image` | Read a real file off disk, base64-encode it, store under `<EmbeddedImages>` |
| `list_embedded_images` | Names + MIME types |
| `remove_embedded_image` | Remove by name; tidies empty `<EmbeddedImages>` |

Reference an embedded image with
`add_*_image(image_source="Embedded", value="<image-name>")`.

### Report lifecycle

| Tool | What it does |
|------|--------------|
| `create_report` | Scratch-create a minimal valid `.rdl` to start from |
| `duplicate_report` | Copy a report to a new path |
| `backup_report` / `list_backups` / `restore_from_backup` | Snapshot a report (optional folder and label), list its backups and roll back to one (set `PBIRB_MCP_AUTO_BACKUP=1` for automatic backups before destructive edits) |

### Expression helpers

These don't mutate the report — they build correct RDL expression strings to
pass into other tools (text, filters, conditional styling).

| Tool | What it returns |
|------|-----------------|
| `count_where` / `sum_where` | A `Count`/`Sum` aggregate expression with an inline condition |
| `iif_format` | An `IIf(...)` expression for conditional values/formatting |
| `get_expression_reference` | A reference sheet of common RDL expression patterns |

### Transactions & validation

Batch many edits into one atomic save, and check correctness before/after.

| Tool | What it does |
|------|--------------|
| `start_editing_transaction` / `commit_editing_transaction` / `cancel_editing_transaction` | Open an in-memory transaction, verify (XSD + lint, new errors only) and save once, or discard. See [docs/TRANSACTIONS.md](docs/TRANSACTIONS.md). |
| `apply_edits` | Apply a list of tool calls in one transaction |
| `dry_run_edit` | Preview an edit's effect without writing to disk |
| `diff_report` | Semantic diff of a report against a baseline (added / removed / changed items, ignoring layout noise) |
| `validate_report` / `verify_report` | Structural + XSD validation against the bundled `reportdefinition.xsd`; `verify_report` adds lint |
| `lint_report` | Surface warnings/errors Report Builder would flag |

### Raw XML escape hatch

| Tool | What it does |
|------|--------------|
| `raw_xml_view` | Read the XML under an XPath |
| `raw_xml_replace` | Replace the XML at an XPath — last resort for anything without a dedicated tool |
| `raw_xml_insert` / `raw_xml_remove` | Insert XML at an XPath; remove the node(s) it matches |

---

## Power BI specifics

### XMLA connection strings

`set_datasource_connection` writes the canonical form:

```
Data Source=powerbi://api.powerbi.com/v1.0/myorg/<workspace>;Initial Catalog=<dataset>
```

`workspace_url` accepts a bare workspace name (`Finance`) or a full
`powerbi://` URL — the tool detects the latter and avoids double-prefixing.
`DataProvider` is set to `SQL` (the Analysis Services provider id RDL uses
for PBI XMLA, despite the misleading name).

### DAX queries

DAX bodies are accepted verbatim — `pbirb-mcp` doesn't parse DAX, so the
user (or Report Builder at preview time) is the source of truth for syntax.
Empty bodies are rejected up front because Report Builder loads them but
errors at preview, which is a worse signal than a clear `ValueError` here.

PBI paginated reports do **not** carry `<CommandType>` for DAX (unlike
SSRS where you'd set `CommandType=StoredProcedure`); these tools never
emit it.

### Pre-commit hooks (contributors)

`pre-commit` is in the `[dev]` extras. After a fresh checkout:

```bash
uv pip install --python .venv/bin/python -e ".[dev]"
.venv/bin/pre-commit install                # one-time — installs the git hook
.venv/bin/pre-commit run --all-files        # one-time — clean any drift
```

After the hook is installed, every `git commit` runs ruff format +
ruff check (with `--fix`) + the fast pytest suite. If lint or tests
fail the commit is aborted; fix and re-stage before retrying.

To run individual hooks ad-hoc:

```bash
.venv/bin/pre-commit run ruff --all-files
.venv/bin/pre-commit run ruff-format --all-files
.venv/bin/pre-commit run pytest-fast --all-files
```

The full config lives in `.pre-commit-config.yaml`. Ruff settings
(line length, rule selection, per-file ignores) live under
`[tool.ruff*]` in `pyproject.toml`.

### Report Builder install

Power BI Report Builder is a free Microsoft-distributed Windows app:

> https://www.microsoft.com/en-us/download/details.aspx?id=105942

Open any `.rdl` produced by `pbirb-mcp` directly in Report Builder. The
"opens cleanly with no upgrade prompt" check is the actual integration
test — the unit tests verify schema correctness, but lxml will
round-trip XML that Report Builder's deserialiser still rejects (we hit
this twice in the chart-template work; both fixes are documented in the
git history).

---

## Architecture

```
pbirb-mcp/
├── pbirb_mcp_server.py         # Entry point (CLI flags, logging, main())
├── pbirb_mcp/
│   ├── protocol.py             # MCP protocol on the official SDK (stdio, versions)
│   ├── server.py               # Tool registry + dispatcher, annotations
│   ├── tools.py                # Tool definitions — wires ops into the server
│   ├── core/
│   │   ├── security.py         # Allowed roots, confirmation, audit log
│   │   ├── toolsets.py         # Toolsets + read-only mode
│   │   ├── document.py         # RDLDocument: open/save (lxml), atomic write
│   │   ├── xpath.py            # Namespace-aware XPath helpers
│   │   ├── ids.py              # Stable element addressing
│   │   ├── encoding.py         # XML declaration / self-closing-tag fidelity
│   │   ├── transactions.py     # In-memory transaction registry
│   │   └── schema.py           # Structural + opt-in XSD validation
│   ├── ops/                    # One module per RDL concern; wired into tools.py
│   │   ├── reader.py           # describe / get_datasets / get_params / get_tablixes
│   │   ├── datasource.py       # PBI XMLA connection + data-source management
│   │   ├── dataset.py          # DAX body, query params, fields, calc fields, filters
│   │   ├── tablix.py           # Row/column groups, sort, visibility, matrix
│   │   ├── tablix_columns.py   # Add/remove tablix columns
│   │   ├── tablix_cells.py     # Cell span
│   │   ├── tablix_static.py    # Static rows / columns
│   │   ├── tablix_subtotals.py # Subtotal rows / columns
│   │   ├── chart.py            # Chart series, axes, legend, labels, palette
│   │   ├── page.py             # Page setup + orientation
│   │   ├── layout.py           # Pagination (page breaks, keep-together, repeat)
│   │   ├── header_footer.py    # Page header / footer authoring
│   │   ├── body.py             # Body textboxes / images / containers / removal
│   │   ├── positioning.py      # Move / resize named items per region
│   │   ├── templates.py        # Chart + tablix snippet builders
│   │   ├── styling.py          # Textbox styles, runs, bulk, row styling, find
│   │   ├── images.py           # Image sizing / source
│   │   ├── actions.py          # Actions, tooltips, document-map labels
│   │   ├── visibility.py       # Element-level visibility
│   │   ├── parameters.py       # Lifecycle, values, advanced flags, layout
│   │   ├── embedded_images.py  # Base64 image embedding
│   │   ├── expressions.py      # Expression-builder helpers (count/sum/iif)
│   │   ├── filter_types.py     # Filter operator definitions
│   │   ├── clone.py            # duplicate_report
│   │   ├── scratch.py          # create_report
│   │   ├── snapshot.py         # backup / restore
│   │   ├── transactions.py     # start/commit/cancel + apply_edits
│   │   ├── dry_run.py          # dry_run_edit
│   │   ├── validate.py         # validate / verify
│   │   ├── lint.py             # lint_report
│   │   └── escape.py           # raw_xml_view / raw_xml_replace
│   └── schemas/                # Bundled RDL 2016 XSD (reportdefinition.xsd) for opt-in validation
└── tests/
    ├── fixtures/
    │   └── pbi_paginated_minimal.rdl  # Hand-tuned to match Report Builder's emitted style
    └── test_*.py               # every tool plus round-trip invariants
```

### Hard rules (enforced by tests)

- **Tests first.** Every commit writes failing tests, then makes them pass.
- **lxml, not stdlib `xml.etree`.** Round-trip fidelity is a feature, not
  polish. Report Builder reads what's on disk; formatting drift causes
  silent corruption.
- **Stable IDs, never indices.** Tools take `tablix_name` + `group_name`,
  not `column_index: 2`. Indices break across multi-step edits.
- **Atomic save.** Every write goes to a temp file next to the report and is
  renamed over it (`core.document.write_atomic`), following symlinks and
  keeping the file's mode. A failure mid-write never leaves a half-written
  report.
- **Round-trip byte-identity is enforced** by `tests/test_byte_fidelity.py`
  (BOM × CRLF × trailing-newline matrix, Report Builder's
  `MustUnderstand` root and `<Style></Style>` form) and
  `tests/test_document.py`. A no-op open → save → reopen produces a
  byte-identical file, and a one-value edit changes one line.

### RDL gotchas learned the hard way

- `<?xml version="1.0" encoding="utf-8"?>` uses **double quotes**, not
  lxml's default single quotes. Fixed in `RDLDocument.save_as` via a
  manual declaration.
- Self-closing tags use `<Tag />` with a space, not `<Tag/>`. Fixed via
  a post-process regex.
- The `rd:` prefix
  (`http://schemas.microsoft.com/SQLServer/reporting/reportdesigner`)
  carries designer metadata Report Builder relies on. Don't strip it;
  preserve prefixes.
- Do **not** put `MustUnderstand="df"` on `<Report>` unless you also
  declare `xmlns:df=...`.
- `<ChartCategoryAxes>` / `<ChartValueAxes>` hold `<ChartAxis>`
  children **directly** — there is no `<ChartCategoryAxis>` /
  `<ChartValueAxis>` wrapper.
- `<ChartMember>` requires a `<Label>` child, even an empty one.
- DAX queries live in
  `<DataSet><Query><CommandText>EVALUATE ...</CommandText></Query></DataSet>`.
  No `<CommandType>` element for DAX (unlike SSRS).

---

## Development

### Running tests

```bash
.venv/bin/python -m pytest tests/ -v
```

The suite is fast (well under a minute) so re-run on every change.

### Smoke testing the live binary

```bash
printf '%s\n' \
  '{"jsonrpc":"2.0","id":1,"method":"initialize","params":{"protocolVersion":"2025-11-25","capabilities":{},"clientInfo":{"name":"smoke","version":"1"}}}' \
  '{"jsonrpc":"2.0","method":"notifications/initialized"}' \
  '{"jsonrpc":"2.0","id":2,"method":"tools/list"}' \
  | .venv/bin/pbirb-mcp
```

For an end-to-end sanity check, drive an actual mutation against a copy of
the bundled fixture:

```bash
SCRATCH=$(mktemp -d)/r.rdl
cp tests/fixtures/pbi_paginated_minimal.rdl "$SCRATCH"
.venv/bin/python -c "
from pbirb_mcp.ops.dataset import update_dataset_query
update_dataset_query(path='$SCRATCH', dataset_name='MainDataset',
    dax_body=\"EVALUATE TOPN(10, 'Sales')\")
print('Wrote', '$SCRATCH')
"
```

Open the resulting file in Power BI Report Builder. **Manual verification
that an `.rdl` opens cleanly is the actual integration test** — the unit
tests catch schema-level mistakes, but only Report Builder catches
deserialiser nits.

### Adding a new tool

1. Write tests first under `tests/test_*.py`.
2. Implement in the appropriate `pbirb_mcp/ops/*.py` module (or create a
   new one).
3. Register in `pbirb_mcp/tools.py` with a short `description` (purpose
   first, at most 400 characters, no release history — longer notes go in
   [docs/TOOLS.md](docs/TOOLS.md)) and a strict `inputSchema`; add it to a
   toolset in `pbirb_mcp/core/toolsets.py`.
4. Run the full suite and a JSON-RPC smoke against the fixture.
5. Open the modified RDL in Report Builder.

The commit-by-commit history shows the pattern in practice.

---

## Releases

[CHANGELOG.md](CHANGELOG.md) tracks every release in
[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) format. Releases
are also published as
[GitHub Releases](https://github.com/mafaq229/pbirb-mcp/releases) and to
[PyPI](https://pypi.org/project/pbirb-mcp/).

Versions follow SemVer adapted for an MCP tool surface — see
[CONTRIBUTING.md § Versioning](CONTRIBUTING.md#versioning).

## Contributing

PRs welcome. [CONTRIBUTING.md](CONTRIBUTING.md) covers dev setup, the
hard rules (tests-first, lxml only, stable IDs, atomic save,
byte-identity round-trip, smoke in Report Builder), the SemVer-for-MCP
bump table, and the PR review checklist.

Bug reports and tool proposals: please use the
[issue templates](https://github.com/mafaq229/pbirb-mcp/issues/new/choose).
For security issues, see [SECURITY.md](SECURITY.md). All participants
are expected to follow the [Code of Conduct](CODE_OF_CONDUCT.md).

---

## Acknowledgments

The existing [bethmaloney/rdl-mcp](https://github.com/bethmaloney/rdl-mcp)
server pioneered the MCP-over-RDL pattern but is scoped to SSRS: column
metadata, basic parameter management, stored-procedure swap. Power BI
paginated reports use the same RDL 2016 schema as SSRS, but:

1. Data sources are **Power BI XMLA endpoints**, not SQL Server.
2. Queries are **DAX**, and the upstream tool exposes no body-edit (only
   stored-procedure name swap, useless here).
3. Report Builder is **picky about XML round-tripping** — formatting drift,
   namespace prefix loss, or unrecognised `MustUnderstand` attributes cause
   silent corruption or "this report needs to be upgraded" prompts.

`pbirb-mcp` is built around lxml so a no-op edit produces a byte-identical
file, addresses every element by stable name (never index), and treats
"opens cleanly in Report Builder" as the actual integration test.

---

<!-- Ownership marker read by registry.modelcontextprotocol.io to verify this
     PyPI package maps to the io.github.mafaq229/pbirb-mcp registry entry. -->

```
mcp-name: io.github.mafaq229/pbirb-mcp
```

TDQS

B3.4/5.0

Scored across 143 tools

Disambiguation5/5

Every tool has a clearly distinct purpose with detailed descriptions, ranging from adding, removing, setting, getting, listing, and updating various report elements. There is no ambiguity; each tool targets a specific report component or operation.

Naming Consistency5/5

All tool names follow a consistent verb_noun pattern in snake_case (e.g., add_body_image, set_textbox_value, list_data_sources). No mixing of conventions or styles.

Tool Count1/5

143 tools is an extreme mismatch for typical MCP servers, even considering the complex domain of RDL report editing. The count far exceeds the '25+' threshold for 'too many', making it difficult for agents to navigate and select appropriately.

Completeness5/5

The tool set covers the full lifecycle of RDL report creation and manipulation: CRUD for all major elements (data sources, datasets, parameters, tablixes, charts, images, etc.), plus validation, linting, backup, and editing transactions. No obvious gaps.

Maintenance

ActivityNo data
ResponsivenessOutdated data