@microsoft/fabric-mcp 0.0.0-beta.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright 2025 (c) Microsoft Corporation.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE

package/README.md

@@ -0,0 +1,179 @@
+# <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.
+
+---
+
+## 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)
+- [License](#license)
+
+---
+
+# What Can You Do?
+
+The Fabric MCP Server unlocks practical developer workflows by providing local access to Fabric API context:
+
+- 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).
+
+<details>
+<summary>Example prompts</summary>
+
+- "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."
+
+</details>
+
+---
+
+# Getting Started
+
+## 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.).
+
+## Installation Steps
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/microsoft/mcp.git
+   cd mcp
+   ```
+
+2. **Build the project:**
+   ```bash
+   dotnet build servers/Fabric.Mcp.Server/src/Fabric.Mcp.Server.csproj --configuration Release
+   ```
+
+3. **Locate your executable:**
+   The executable `fabmcp` will be created at:
+   ```
+   servers/Fabric.Mcp.Server/src/bin/Release/fabmcp
+   ```
+
+   > **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
+
+4. **Configure your MCP client:**
+
+   Example configuration for VS Code (.vscode/mcp.json):
+   ```json
+   {
+     "servers": {
+       "Microsoft Fabric MCP": {
+         "command": "/path/to/executable",
+         "args": ["server", "start", "--mode", "all"]
+       }
+     }
+   }
+   ```
+
+   > **Notes:** 
+   > - Replace `/path/to/executable` with the actual path from step 3
+   > - The `--mode all` argument enables all available tools
+
+
+## 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.
+
+<!-- insert-section: vsix {{## Installation
+
+The Fabric MCP Server extension is already installed! Simply start the server to begin using it.
+
+### Starting the Server
+
+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
+
+Once started, the Fabric MCP tools will be available in GitHub Copilot Chat.
+
+### Configuration (Optional)
+
+You can customize the server behavior in VS Code settings (search for "Fabric MCP"):
+
+- **Server Mode**: Control how tools are exposed (`all` by default)
+- **Server Arguments**: Add custom arguments to the server startup
+
+Changes require restarting the MCP server from the **MCP: List Servers** view.
+}} -->
+
+---
+
+# Available Tools
+Use the server's CLI to query embedded data and examples. Commands are organized under a `publicapis` command group in code.
+
+| 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 |
+
+> 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.
+
+---
+
+# 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).
+
+---
+
+# License
+This project is licensed under the MIT License — see the [LICENSE](https://github.com/microsoft/mcp/blob/main/LICENSE) file for details.

package/index.js

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+
+const os = require('os')
+const packageJson = require('./package.json')
+
+// Check if DEBUG environment variable is set
+const isDebugMode = process.env.DEBUG && (
+  process.env.DEBUG.toLowerCase() === 'true' ||
+  process.env.DEBUG.includes('mcp') ||
+  process.env.DEBUG === '*'
+)
+
+// Helper function for debug logging
+function debugLog(...args) {
+  if (isDebugMode) {
+    console.error(...args)
+  }
+}
+
+debugLog('\nWrapper package starting')
+debugLog('All args:')
+process.argv.forEach((val, index) => {
+  debugLog(`${index}: ${val}`)
+})
+
+const platform = os.platform()
+const arch = os.arch()
+
+const packageName = packageJson.name
+const packageVersion = packageJson.version
+const platformPackageName = `${packageName}-${platform}-${arch}`
+
+// Try to load the platform package
+let platformPackage
+try {
+  debugLog(`Attempting to require platform package: ${platformPackageName}`)
+  platformPackage = require(platformPackageName)
+} catch (err) {
+  debugLog(`Failed to require ${platformPackageName}, attempting auto-install: ${err.message}`)
+
+  // Try to automatically install the missing platform package
+  try {
+    const { execSync } = require('child_process')
+
+    console.error(`Installing missing platform package: ${platformPackageName}`)
+
+    // Try to install the platform package
+    try {
+      execSync(`npm install ${platformPackageName}@${packageVersion}`, {
+        stdio: ['inherit', 'inherit', 'pipe'], // Only pipe stderr to capture errors
+        timeout: 60000 // 60 second timeout
+      })
+    } catch (npmErr) {
+      // If npm install fails, try with --no-save and different install strategies
+      debugLog(`npm install failed, trying alternative installation methods: ${npmErr.message}`)
+
+      // Try with --no-save and --prefer-online
+      execSync(`npm install ${platformPackageName}@${packageVersion} --no-save --prefer-online`, {
+        stdio: ['inherit', 'inherit', 'pipe'],
+        timeout: 60000
+      })
+    }
+
+    // Clear module cache and try to require again after installation
+    Object.keys(require.cache).forEach(key => {
+      if (key.includes(platformPackageName)) {
+        delete require.cache[key]
+      }
+    })
+
+    platformPackage = require(platformPackageName)
+
+    console.error(`✅ Successfully installed and loaded ${platformPackageName}`)
+
+  } catch (installErr) {
+    debugLog(`Auto-install failed: ${installErr.message}`)
+
+    console.error(`\n❌ Failed to load platform specific package '${platformPackageName}'`)
+    console.error(`\n🔍 Troubleshooting steps:`)
+    console.error(`\n1. Clear npm cache:`)
+    console.error(`   npm cache clean --force`)
+    console.error(`\n2. If installing as a global tool, uninstall and reinstall:`)
+    console.error(`   npm uninstall -g ${packageName}`)
+    console.error(`   npm install -g ${packageName}`)
+    console.error(`\n3. If using npx, clear the npx cache and try again:`)
+    console.error(`   npx -y clear-npx-cache`)
+    console.error(`   npx -y ${packageName}@latest --version`)
+    console.error(`\n4. Manually install the platform package to check compatibility:`)
+    console.error(`   npm install ${platformPackageName}@latest`)
+    console.error(`\n5. Check your internet connection and try again`)
+    console.error(`\n6. If the issue persists, please report it at:`)
+    console.error(`   https://github.com/microsoft/mcp/issues`)
+    console.error(`\nOriginal error: ${err.message}`)
+    console.error(`Install error: ${installErr.message}`)
+    process.exit(1)
+  }
+}
+
+platformPackage.runExecutable(process.argv.slice(2))
+  .then((code) => {
+    debugLog(`Process exited with code: ${code}`)
+    process.exit(code)
+  })
+  .catch((err) => {
+    console.error(`Error: ${err.message}`)
+    process.exit(1)
+  })

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@microsoft/fabric-mcp",
+  "version": "0.0.0-beta.1",
+  "description": "Microsoft Fabric MCP Server - Model Context Protocol implementation for Fabric",
+  "author": "Microsoft",
+  "homepage": "https://github.com/Microsoft/mcp/blob/main/servers/Fabric.Mcp.Server#readme",
+  "license": "MIT",
+  "keywords": [
+    "fabric",
+    "mcp",
+    "model-context-protocol"
+  ],
+  "bugs": {
+    "url": "https://github.com/microsoft/mcp/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/microsoft/mcp.git"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
+  "bin": {
+    "fabmcp": "./index.js"
+  },
+  "os": [
+    "linux",
+    "darwin",
+    "win32"
+  ],
+  "cpu": [
+    "x64",
+    "arm64"
+  ],
+  "optionalDependencies": {
+    "@microsoft/fabric-mcp-darwin-x64": "0.0.0-beta.1",
+    "@microsoft/fabric-mcp-darwin-arm64": "0.0.0-beta.1",
+    "@microsoft/fabric-mcp-win32-x64": "0.0.0-beta.1",
+    "@microsoft/fabric-mcp-linux-x64": "0.0.0-beta.1",
+    "@microsoft/fabric-mcp-linux-arm64": "0.0.0-beta.1",
+    "@microsoft/fabric-mcp-win32-arm64": "0.0.0-beta.1"
+  },
+  "scripts": {
+    "postinstall": "node ./scripts/post-install-script.js"
+  }
+}

package/scripts/post-install-script.js

@@ -0,0 +1,22 @@
+const os = require('os');
+
+const platform = os.platform();
+const arch = os.arch();
+
+let baseName = '';
+try{
+    const packageJson = require('../package.json');
+    baseName = packageJson.name;
+}
+catch (err) {
+  console.error('Unable to verify platform package installation. Error reading package.json.');
+  process.exit(1);
+}
+
+const requiredPackage = `${baseName}-${platform}-${arch}`;
+try {
+  require.resolve(requiredPackage);
+} catch (err) {
+  console.error(`Missing required package: '${requiredPackage}'. Follow the troubleshooting steps - https://aka.ms/azmcp/troubleshooting#platform-package-installation-issues`);
+  process.exit(1);
+}