Skip to content

Repository files navigation

PnP PowerShell MCP Server

πŸ’‘ Description

This MCP server allows the use of natural language to run PnP PowerShell commands and to author complex PnP PowerShell scripts. It may handle complex prompts that are executed as a chain of PnP PowerShell cmdlets that try to fulfill the user's request, and it can search the community's PnP Script Samples library for ready-to-adapt scripts. This way you can manage many different areas of Microsoft 365 β€” SharePoint Online, Microsoft Teams, Entra ID, OneDrive, Planner, Power Platform, Microsoft 365 Groups, taxonomy, search, and tenant administration β€” straight from your MCP client, and use it as a jump-start for writing your own automation scripts.

πŸ“¦ Prerequisites

  • .NET 10 SDK (only required to build/run from source β€” published tool releases are self-contained)

  • PowerShell 7.4 or above (pwsh) installed and available on PATH

  • The PnP.PowerShell module installed:

    Install-Module -Name PnP.PowerShell -Scope CurrentUser -Force

πŸš€ Installation & Usage

This MCP server shells out to the locally installed PnP PowerShell module β€” it does not do any authentication for you. Authenticate first using Connect-PnPOnline (see Best Practices for the recommended auth methods), then the MCP server will reuse the same PnP PowerShell connection context.

  • TYPE: Local (stdio)
  • INSTALL: Install PnP PowerShell MCP in VS Code Install PnP PowerShell MCP in VS Code Insiders Install PnP PowerShell MCP in Visual Studio Install PnP PowerShell MCP in Cursor Install PnP PowerShell MCP in Claude Code

The one-click buttons above register the server under the name pnp-powershell and point it at the pnp-powershell-mcp-server command, so install the tool first (below) β€” otherwise the client will register a server it cannot start.

Install as a .NET global tool

dotnet tool install --global PnP.PowerShell.MCPServer --prerelease

This installs a self-contained, native AOT executable named pnp-powershell-mcp-server on your PATH. Supported platforms: Windows (x64, arm64), macOS (arm64, x64) and Linux (x64, arm64, musl x64).

To update an existing install:

dotnet tool update --global PnP.PowerShell.MCPServer --prerelease

Hitting Version <x> of package PnP.PowerShell.MCPServer.<rid> is not found in NuGet feeds? This tool ships as a small wrapper package plus one package per platform, and that error means the platform package for your machine was never published for that version. It affects 0.1.1-beta and earlier β€” install 0.1.3-beta or later, or build and run from source. Maintainers: see RELEASING.md.

Add to VS Code

  1. Open the Command Palette (Ctrl+Shift+P or Cmd+Shift+P on macOS) and type MCP: Add Server.

  2. Select Command (stdio) as the server type.

  3. Enter the command to run the MCP server:

    pnp-powershell-mcp-server
    
  4. Name the server (e.g., PnP PowerShell MCP Server).

As a result, you should have the following configuration in your .vscode/mcp.json file:

{
    "servers": {
        "PnP PowerShell MCP Server": {
            "type": "stdio",
            "command": "pnp-powershell-mcp-server"
        }
    }
}

Now when you open the GitHub Copilot chat in VS Code, you should be able to select the PnP PowerShell MCP Server from the list of available MCP servers and start using it to manage Microsoft 365 using natural language. In the prompt specify that "Using PnP PowerShell, I want you to..." and GitHub Copilot Agent will use the MCP server to execute your request.

Add to GitHub Copilot CLI

If you are using GitHub Copilot CLI, you may add the PnP PowerShell MCP server to Copilot by doing the following:

  1. Start the Copilot CLI:

    copilot
  2. Use the copilot mcp command to add the MCP server:

    /mcp add
    
  3. Fill in the MCP form:

    • Server name: whatever you like, without spaces, e.g. pnp-powershell-mcp-server
    • Server type: Local
    • Command: pnp-powershell-mcp-server
    • Arguments: leave empty

After that click Ctrl+S to save and q to exit the MCP form. You can now use the PnP PowerShell MCP server in GitHub Copilot CLI, e.g. "Using PnP PowerShell, I want you to...".

Add to Claude Code

claude mcp add pnp-powershell --scope user -- pnp-powershell-mcp-server

--scope user makes the server available in every project; drop it to register it for the current project only. Check it was picked up with claude mcp list.

Add to Claude Desktop

  1. In Claude Desktop, open Settings by clicking on the hamburger icon in the top left corner.

  2. Select File > Settings (or press Ctrl + ,).

  3. In the Developer tab, click Edit Config. Note: If you don't see the Developer tab, enable it first from Help > Enable Developer Mode.

  4. This opens explorer; edit claude_desktop_config.json in your favorite text editor and add:

    {
      "mcpServers": {
        "PnP-PowerShell": {
          "command": "pnp-powershell-mcp-server"
        }
      }
    }
  5. Restart Claude Desktop for the changes to take effect.

Note: On Windows, Claude doesn't exit when you close the window β€” it keeps running in the background. Find it in the system tray, right-click and select Quit to exit completely.

Add to Cursor

  1. From the chat option pick the Agent settings option.

  2. Go to Tools & MCP tab and click on New MCP server.

  3. Modify the mcp.json configuration as follows:

    {
      "mcpServers": {
        "PnP PowerShell MCP Server": {
          "type": "stdio",
          "command": "pnp-powershell-mcp-server"
        }
      }
    }
  4. Save and enable the PnP PowerShell MCP Server in the Tools & MCP tab and wait for the tools to load.

πŸ“· Use Cases

The below use cases are only a few examples of how you may use this MCP server. It is capable of handling many different tasks, so feel free to experiment and manage Microsoft 365 using natural language.

Manage SharePoint Online

prompt:

Add a new list to this site with title 'awesome ducks'. Then add new columns to that list including them in the default view. The first should be a text description column and the second one should be a user column. Then add 3 items to this list with some funny jokes about ducks added in the description column and my user in the user column.

Manage Microsoft Teams

prompt:

Create a new Team on Teams with name 'Awesome Ducks' and in the General channel add a welcome post.

Bootstrap a script from a community sample

prompt:

I need a PnP PowerShell script that exports all SharePoint list items to a CSV file β€” find a community sample and adapt it for the 'Documents' list on my site.

Report on tenant state

prompt:

Can you check if I have a Power Automate flow called 'HoursReportingReminder' and if so disable it?

πŸ› οΈ Tools

Tool Description
pnp_search_commands Searches PnP PowerShell commands using keyword matching against command names, verbs, and nouns. Use this tool first to find relevant commands. Each result carries the cmdlet's HelpUri, a link to its published documentation.
pnp_get_command_docs Gets detailed documentation for a specific PnP PowerShell command including syntax, parameters, and examples, plus a link to the online documentation.
pnp_run_command Executes one or more PnP PowerShell commands and returns the result. Runs in a persistent session, so a Connect-PnPOnline connection is reused across calls. Destructive commands require confirmation first.
pnp_get_connection_status Checks the current PnP PowerShell connection status before running commands.
pnp_reset_session Ends a session and its PnP connection. Use it to sign out, switch accounts, or recover a session that has stopped responding.
pnp_get_best_practices Returns best practices for using PnP PowerShell via this MCP server. Takes an optional section (workflow, docs, sessions, config, readonly, destructive, auth, execution, patterns) to retrieve one topic instead of the whole guide, which keeps the response small.
pnp_search_script_samples Searches the community PnP Script Samples index for scripts matching a keyword or use case.
pnp_get_script_sample Retrieves the full PnP PowerShell script code for a specific script sample by name, fetched live from GitHub.
pnp_suggest_script Finds the most relevant community script samples for a task and returns their full script code plus adaptation guidance, in one call.

Sessions and sessionId

Commands run in a persistent pwsh session, so a connection made with Connect-PnPOnline stays alive across tool calls β€” you connect once rather than on every command.

You normally never set sessionId. Leave it out and everything shares the session named default. It exists for one situation: working against two tenants (or two accounts) at the same time, because a single PnP session can only hold one connection.

Without sessionId With sessionId
Session used default the name you pass
Connection one, shared one per session name
Variables ($sites, ...) shared isolated per session

Three tools accept it: pnp_run_command, pnp_get_connection_status and pnp_reset_session. The metadata tools (pnp_search_commands, pnp_get_command_docs) always use default, since looking up a cmdlet does not depend on which tenant you are connected to.

When to use it

You are asking the agent for something in natural language, so you set this by saying it rather than by editing config. Two tenants in one conversation:

Connect to contoso in a session called "contoso" and to fabrikam in a session called "fabrikam",
then list the site count in each and tell me which is larger.

The agent then makes calls equivalent to:

// tool: pnp_run_command
{ "sessionId": "contoso",  "command": "Connect-PnPOnline -Url https://contoso.sharepoint.com  -Interactive" }
{ "sessionId": "fabrikam", "command": "Connect-PnPOnline -Url https://fabrikam.sharepoint.com -Interactive" }
{ "sessionId": "contoso",  "command": "(Get-PnPTenantSite).Count" }
{ "sessionId": "fabrikam", "command": "(Get-PnPTenantSite).Count" }

For everything else β€” including multi-step work against a single tenant β€” omit it:

Connect to contoso, find all site collections with no owner, and export them to a CSV.

Things worth knowing

  • Sign out or switch account with pnp_reset_session. It ends that session and discards its connection and variables; the next call starts fresh.
  • Idle sessions end after 30 minutes. A session busy running a command is never reclaimed, however long it takes β€” just reconnect if one does expire.
  • One command at a time per session. A second call against a busy session waits, then reports the session is busy. To genuinely run two things at once, use two different sessionId values.
  • Reuse the connection. Do not re-run Connect-PnPOnline before every command; check pnp_get_connection_status first. It reports which session it inspected.

Configuration

Environment variable Default Description
PNP_MCP_COMMAND_TIMEOUT_SECONDS 600 Wall-clock limit for a single pnp_run_command call. On timeout the session is terminated and the connection is lost.
PNP_MCP_CONFIRM_DESTRUCTIVE true Set to false to run destructive commands (Remove-*, Clear-*, ...) without asking for confirmation.
PNP_MCP_READONLY false Set to true to refuse any command that would change Microsoft 365. Allowed verbs: Get-, Export-, Test-, Convert-/ConvertTo-/ConvertFrom-, Read-, Measure-, Connect-/Disconnect-, Find-, Format-, Resolve-, Write-, Search-, Show-, Compare-, plus pipeline shaping (Select-, Where-, Sort-, Group-, ForEach-, Out-, Join-, Split-). Refused: Set-, Remove-, Add-, New-, Clear-, Invoke-, Update-, Move-, Enable-/Disable-, Grant-/Revoke-, Copy-, Import-, Restore-, Reset-, Rename-, Start-/Stop-, Register-/Unregister-, and every other change verb β€” along with indirectly invoked commands, native executables, and state-changing method calls such as ExecuteQuery. See Best Practices for the full table. Local file output (Out-File, Export-*) is still permitted.
PNP_MCP_MAX_OUTPUT_CHARS 50000 Largest tool response returned, in characters. Longer output is truncated to its first whole lines with a note saying how much was dropped. Values below 2000 are ignored, since the note itself would leave no room for output.
PNP_SCRIPT_SAMPLES_PATH (unset) Path to a local clone of the PnP script samples repository, used as a fallback when GitHub is unreachable.

The client passes the environment in when it launches the server process, so where you set them decides both who they apply to and that a server restart is needed for a change to take effect.

Where to set them

In your MCP client config β€” the usual choice. This is the only place that applies to the server no matter how the client was launched, and it survives a reboot.

VS Code β€” .vscode/mcp.json (or the user-level mcp.json)
{
    "servers": {
        "PnP PowerShell MCP Server": {
            "type": "stdio",
            "command": "pnp-powershell-mcp-server",
            "env": {
                "PNP_MCP_READONLY": "true",
                "PNP_MCP_COMMAND_TIMEOUT_SECONDS": "1800"
            }
        }
    }
}
Claude Desktop β€” claude_desktop_config.json
{
  "mcpServers": {
    "PnP-PowerShell": {
      "command": "pnp-powershell-mcp-server",
      "env": {
        "PNP_MCP_READONLY": "true"
      }
    }
  }
}
Cursor β€” mcp.json
{
  "mcpServers": {
    "PnP PowerShell MCP Server": {
      "type": "stdio",
      "command": "pnp-powershell-mcp-server",
      "env": {
        "PNP_MCP_READONLY": "true"
      }
    }
  }
}
Claude Code β€” claude mcp add
claude mcp add pnp-powershell --scope user \
  --env PNP_MCP_READONLY=true \
  --env PNP_MCP_COMMAND_TIMEOUT_SECONDS=1800 \
  -- pnp-powershell-mcp-server

In your shell, when you want a one-off run β€” for example to try read-only mode without editing config. The client must be started from that shell for it to inherit the value:

# macOS / Linux
PNP_MCP_READONLY=true code .
# Windows PowerShell
$env:PNP_MCP_READONLY = 'true'; code .

Machine-wide, if every tool on the box should behave the same way. Note this affects other processes too, so prefer the client config unless that is what you want:

# Windows, persists across reboots
[Environment]::SetEnvironmentVariable('PNP_MCP_READONLY', 'true', 'User')

Worked examples

Goal Setting
Let an agent explore a production tenant without being able to change it PNP_MCP_READONLY=true
Tenant-wide reports that take longer than 10 minutes PNP_MCP_COMMAND_TIMEOUT_SECONDS=3600
Unattended automation where the commands are already reviewed PNP_MCP_CONFIRM_DESTRUCTIVE=false
Work offline against a local clone of the script samples PNP_SCRIPT_SAMPLES_PATH=C:\src\script-samples

After changing any of these, restart the MCP server (in most clients, reload the window or toggle the server off and on) β€” the client passes the environment in when it launches the process, so an already-running server keeps the old values.

Two cautions: PNP_MCP_CONFIRM_DESTRUCTIVE=false removes the only prompt standing between an agent and Remove-PnPTenantSite, so set it only where the commands are reviewed some other way. And both booleans are matched exactly β€” PNP_MCP_READONLY enables only on the literal string true (case-insensitive), and PNP_MCP_CONFIRM_DESTRUCTIVE disables only on false; anything else, 1 and yes included, leaves the default in place.

Clients that support the MCP Tasks extension can run pnp_run_command as a task and poll for the result, rather than holding the request open for the duration of a long tenant operation.

πŸ—οΈ How to build and run it locally

Before anything, restore and build the project:

dotnet build

Running MCP in VS Code from local build

Start the MCP server from source so it may be used by GitHub Copilot Agent. In VS Code GitHub Copilot Agent mode, click the tools icon, select Add more tools β†’ Add MCP server β†’ Command (stdio), and enter:

dotnet run --project FULL_PATH_TO_YOUR_PROJECT/PnPPowerShell.MCPServer.csproj

Name it however you like. It's recommended to add it to workspace scope for testing. This repo's .mcp.json already contains an equivalent configuration you can adapt.

If you need to point the script-sample tools at a local clone of pnp/script-samples instead of the auto-discovered VS Code extension index, set the PNP_SCRIPT_SAMPLES_PATH environment variable to the clone's root folder.

Running MCP from local build using the inspector (Debugging)

One of the ways to test the MCP server is by using the MCP Inspector:

npx @modelcontextprotocol/inspector dotnet run --project ./PnPPowerShell.MCPServer.csproj

Wait for the inspector to start and open it in your browser. You should see the MCP server running, and you can query and execute its tools locally.

Publishing a native AOT build

dotnet publish -c Release -r win-x64 --self-contained

Replace win-x64 with your target RuntimeIdentifier (linux-x64, osx-arm64, etc.). The output is a single native executable with no .NET runtime dependency.

Native AOT needs a platform toolchain: the "Desktop development with C++" workload on Windows, Xcode command line tools on macOS, or clang and zlib1g-dev on Linux.

Releasing to NuGet

A release is eight packages β€” a small wrapper plus one per platform β€” and a plain dotnet pack builds only the wrapper. Do not publish by hand; see RELEASING.md and use the Release workflow.

Contributing to PnP PowerShell MCP Server

Follow the getting started contributing guidelines to help out. Sharing is caring!

Supportability and SLA

This library is open-source and community provided library with active community providing support for it. This is not Microsoft provided module so there's no SLA or direct support for this open-source component from Microsoft. For more information about the PnP initiative, check out the official website: Microsoft 365 & Power Platform Community.

πŸ”— Resources

About

MCP server for PnP PowerShell

Resources

Contributing

Stars

4 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages