(DOCS) Using Windows Package Manager with Model Context Protocol (MCP) Server

hub/package-manager/winget/winget-mcp-server.md

@@ -0,0 +1,210 @@
+---
+title: Using Windows Package Manager with Model Context Protocol (MCP) Server
+description: The Windows Package Manager includes a Model Context Protocol (MCP) server that enables AI agents and tools to discover and install packages through a standardized interface, enhancing the authoring experience in supported editors like VS Code.
+ms.date: 10/30/2025
+ms.topic: overview
+---
+
+# Use the Windows Package Manager MCP Server for package management with AI agents
+
+The Windows Package Manager (WinGet) includes a built-in Model Context Protocol (MCP) server. The WinGet MCP server enables AI agents and development tools to intelligently assist you by understanding what packages are available and how to install them.
+
+The WinGet MCP server exposes WinGet's core functionality to AI agents, enabling them to help you find packages, understand their details, and assist with installation workflows. This functionality enhances the overall authoring experience by providing contextual information about available packages directly to AI-powered tools.
+
+## What is Model Context Protocol (MCP)?
+
+Model Context Protocol (MCP) is an open protocol that enables AI systems to interact with external data sources and tools in a consistent way. It provides a standardized interface for AI agents to discover capabilities, retrieve information, and invoke actions across different systems and services.
+
+MCP allows AI-powered tools to understand what operations are possible and how to perform them, without requiring custom integrations for each system. This protocol makes it easier for developers to build AI assistants that can work with multiple tools and services seamlessly.
+
+To learn more about MCP and how it works with AI agents, see [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/chat/mcp-servers).
+
+## How WinGet MCP works with AI agents
+
+To use the WinGet MCP server with AI agents, you first need to configure your development environment to connect to the MCP server. Once connected, the WinGet MCP server can assist with:
+
+- **Discovering available packages**: When you ask an agent to help with software installation tasks, the agent can search the WinGet repository for available packages. WinGet MCP helps agents provide accurate, up-to-date information about available software.For example:
+
+  - **You ask**: "I need to install Visual Studio Code"
+  - **Agent searches**: The WinGet repository for Visual Studio Code packages
+  - **Agent provides**: Package details including ID, version, publisher, and installation options
+
+- **Installing packages**: When you need to install specific software, agents can assist with the installation process, ensuring that your software is installed with the correct configuration. For example:
+
+  - **You ask**: "Install Python for development"
+  - **Agent identifies**: The appropriate Python package from the WinGet repository
+  - **Agent provides**: Installation commands or can initiate the installation with your approval
+
+## Prerequisites
+
+Before using the WinGet MCP server integration, ensure you have:
+
+- Windows 11 *(or Windows 10 version 1809, build 17763, or later)*
+- VS Code v1.104 or later with [GitHub Copilot extension](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) enabled
+- Access to [Copilot in VS Code](https://code.visualstudio.com/docs/copilot/overview)
+- [WinGet with MCP server support installed on your system](#set-up-winget-mcp-server)
+
+## Set up WinGet MCP Server
+
+To set up the WinGet MCP server for use with AI agents in VS Code, you must:
+
+1. Find the WinGet MCP server executable path
+1. Configure the MCP server in Visual Studio Code
+
+### Find the WinGet MCP server executable path
+
+To set up the WinGet MCP server, you must first locate the path to the executable file. Use one of the following methods to find the path:
+
+1. Open a command prompt and enter the `winget mcp` command. The result displays the JSON configuration fragment that shows the path to the `WindowsPackageManagerMCPServer.exe` file.
+
+    ```powershell
+    winget mcp
+    ```
+
+1. Open PowerShell and use the following script to locate the MCP server executable:
+
+    ```powershell
+    # Find the WinGet executable path
+    $wingetPath = (Get-Command winget).Source
+    # Get the directory containing WinGet
+    $wingetDir = Split-Path $wingetPath -Parent
+    # The MCP server executable is in the same directory
+    $mcpServerPath = Join-Path -Path $wingetDir `
+        -ChildPath "Microsoft.DesktopAppInstaller_8wekyb3d8bbwe" `
+        -AdditionalChildPath "WindowsPackageManagerMCPServer.exe"
+    Write-Host "WinGet MCP Server path: $mcpServerPath"
+    ```
+
+The typical location is:`C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\WindowsPackageManagerMCPServer.exe`
+
+### Configure the MCP server in Visual Studio Code
+
+The recommended way to configure the WinGet MCP server is through an `mcp.json` configuration file. You need to find (you might need to show hidden files) or create a `.vscode` folder in the root directory of your project. In this directory, create a `mcp.json` file (or update it if this file already exists) with the following content:
+
+```json
+{
+  "servers": {
+    "winget-mcp": {
+      "type": "stdio",
+      "command": "C:\\Users\\<username>\\AppData\\Local\\Microsoft\\WindowsApps\\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\\WindowsPackageManagerMCPServer.exe"
+    }
+  },
+  "inputs": []
+}
+```
+
+Replace `<username>` with your actual Windows username or use the WinGet MCP server executable path that you previously identified.
+
+This configuration tells MCP clients to:
+
+- Use the Windows Package Manager (WinGet) MCP server executable as the command
+- Use standard I/O communication between the client and server
+- Register the server with the identifier `winget-mcp`
+
+For detailed information about MCP configuration and setup in VS Code, see [Use MCP servers in VS Code](https://code.visualstudio.com/docs/copilot/customization/mcp-servers).
+
+### Manual command-line testing
+
+To start the WinGet MCP server manually for testing or development purposes, run the executable directly by entering the following command in PowerShell:
+
+```powershell
+& "C:\Users\<username>\AppData\Local\Microsoft\WindowsApps\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\WindowsPackageManagerMCPServer.exe"
+```
+
+Replace `<username>` with your actual Windows username.
+
+The server starts and waits for MCP protocol messages on standard input. The server continues running until you terminate it (Ctrl+C) or close the input stream.
+
+## Use WinGet MCP tools in Visual Studio Code
+
+To start using the Windows Package Manager (WinGet) MCP Server in Visual Studio Code:
+
+1. Open the GitHub Copilot extension chat window and select **Agent Mode** to enable MCP tool integration.
+1. Access WinGet MCP tools by selecting the tool icon in the GitHub Copilot chat window and search for **MCP Server: winget-mcp** in the available tools list.
+1. Verify that the WinGet MCP server tools are available, with a checkmark next to the entry.
+1. Begin asking questions or requesting assistance with package management tasks. The AI agent automatically uses the WinGet MCP tools when appropriate to provide accurate, context-aware help.
+
+## Example prompts for WinGet MCP
+
+Example prompts that work well with WinGet MCP integration:
+
+- "What packages are available for Python development?"
+- "Help me install Visual Studio Code"
+- "Find packages for Docker on Windows"
+- "Install the latest version of Git"
+
+## Available WinGet MCP commands
+
+The WinGet MCP server currently supports the following commands:
+
+### find
+
+Searches the WinGet repository for packages matching specified criteria. This tool helps discover available software and their details.
+
+**Parameters:**
+
+- Search query or package identifier
+- Optional filters for source, version, or other criteria
+
+### install
+
+Initiates the installation of a specified package from the WinGet repository.
+This tool can install packages with your approval.
+
+**Parameters:**
+
+- Package identifier or name
+- Optional version specification
+- Optional installation parameters
+
+## Troubleshooting
+
+### Connection issues
+
+If you encounter connection issues between VS Code and the WinGet MCP server:
+
+1. Verify your `mcp.json` configuration file syntax.
+1. Check that the path to `WindowsPackageManagerMCPServer.exe` is correct.
+1. Ensure the executable has proper permissions to run.
+1. Review VS Code's output panel for detailed error messages.
+1. Try restarting the MCP integration in VS Code.
+
+### Limited or no response from AI Agent
+
+If the AI agent doesn't seem to be using WinGet MCP tools:
+
+- Use specific prompts that clearly indicate you want package management information.
+- Try phrases like "Search for packages" or "Install using WinGet".
+- Verify that Agent Mode is enabled in Copilot Chat.
+- Check if the WinGet MCP tools are visible in the tools list.
+
+### Package installation issues
+
+If package installation fails or behaves unexpectedly:
+
+- Review the installation command or parameters suggested by the AI agent.
+- Check the [WinGet troubleshooting guide](./troubleshooting.md) for common issues.
+- Verify you have appropriate permissions to install software.
+- Ensure the package source is accessible.
+
+## Limitations
+
+> [!IMPORTANT]
+> You are responsible for reviewing all commands generated with AI assistance. **Always validate installation commands and verify the software source before executing them on your system.**
+
+Current limitations of the WinGet MCP server integration include:
+
+- **Agent behavior**: AI agents might not use the WinGet MCP server for every query, though specific prompting can encourage its use.
+- **Tool availability**: The integration currently supports only `find` and `install` commands. Future releases might add support for more commands.
+
+## How WinGet MCP integrates with VS Code
+
+The WinGet MCP server integrates with VS Code and AI agents as follows:
+
+1. **VS Code Copilot** communicates with AI agents that can access MCP servers.
+1. **AI agents** use the MCP protocol to query the WinGet MCP server for information.
+1. **WinGet MCP server** processes requests and calls the appropriate WinGet CLI commands.
+1. **WinGet CLI** performs package searches and installations in the repository.
+1. **Results** flow back through the chain to provide enhanced assistance.
+
+![WinGet MCP integration diagram](../../images/winget-mcp-integration-with-vscode.png)