@microsoft/fabric-mcp-linux-x64 0.0.0-beta.1 → 0.0.0-beta.10

package/README.md

@@ -1,179 +1,209 @@
 # <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
 
 
-
-A local, AI-friendly Model Context Protocol (MCP) server that packages Microsoft Fabric's OpenAPI specifications, schema definitions, examples, and curated guidance into a single context layer for AI agents and developer tools.
-
-Why this project?
-- Provide a reliable, local-first source of Fabric API context for AI assistants and code generation tools.
-- Reduce the risk of leaking production credentials while enabling rich, example-driven development.
-- Make Fabric API discovery, schema lookup, and best-practice retrieval reproducible and scriptable.
-
----
-
+A local-first Model Context Protocol (MCP) server that provides AI agents with comprehensive access to Microsoft Fabric's public APIs, item definitions, and best practices. The Fabric MCP Server packages complete OpenAPI specifications into a single context layer for AI-assisted development—without connecting to live Fabric environments.
 ## Table of Contents
-- [What Can You Do?](#what-can-you-do)
-- [Getting Started](#getting-started)
-- [Available Tools](#available-tools)
-- [Development and Contributing](#development-and-contributing)
-- [Support](#support)
+- [Overview](#overview)
+- [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)
+    - [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)
 - [License](#license)
 
----
+# Overview
+
+**Microsoft Fabric MCP Server** gives your AI agents the knowledge they need to generate robust, production-ready code for Microsoft Fabric—all without directly accessing your environment.
+
+Key capabilities:
+- **Complete API Context**: Full OpenAPI specifications for all supported Fabric workloads
+- **Item Definition Knowledge**: JSON schemas for every Fabric item type (Lakehouses, pipelines, semantic models, notebooks, etc.)
+- **Built-in Best Practices**: Embedded guidance on pagination, error handling, and recommended patterns
+- **Local-First Security**: Runs entirely on your machine—never connects to your Fabric environment
+
+# Installation
+- To use Fabric MCP server from node one must have Node.js (LTS) installed and available on your system PATH — this provides both `npm` and `npx`. We recommend Node.js 20 LTS or later. To verify your installation run: `node --version`, `npm --version`, and `npx --version`.
+-  Configure the `mcp.json` file with the following:
+
+    ```json
+    {
+        "mcpServers": {
+            "fabric-mcp-server": {
+            "command": "npx",
+            "args": [
+                "-y",
+                "@microsoft/fabric-mcp@latest",
+                "server",
+                "start",
+                "--mode",
+                "all"
+                ]
+            }
+        }
+    }
+    ```
+**Note:** When manually configuring Visual Studio and Visual Studio Code, use `servers` instead of `mcpServers` as the root object.
+
+**Client-Specific Configuration**
+| IDE | File Location | Documentation Link |
+|-----|---------------|-------------------|
+| **Claude Code** | `~/.claude.json` or `.mcp.json` (project) | [Claude Code MCP Configuration](https://scottspence.com/posts/configuring-mcp-tools-in-claude-code) |
+| **Claude Desktop** | `~/.claude/claude_desktop_config.json` (macOS)<br>`%APPDATA%\Claude\claude_desktop_config.json` (Windows) | [Claude Desktop MCP Setup](https://support.claude.com/en/articles/10949351-getting-started-with-local-mcp-servers-on-claude-desktop) |
+| **Cursor** | `~/.cursor/mcp.json` or `.cursor/mcp.json` | [Cursor MCP Documentation](https://docs.cursor.com/context/model-context-protocol) |
+| **VS Code** | `.vscode/mcp.json` (workspace)<br>`settings.json` (user) | [VS Code MCP Documentation](https://code.visualstudio.com/docs/copilot/chat/mcp-servers) |
+| **Windsurf** | `~/.codeium/windsurf/mcp_config.json` | [Windsurf Cascade MCP Integration](https://docs.windsurf.com/windsurf/cascade/mcp) |
+
+# Usage
+
+## Getting Started
+
+1. Open GitHub Copilot in [VS Code](https://code.visualstudio.com/docs/copilot/chat/chat-agent-mode) and switch to Agent mode.
+1. Click `refresh` on the tools list
+    - You should see the Fabric MCP Server in the list of tools
+1. Try a prompt that uses Fabric context, such as `What Fabric workload types are available?`
+    - The agent should be able to use the Fabric MCP Server tools to complete your query
+1. Check out the [Microsoft Fabric documentation](https://learn.microsoft.com/fabric/) and review the [troubleshooting guide](https://github.com/microsoft/mcp/blob/main/servers/Fabric.Mcp.Server/TROUBLESHOOTING.md) for commonly asked questions
+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)
 
-# What Can You Do?
+## What can you do with the Fabric MCP Server?
 
-The Fabric MCP Server unlocks practical developer workflows by providing local access to Fabric API context:
+The Fabric MCP Server supercharges your agents with Microsoft Fabric context. Here are some prompts you can try:
 
-- Generate or scaffold Fabric resource definitions (Lakehouse, data pipelines, notebooks, reports).
-- Retrieve official OpenAPI specs and JSON schema for validation and code generation.
-- Get example request/response payloads to accelerate integration.
-- Query curated best-practice guidance (pagination, LROs, authentication patterns).
+### Fabric Workloads & APIs
 
-<details>
-<summary>Example prompts</summary>
+* "What are the available Fabric workload types I can work with?"
+* "Show me the OpenAPI operations for 'notebook' and give a sample creation body"
+* "Get the platform-level API specifications for Microsoft Fabric"
+* "List all supported Fabric item types"
 
-- "Create a Lakehouse resource definition with a schema that enforces a string column and a datetime column."  
-- "Show me the OpenAPI operations for 'notebook' and give a sample creation body."  
-- "List recommended retry/backoff behavior for Fabric APIs when rate-limited."
-- "What are the available Fabric workload types I can work with?"
-- "Generate a data pipeline configuration with sample data sources."
-- "Show me best practices for authenticating with Fabric APIs."
+### Resource Definitions & Schemas
 
-</details>
+* "Create a Lakehouse resource definition with a schema that enforces a string column and a datetime column"
+* "Show me the JSON schema for a Data Pipeline item definition"
+* "Generate a Semantic Model configuration with sample measures"
+* "What properties are required for creating a KQL Database?"
 
----
+### Best Practices & Examples
 
-# Getting Started
+* "Show me best practices for handling API throttling in Fabric"
+* "How should I implement retry logic for Fabric API rate limits?"
+* "List recommended retry/backoff behavior for Fabric APIs when rate-limited"
+* "Show me best practices for authenticating with Fabric APIs"
+* "Get example request/response payloads for creating a Notebook"
+* "What are the pagination patterns for Fabric REST APIs?"
 
-## Prerequisites
-- .NET 9.x SDK is recommended. Check `global.json` at the repository root for any pinned SDK version.
-  - If `global.json` pins a preview SDK not installed locally, either install the requested preview SDK or update `global.json` for local development.
-- An MCP-compatible client (VS Code with an MCP extension, Claude Desktop, etc.).
+### Development Workflows
 
-## Installation Steps
+* "Generate a data pipeline configuration with sample data sources"
+* "Help me scaffold a Fabric workspace with Lakehouse and notebooks"
+* "Show me how to handle long-running operations in Fabric APIs"
+* "What's the recommended error handling pattern for Fabric API calls?"
 
-1. **Clone the repository:**
-   ```bash
-   git clone https://github.com/microsoft/mcp.git
-   cd mcp
-   ```
+## Available Tools
 
-2. **Build the project:**
-   ```bash
-   dotnet build servers/Fabric.Mcp.Server/src/Fabric.Mcp.Server.csproj --configuration Release
-   ```
+The Fabric MCP Server exposes tools organized into three categories:
 
-3. **Locate your executable:**
-   The executable `fabmcp` will be created at:
-   ```
-   servers/Fabric.Mcp.Server/src/bin/Release/fabmcp
-   ```
+### API Documentation & Best Practices
 
-   > **Platform Notes:**
-   > - **macOS/Linux**: Use the path as-is: `/path/to/repo/servers/Fabric.Mcp.Server/src/bin/Release/fabmcp`
-   > - **Windows**: Use backslashes and may need `.exe` extension: `C:\path\to\repo\servers\Fabric.Mcp.Server\src\bin\Release\fabmcp`
-   > - For published builds, executables will be in platform-specific subdirectories with `.exe` extension on Windows
+| 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. |
 
-4. **Configure your MCP client:**
+### OneLake Data Operations
+
+| 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. |
 
-   Example configuration for VS Code (.vscode/mcp.json):
-   ```json
-   {
-     "servers": {
-       "Microsoft Fabric MCP": {
-         "command": "/path/to/executable",
-         "args": ["server", "start", "--mode", "all"]
-       }
-     }
-   }
-   ```
+### Core Fabric Operations
 
-   > **Notes:** 
-   > - Replace `/path/to/executable` with the actual path from step 3
-   > - The `--mode all` argument enables all available tools
+| 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.
 
-## Common Issues
-- **SDK mismatch:** If `dotnet` outputs an SDK resolution error, inspect `global.json` and align local SDKs or update the file.
-- **Path issues:** Always use absolute paths in MCP configuration to avoid path resolution problems.
+# Support and Reference
 
-<!-- insert-section: vsix {{## Installation
+## Documentation
 
-The Fabric MCP Server extension is already installed! Simply start the server to begin using it.
+- See the [Microsoft Fabric documentation](https://learn.microsoft.com/fabric/) to learn about the Microsoft Fabric platform.
+- For MCP server-specific troubleshooting, see the [Troubleshooting Guide](https://github.com/microsoft/mcp/blob/main/servers/Fabric.Mcp.Server/TROUBLESHOOTING.md).
 
-### Starting the Server
+## Feedback and Support
 
-1. Open the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`)
-2. Run **MCP: List Servers**
-3. Find **Fabric MCP Server** in the list and click the **Start** button
+- The Microsoft Fabric MCP Server is an **open-source project in Public Preview**. Support for this server implementation is primarily provided through community channels and GitHub repositories. Customers with qualifying Microsoft enterprise support agreements may have access to limited support for broader Microsoft Fabric and platform scenarios; review the [Microsoft Support Policy](https://github.com/microsoft/mcp/blob/main/servers/Fabric.Mcp.Server/SUPPORT.md#microsoft-support-policy) section of this project for more details.
+- Check the [Troubleshooting guide](https://github.com/microsoft/mcp/blob/main/servers/Fabric.Mcp.Server/TROUBLESHOOTING.md) to diagnose and resolve common issues.
+- 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!
 
-Once started, the Fabric MCP tools will be available in GitHub Copilot Chat.
+## Security
 
-### Configuration (Optional)
+The Fabric MCP Server is a **local-first** tool that runs entirely on your machine. It provides API specifications, schemas, and best practices without connecting to live Microsoft Fabric environments.
 
-You can customize the server behavior in VS Code settings (search for "Fabric MCP"):
+MCP as a phenomenon is very novel and cutting-edge. As with all new technology standards, consider doing a security review to ensure any systems that integrate with MCP servers follow all regulations and standards your system is expected to adhere to.
 
-- **Server Mode**: Control how tools are exposed (`all` by default)
-- **Server Arguments**: Add custom arguments to the server startup
+## Data Collection
 
-Changes require restarting the MCP server from the **MCP: List Servers** view.
-}} -->
+The software may collect information about you and your use of the software and send it to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may turn off the telemetry as described in the repository. There are also some features in the software that may enable you and Microsoft to collect data from users of your applications. If you use these features, you must comply with applicable law, including providing appropriate notices to users of your applications together with a copy of Microsoft's [privacy statement](https://www.microsoft.com/privacy/privacystatement). You can learn more about data collection and use in the help documentation and our privacy statement. Your use of the software operates as your consent to these practices.
 
----
+## Contributing
 
-# Available Tools
-Use the server's CLI to query embedded data and examples. Commands are organized under a `publicapis` command group in code.
+We welcome contributions to the Fabric MCP Server! Whether you're fixing bugs, adding new features, or improving documentation, your contributions are welcome.
 
-| Command | Purpose | Implementation |
-|---|---|---|
-| `publicapis list` | List supported workload names (e.g. notebook, report) | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/PublicApis/ListWorkloadsCommand.cs |
-| `publicapis get --workload-type <workload>` | Fetch OpenAPI & examples for a workload | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/PublicApis/GetWorkloadApisCommand.cs |
-| `publicapis platform get` | Retrieve platform-level API specs | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/PublicApis/GetPlatformApisCommand.cs |
-| `publicapis bestpractices get --workload-type <workload>` | Retrieve best-practice guidance for a workload | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/BestPractices/GetBestPracticesCommand.cs |
-| `publicapis examples get --workload-type <workload>` | Retrieve example request/response files for a workload | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/BestPractices/GetExamplesCommand.cs |
-| `publicapis itemdefinition get --workload-type <workload>` | Get JSON schema definitions for a workload | tools/Fabric.Mcp.Tools.PublicApi/src/Commands/BestPractices/GetWorkloadDefinitionCommand.cs |
+Please read our [Contributing Guide](https://github.com/microsoft/mcp/blob/main/CONTRIBUTING.md) for guidelines on:
 
-> Always verify the available commands in your build via `--help` before scripting against them; command names and availability are code-driven and may change between releases.
-
----
+* Setting up your development environment
+* Adding new commands
+* Code style and testing requirements
+* Making pull requests
 
-# Development and Contributing
-
-We welcome contributions. Please follow the repository's contribution guidelines and the checklist below when preparing a PR.
-
-**Contributor checklist**
-- Create a focused branch for your changes.
-- Run a local build and unit tests for affected projects.
-- Update `CHANGELOG.md` for user-visible changes.
-- Run `eng` validation scripts where applicable (spelling, linters).
-- Provide a clear PR description and link relevant issues.
-
-See [CONTRIBUTING](https://github.com/microsoft/mcp/blob/main/CONTRIBUTING.md) for full guidance.
-
-<!-- insert-section: vsix {{Interested in contributing to the Fabric MCP Server? Visit the [GitHub repository](https://github.com/microsoft/mcp) to get started.
-
-See [CONTRIBUTING](https://github.com/microsoft/mcp/blob/main/CONTRIBUTING.md) for full contribution guidelines.
-}} -->
-
----
-
-# Support
-If you encounter issues:
-1. Search existing issues.
-2. If none match, file a new issue with:
-   - OS and `.NET` SDK version (`dotnet --info`).
-   - The command used to start the server.
-   - Server logs and MCP client config (redact secrets).
-   - Steps to reproduce.
-<!-- insert-section: vsix {{   - Your OS and VS Code version
-   - Server logs from the **MCP: List Servers** view
-   - Steps to reproduce the issue
-}} -->
-
-For troubleshooting steps, see [TROUBLESHOOTING](https://github.com/microsoft/mcp/blob/main/servers/Fabric.Mcp.Server/TROUBLESHOOTING.md).
+## Code of Conduct
+This project has adopted the
+[Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information, see the
+[Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+or contact [open@microsoft.com](mailto:open@microsoft.com)
+with any additional questions or comments.
 
 ---
 
 # License
+
 This project is licensed under the MIT License — see the [LICENSE](https://github.com/microsoft/mcp/blob/main/LICENSE) file for details.

package/dist/appsettings.json

@@ -0,0 +1,5 @@
+{
+    "RootCommandGroupName": "fabmcp",
+    "Name": "Fabric.Mcp.Server",
+    "DisplayName": "Fabric MCP Server"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/fabric-mcp-linux-x64",
-  "version": "0.0.0-beta.1",
+  "version": "0.0.0-beta.10",
   "description": "Microsoft Fabric MCP Server - Model Context Protocol implementation for Fabric, for linux on x64",
   "author": "Microsoft",
   "homepage": "https://github.com/Microsoft/mcp/blob/main/servers/Fabric.Mcp.Server#readme",
@@ -29,5 +29,6 @@
   ],
   "cpu": [
     "x64"
-  ]
+  ],
+  "mcpName": "com.microsoft/microsoft-fabric"
 }