@microsoft/fabric-mcp
Advanced tools
+9
-9
| { | ||
| "name": "@microsoft/fabric-mcp", | ||
| "version": "0.0.0-beta.9", | ||
| "version": "0.0.0-beta.10", | ||
| "description": "Microsoft Fabric MCP Server - Model Context Protocol implementation for Fabric", | ||
@@ -17,4 +17,4 @@ "author": "Microsoft", | ||
| "repository": { | ||
| "url": "https://github.com/microsoft/mcp.git", | ||
| "type": "git" | ||
| "type": "git", | ||
| "url": "https://github.com/microsoft/mcp.git" | ||
| }, | ||
@@ -37,8 +37,8 @@ "engines": { | ||
| "optionalDependencies": { | ||
| "@microsoft/fabric-mcp-darwin-arm64": "0.0.0-beta.9", | ||
| "@microsoft/fabric-mcp-darwin-x64": "0.0.0-beta.9", | ||
| "@microsoft/fabric-mcp-win32-x64": "0.0.0-beta.9", | ||
| "@microsoft/fabric-mcp-linux-x64": "0.0.0-beta.9", | ||
| "@microsoft/fabric-mcp-linux-arm64": "0.0.0-beta.9", | ||
| "@microsoft/fabric-mcp-win32-arm64": "0.0.0-beta.9" | ||
| "@microsoft/fabric-mcp-darwin-x64": "0.0.0-beta.10", | ||
| "@microsoft/fabric-mcp-linux-arm64": "0.0.0-beta.10", | ||
| "@microsoft/fabric-mcp-linux-x64": "0.0.0-beta.10", | ||
| "@microsoft/fabric-mcp-win32-x64": "0.0.0-beta.10", | ||
| "@microsoft/fabric-mcp-darwin-arm64": "0.0.0-beta.10", | ||
| "@microsoft/fabric-mcp-win32-arm64": "0.0.0-beta.10" | ||
| }, | ||
@@ -45,0 +45,0 @@ "scripts": { |
+65
-48
@@ -8,13 +8,24 @@ # <img height="36" width="36" src="https://learn.microsoft.com/fabric/media/fabric-icon.png" alt="Microsoft Fabric Logo" /> Microsoft Fabric MCP Server NPM Package | ||
| - [Installation](#installation) | ||
| - [IDE](#ide) | ||
| - [VS Code (Recommended)](#vs-code-recommended) | ||
| - [Manual Setup](#manual-setup) | ||
| - [Usage](#usage) | ||
| - [Getting Started](#getting-started) | ||
| - [What can you do with the Fabric MCP Server?](#what-can-you-do-with-the-fabric-mcp-server) | ||
| - [Available Tools](#available-tools) | ||
| - [Getting Started](#getting-started) | ||
| - [What can you do with the Fabric MCP Server?](#what-can-you-do-with-the-fabric-mcp-server) | ||
| - [Fabric Workloads & APIs](#fabric-workloads--apis) | ||
| - [Resource Definitions & Schemas](#resource-definitions--schemas) | ||
| - [Best Practices & Examples](#best-practices--examples) | ||
| - [Development Workflows](#development-workflows) | ||
| - [Available Tools](#available-tools) | ||
| - [API Documentation & Best Practices](#api-documentation--best-practices) | ||
| - [OneLake Data Operations](#onelake-data-operations) | ||
| - [Core Fabric Operations](#core-fabric-operations) | ||
| - [Support and Reference](#support-and-reference) | ||
| - [Documentation](#documentation) | ||
| - [Feedback and Support](#feedback-and-support) | ||
| - [Security](#security) | ||
| - [Data Collection](#data-collection) | ||
| - [Contributing](#contributing) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [Documentation](#documentation) | ||
| - [Feedback and Support](#feedback-and-support) | ||
| - [Security](#security) | ||
| - [Data Collection](#data-collection) | ||
| - [Contributing](#contributing) | ||
| - [Code of Conduct](#code-of-conduct) | ||
| - [License](#license) | ||
@@ -74,9 +85,9 @@ # Overview | ||
| 1. We're building this in the open. Your feedback is much appreciated! | ||
| - 👉 [Open an issue in the public repository](https://github.com/microsoft/mcp/issues/new/choose) | ||
| - [Open an issue in the public repository](https://github.com/microsoft/mcp/issues/new/choose) | ||
| ## What can you do with the Fabric MCP Server? | ||
| ✨ The Fabric MCP Server supercharges your agents with Microsoft Fabric context. Here are some prompts you can try: | ||
| The Fabric MCP Server supercharges your agents with Microsoft Fabric context. Here are some prompts you can try: | ||
| ### 📊 Fabric Workloads & APIs | ||
| ### Fabric Workloads & APIs | ||
@@ -88,3 +99,3 @@ * "What are the available Fabric workload types I can work with?" | ||
| ### 🏗️ Resource Definitions & Schemas | ||
| ### Resource Definitions & Schemas | ||
@@ -96,3 +107,3 @@ * "Create a Lakehouse resource definition with a schema that enforces a string column and a datetime column" | ||
| ### 📝 Best Practices & Examples | ||
| ### Best Practices & Examples | ||
@@ -106,3 +117,3 @@ * "Show me best practices for handling API throttling in Fabric" | ||
| ### 🔧 Development Workflows | ||
| ### Development Workflows | ||
@@ -116,36 +127,42 @@ * "Generate a data pipeline configuration with sample data sources" | ||
| The Fabric MCP Server exposes the following tools for AI agents: | ||
| The Fabric MCP Server exposes tools organized into three categories: | ||
| | Tool | Tool Name | Description | | ||
| |------|-----------|-------------| | ||
| | List Public APIs | `publicapis_list` | List all Microsoft Fabric workload types that have public API specifications available | | ||
| | Get Public API | `publicapis_get` | Retrieve the complete OpenAPI/Swagger specification for a specific Microsoft Fabric workload | | ||
| | Get Platform API | `publicapis_platform_get` | Retrieve the OpenAPI/Swagger specification for Microsoft Fabric platform APIs | | ||
| | Get Best Practices | `publicapis_bestpractices_get` | Retrieve embedded best practice documentation and guidance for a specific Microsoft Fabric topic | | ||
| | Get Best Practices Examples | `publicapis_bestpractices_examples_get` | Retrieve all example API request/response files for a specific Microsoft Fabric workload | | ||
| | Get Item Definition | `publicapis_bestpractices_itemdefinition_get` | Retrieve the JSON schema definitions for specific items within a Microsoft Fabric workload's API | | ||
| ### API Documentation & Best Practices | ||
| > Always verify available commands via `--help`. Command names and availability may change between releases. | ||
| | Tool Name | Description | | ||
| |-----------|-------------| | ||
| | `docs_workloads` | Lists Fabric workload types that have public API specifications available. | | ||
| | `docs_workload-api-spec` | Retrieves the complete OpenAPI specification for a specific Fabric workload. | | ||
| | `docs_platform-api-spec` | Retrieves the OpenAPI specification for core Fabric platform APIs. | | ||
| | `docs_item-definitions` | Retrieves JSON schema definitions for items in a Fabric workload API. | | ||
| | `docs_best-practices` | Retrieves best practice documentation and guidance for a specific topic. | | ||
| | `docs_api-examples` | Retrieves example API request/response files for a specific workload. | | ||
| ## OneLake (`onelake`) | ||
| ### OneLake Data Operations | ||
| | Command | Purpose | | ||
| |---|---| | ||
| | `onelake download file` | Download a OneLake file to disk. | | ||
| | `onelake upload file` | Upload a local file into OneLake. | | ||
| | `onelake directory create` | Create a directory via the DFS endpoint. | | ||
| | `onelake directory delete` | Delete a directory (optionally recursive). | | ||
| | `onelake file list` | List files using the hierarchical file-list endpoint. | | ||
| | `onelake file delete` | Remove individual files from OneLake storage. | | ||
| | `onelake item list` | List workspace items and high-level metadata. | | ||
| | `onelake item list-data` | List Fabric items via the DFS endpoint. | | ||
| | `onelake item create` | Provision new Fabric items (lakehouse, notebook, etc.). | | ||
| | `onelake table config get` | Retrieve table API configuration for a workspace item. | | ||
| | `onelake table namespace list` | Enumerate table namespaces (schemas) exposed through the table API. | | ||
| | `onelake table namespace get` | Inspect metadata for a specific namespace. | | ||
| | `onelake table list` | List tables published within a namespace. | | ||
| | `onelake table get` | Retrieve the definition for a specific table. | | ||
| | Tool Name | Description | | ||
| |-----------|-------------| | ||
| | `onelake_list_workspaces` | Lists available Microsoft Fabric workspaces. | | ||
| | `onelake_list_items` | Lists workspace items with high-level metadata. | | ||
| | `onelake_list_items_dfs` | Lists Fabric items via the DFS endpoint. | | ||
| | `onelake_list_files` | Lists files using the hierarchical file-list endpoint. | | ||
| | `onelake_download_file` | Downloads a OneLake file. | | ||
| | `onelake_upload_file` | Uploads a file to OneLake storage. | | ||
| | `onelake_delete_file` | Deletes a file from OneLake storage. | | ||
| | `onelake_create_directory` | Creates a directory via the DFS endpoint. | | ||
| | `onelake_delete_directory` | Deletes a directory (optionally recursive). | | ||
| | `onelake_get_table_config` | Retrieves table API configuration for a workspace item. | | ||
| | `onelake_list_table_namespaces` | Lists table namespaces (schemas) exposed through the table API. | | ||
| | `onelake_get_table_namespace` | Retrieves metadata for a specific namespace. | | ||
| | `onelake_list_tables` | Lists tables published within a namespace. | | ||
| | `onelake_get_table` | Retrieves the definition for a specific table. | | ||
| All commands accept either GUID identifiers (`--workspace-id`, `--item-id`) or friendly names (`--workspace`, `--item`), with the exception of `onelake item create`, which currently requires GUID identifiers. Friendly-name items must be provided as `<itemName>.<itemType>` (for example, `SalesLakehouse.lakehouse`). Table commands also accept the schema via `--namespace` or its alias `--schema`. Use `dotnet run -- onelake --help` (or `fabmcp onelake --help` for published builds) to inspect the complete option set before scripting. | ||
| ### Core Fabric Operations | ||
| | Tool Name | Description | | ||
| |-----------|-------------| | ||
| | `core_create-item` | Creates new Fabric items (Lakehouses, Notebooks, etc.). | | ||
| > Always verify available commands via `--help`. Command names and availability may change between releases. | ||
| # Support and Reference | ||
@@ -163,3 +180,3 @@ | ||
| - We're building this in the open. Your feedback is much appreciated! | ||
| - 👉 [Open an issue](https://github.com/microsoft/mcp/issues) in the public GitHub repository — we'd love to hear from you! | ||
| - [Open an issue](https://github.com/microsoft/mcp/issues) in the public GitHub repository — we'd love to hear from you! | ||
@@ -182,6 +199,6 @@ ## Security | ||
| * 🛠️ Setting up your development environment | ||
| * ✨ Adding new commands | ||
| * 📝 Code style and testing requirements | ||
| * 🔄 Making pull requests | ||
| * Setting up your development environment | ||
| * Adding new commands | ||
| * Code style and testing requirements | ||
| * Making pull requests | ||
@@ -188,0 +205,0 @@ ## Code of Conduct |
210
8.81%18852
-0.59%