Metadata-Version: 2.4
Name: powerbi-analyst-mcp
Version: 0.1.0
Summary: Read-only MCP server for Power BI semantic models — query workspaces, datasets, and execute DAX via any MCP client
Project-URL: Repository, https://github.com/mbrummerstedt/powerbi-analyst-mcp
Project-URL: Issues, https://github.com/mbrummerstedt/powerbi-analyst-mcp/issues
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Keywords: claude,dax,llm,mcp,power-bi,powerbi
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27.0
Requires-Dist: mcp[cli]>=1.0.0
Requires-Dist: msal-extensions>=1.2.0
Requires-Dist: msal>=1.28.0
Requires-Dist: pydantic-settings>=2.0.0
Requires-Dist: python-dotenv>=1.0.0
Provides-Extra: dev
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Description-Content-Type: text/markdown

# Power BI Analyst MCP

[![PyPI](https://img.shields.io/pypi/v/powerbi-analyst-mcp)](https://pypi.org/project/powerbi-analyst-mcp/)
[![Python](https://img.shields.io/pypi/pyversions/powerbi-analyst-mcp)](https://pypi.org/project/powerbi-analyst-mcp/)
[![Tests](https://img.shields.io/github/actions/workflow/status/mbrummerstedt/powerbi-analyst-mcp/tests.yml?label=tests)](https://github.com/mbrummerstedt/powerbi-analyst-mcp/actions)
[![License: MIT](https://img.shields.io/github/license/mbrummerstedt/powerbi-analyst-mcp)](LICENSE)

**Ask Claude to analyse your Power BI data. Get answers — not context-window crashes.**

Connect Claude (or any MCP client) to your Power BI semantic models. Explore tables and measures, run DAX queries, and work with real results — even across datasets with tens of thousands of rows. Large query results are automatically saved to a local file and paged to the agent on demand, so your AI session stays fast and focused no matter how much data you pull.

Everything runs on your machine. Your data never passes through a third-party relay.

---

## What becomes possible

The analytics bottleneck has never really been data access — Power BI already gives people access. The bottleneck is translation: the skilled, time-consuming work of turning data into a decision. This server moves that translation to an LLM.

**Compound reasoning across your entire model**
A human analyst runs one query, reads the result, forms a hypothesis, runs another query. This serialises over hours. An agent can run twenty queries in sequence — each informed by the last — synthesise across all of them, and deliver a reasoned conclusion in minutes. Ask "what's driving the margin decline in EMEA?" and Claude will explore measures, drill into markets, check time trends, isolate the outlier, and explain it — without you directing each step.

**Natural language analytics for everyone**
Any stakeholder can ask a data question and get a real answer backed by live DAX — without knowing what DAX is, without filing a ticket, without waiting. The translation layer that used to require a trained analyst runs on demand.

**Proactive anomaly detection**
Run Claude on a schedule against your key measures. It queries the data, compares to prior periods, and flags anything outside expected ranges in plain English — before anyone has to open a dashboard to find out something went wrong.

**Self-documenting semantic models**
"List every measure in this dataset and explain what it calculates." Claude explores the schema and produces a data dictionary — useful for onboarding, governance, and anyone trying to understand what a model actually contains.

**Large datasets, handled automatically**
Power BI queries can return tens of thousands of rows. Returning all of that inline would consume most of an LLM's context window and crash the session. This server saves large results to a local CSV and gives the agent a compact summary — row count, column names, 5-row preview — then lets it page through the file on demand. You get the full dataset. The AI session stays lean.

**Query history that compounds over time**
Every successful DAX query is logged locally in a JSONL audit trail — what the user asked, the DAX that was generated, the columns returned, and where the CSV was saved. In the next session, the agent searches this history to find relevant prior work: reusable DAX patterns, previously computed result files, and context from earlier analyses. The more you use it, the faster and smarter it gets — and you always have an audit trail of where every number came from.

**Your data stays on your machine**
Queries, results, and tokens never pass through a cloud relay. The server runs locally, authenticates via the same OAuth device code flow as the Power BI web app, and stores tokens in your OS's native secure store (Keychain / DPAPI / LibSecret).

---

## How it compares to Microsoft's official MCP servers

Microsoft publishes two MCP servers for Power BI. This one is different in purpose and architecture from both.

|  | **This server** | [Microsoft Remote MCP](https://learn.microsoft.com/en-us/power-bi/developer/mcp/mcp-servers-overview#remote-power-bi-mcp-server) | [Microsoft Modeling MCP](https://learn.microsoft.com/en-us/power-bi/developer/mcp/mcp-servers-overview#power-bi-modeling-mcp-server) |
|---|---|---|---|
| **Purpose** | Query and analyse existing models | Query existing models | Build and modify models |
| **Runs** | Locally on your machine | Microsoft's cloud infrastructure | Locally (Power BI Desktop) |
| **Data path** | Direct to Power BI REST API | Via Microsoft's MCP relay | Local XMLA |
| **Auth** | OAuth device code (delegated) | OAuth via remote service | Local session |
| **Large results** | Auto-saved to local CSV | In-context only | N/A |
| **Read-only** | Yes | Yes | No |
| **Who it's for** | Analysts using Claude / Cursor | Analysts using Copilot | Model developers |

---

## What it looks like

```
You: Analyse revenue by market and product category for Q1 2025

Claude: Let me explore the dataset first.
        [calls list_tables → list_measures → execute_dax]

        The query returned 73,840 rows — saved to:
        ~/powerbi_output/dax_result_revenue_q1_2025_20260313_091204.csv

        [pages through results with read_query_result]

        Summary: EMEA leads at 44% of total revenue. The top category
        is Premium Hardware in both EMEA and AMER. APAC shows the
        strongest quarter-over-quarter growth at +18%...
```

The agent explores the schema, writes the DAX, handles the file, and delivers the analysis — without you touching the Power BI UI.

---

## Tools

| Tool | What it does |
|---|---|
| `authenticate` | Sign in via OAuth device code — returns a URL + one-time code; call again to complete |
| `logout` | Clear the cached token (forces re-authentication) |
| `list_workspaces` | List all workspaces you have access to |
| `list_datasets` | List datasets / semantic models in a workspace |
| `get_dataset_info` | Metadata and last 5 refresh history entries for a dataset |
| `list_tables` | All visible tables in a dataset |
| `list_measures` | Measures with name, table, description, and format string |
| `list_columns` | Columns with data type and key flag |
| `execute_dax` | Run a DAX query — inline for small results, local CSV for large ones. Pass `query_summary` to log the query for future reference. |
| `read_query_result` | Page through a large CSV result without loading it all into context |
| `search_query_history` | Search the local query log by keyword, dataset, or time range — find prior DAX and results across sessions |
| `delete_query_log_entry` | Remove a query log entry (e.g. when the approach turned out to be wrong) |

---

## User guide

### Prerequisites

- Python 3.11+
- A Power BI Pro, Premium Per User (PPU), or Premium capacity licence
- An Azure AD app registration (free, ~5 minutes — see below)

### Step 1 — Create an Azure AD app registration

OAuth 2.0 requires a **client ID** to identify which application is acting on your behalf. The registration is free, requires no client secret, and does not need Power BI admin consent for the two read-only scopes used here.

1. Go to [portal.azure.com](https://portal.azure.com) → **Azure Active Directory** → **App registrations** → **New registration**.
2. Name it (e.g. `PowerBI MCP`). For account types choose **Accounts in this organizational directory only** (single-tenant). Click **Register**.
3. Under **Authentication** → **Platform configurations**, add **Mobile and desktop applications** and tick this redirect URI:
   ```
   https://login.microsoftonline.com/common/oauth2/nativeclient
   ```
4. Still under **Authentication** → **Advanced settings**, set **Allow public client flows** to **Yes**. Save.
5. Under **API permissions** → **Add a permission** → **Power BI Service**, add:
   - `Dataset.Read.All`
   - `Workspace.Read.All`

   If your tenant requires admin consent, ask an admin to grant it.

6. From the **Overview** page, copy both of these — you will need them in Step 2:
   - **Application (client) ID**
   - **Directory (tenant) ID**

> **Note:** The Power BI tenant setting **"Dataset Execute Queries REST API"** must be enabled in the Power BI Admin Portal (Integration settings) for `execute_dax` to work.

---

### Step 2 — Install and connect

The server is published on PyPI. The fastest way to run it is with `uvx`, which requires no manual install or virtual environment.

#### Claude Desktop

Add the following to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "powerbi": {
      "command": "uvx",
      "args": ["powerbi-analyst-mcp"],
      "env": {
        "POWERBI_CLIENT_ID": "your-application-client-id",
        "POWERBI_TENANT_ID": "your-directory-tenant-id"
      }
    }
  }
}
```

The config file is at:
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\Claude\claude_desktop_config.json`

> **`POWERBI_TENANT_ID` is required for almost all users.** Most organisations have a single Azure AD tenant. Set this to your **Directory (tenant) ID** from Step 1. Leaving it as `organizations` (the default) will cause authentication to fail or target the wrong tenant.

#### Cursor

Add a `.cursor/mcp.json` file in your project (or use the global config):

```json
{
  "mcpServers": {
    "powerbi": {
      "command": "uvx",
      "args": ["powerbi-analyst-mcp"],
      "env": {
        "POWERBI_CLIENT_ID": "your-application-client-id",
        "POWERBI_TENANT_ID": "your-directory-tenant-id"
      }
    }
  }
}
```

#### pip install (alternative)

```bash
pip install powerbi-analyst-mcp
```

Then replace the `uvx` command block with:

```json
"command": "powerbi-analyst-mcp",
"args": []
```

---

### Typical analysis workflow

Once connected, ask your LLM to follow this sequence naturally:

```
1. authenticate          ← first run only; returns a URL + code to open in browser,
                           then call authenticate again to complete sign-in
2. list_workspaces       → returns workspace IDs
3. list_datasets         workspace_id=<id>   → returns dataset IDs
4. list_tables           workspace_id=<id>   dataset_id=<id>
5. list_measures         workspace_id=<id>   dataset_id=<id>   [table_name=<name>]
6. list_columns          workspace_id=<id>   dataset_id=<id>   [table_name=<name>]
7. search_query_history  [keyword="revenue"]  ← check if similar work exists from a prior session
8. execute_dax           workspace_id=<id>   dataset_id=<id>
                         dax_query="EVALUATE SUMMARIZECOLUMNS(...)"
                         [query_summary="Revenue by market and product for Q1 2025"]
                         [result_name="revenue by market q1"]  ← names the saved CSV
                         [max_rows=500]                        ← optional row cap for sampling
9. read_query_result     file_path=<savedTo>   [offset=0]   [limit=100]
                         ← page through large results without filling context
```

### DAX query examples

```dax
-- Total sales by year
EVALUATE
SUMMARIZECOLUMNS(
    'Date'[Year],
    "Total Sales", [Total Sales]
)
ORDER BY 'Date'[Year]

-- Top 10 customers by revenue
EVALUATE
TOPN(
    10,
    SUMMARIZECOLUMNS('Customer'[Name], "Revenue", [Revenue]),
    [Revenue], DESC
)

-- Filtered subset
EVALUATE
CALCULATETABLE(
    'Sales',
    'Date'[Year] = 2024
)
```

---

### Large result handling — in detail

| Result size | What happens |
|---|---|
| **≤ 50 rows** | Returned inline as JSON — zero friction |
| **> 50 rows** | Full result saved to a timestamped CSV; agent receives a compact summary |

The summary returned for large results contains:
- `rowCount` — total rows written
- `columns` — column names and types
- `preview` — first 5 rows
- `savedTo` — absolute path to the CSV file

The agent can then page through the file with `read_query_result`:

```
read_query_result(
    file_path = "/path/from/savedTo",
    offset    = 0,      # zero-based row offset
    limit     = 100     # rows per page (default 100)
)
```

Returns `rows`, `totalRows`, `offset`, `limit`, and `hasMore`. Increment `offset` by `limit` to fetch the next page.

**`execute_dax` parameters for controlling result size:**

| Parameter | Type | Description |
|---|---|---|
| `query_summary` | `str` (optional) | Short description of what the user asked for — logged to the local query history for auditability and cross-session reuse. |
| `result_name` | `str` (optional) | Short label used in the CSV filename — e.g. `"gmv by market 2024"` → `dax_result_gmv_by_market_2024_20260305_143022.csv`. Max 40 characters. |
| `max_rows` | `int` (optional) | Hard cap applied via `TOPN` at the Power BI engine level. Useful for quick sampling without rewriting the DAX. |

**Output directory** defaults to `~/powerbi_output`. Override with `POWERBI_OUTPUT_DIR` in your MCP client's `env` block. CSV files and the query history log are not automatically cleaned up — manage the directory manually or add a retention policy.

---

## Limitations

- **Read-only.** Creation, modification, and deletion of Power BI artefacts are not supported.
- `execute_dax` limits: 100,000 rows or 1,000,000 values per query (Power BI API hard cap).
- Rate limit: 120 DAX query requests per minute per user.
- `list_tables`, `list_measures`, and `list_columns` use the DAX `INFO.VIEW.*` functions, which require Import or DirectQuery models with XMLA read access enabled.
- CSV files written by `execute_dax` are not automatically cleaned up.

---

## Security

- Tokens are persisted using OS-native secure storage via [`msal-extensions`](https://github.com/AzureAD/microsoft-authentication-extensions-for-python):
  - **macOS** — Keychain
  - **Windows** — DPAPI-encrypted file
  - **Linux** — LibSecret (gnome-keyring / KWallet); falls back to an encrypted file if unavailable
- The cache file is written to `~/.powerbi_mcp_token_cache.bin` and is covered by `.gitignore`.
- The server never logs access tokens.
- All data access is gated by the user's own Power BI permissions (delegated OAuth 2.0 — no service principal, no client secret).

---

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for project structure, dev environment setup, architecture notes, and how to add new tools.
