windows-rs MCP Server

README

Windows Crate Docs Search MCP

This project provides a Claude Desktop MCP server that allows searching the Rust windows crate API documentation hosted at microsoft.github.io/windows-docs-rs.

It uses Playwright to interact with the documentation website's search functionality and the features table.

Features

Search Windows API: Use the search_windows_api tool to find functions, structs, enums, etc., within the windows crate docs.
Get Documentation: Retrieve detailed documentation for exact matches, including description, signature, and the required Cargo feature (best effort).
Find Related Items: List related API items found during the search.

Usage

This package requires Playwright browsers to be installed. The server attempts to install the default browser (chromium) automatically on the first run. You can skip this by setting the MCP_SKIP_PLAYWRIGHT_INSTALL environment variable.

Running the MCP Server

Using uvx:

The simplest way to run the server after installation is using uvx:

uvx windows-rs-mcp

Running Locally with uv:

If you have cloned the repository, you can run the server directly using uv run from the project directory:

# Navigate to the project root directory
# cd /path/to/windows-rs-mcp  (Linux/macOS)
# cd C:\path\to\your\project\windows-rs-mcp (Windows)

# Run the server
uv run windows-rs-mcp

Configuring Claude Desktop

To use this MCP with Claude Desktop, add the following configuration to your Claude Desktop settings:

Option 1: Using uvx (Recommended)

{
  "mcpServers": {
    "windows-docs": {
      "command": "uvx",
      "args": [
        "windows-rs-mcp"
      ]
    }
  }
}

Option 2: Using uv run (For local source)

Make sure to replace the placeholder path in args with the actual absolute path to your project directory.

{
  "mcpServers": {
    "windows-docs": {
      "command": "uv",
      "args": [
        "--directory",
        "C:\\path\\to\\your\\project\\windows-rs-mcp", // <-- Replace with your path
        "run",
        "windows-rs-mcp"
      ]
    }
  }
}

After configuring, restart Claude Desktop. You should then be able to use the search_windows_api tool.

Configuring Cursor

Open .cursor/mcp.json and add the MCP server

{
  "mcpServers": {
    "windows-rs-mcp": {
      "command": "uvx",
      "args": ["windows-rs-mcp"]
    }
  }
}

Environment Variables

MCP_SKIP_PLAYWRIGHT_INSTALL: Set to true, 1, or yes to skip the automatic Playwright browser installation check.
MCP_PLAYWRIGHT_BROWSER: Specifies the browser Playwright should install (defaults to chromium). Other options include firefox and webkit.

windows-rs-mcp FAQ

How does windows-rs-mcp retrieve documentation data?

It uses Playwright to interact with the official Rust windows crate docs website's search and features table.

Is Playwright installation required to run this MCP server?

Yes, Playwright browsers are required and the server attempts to auto-install Chromium on first run unless skipped via environment variable.

Can windows-rs-mcp provide Cargo feature information for API items?

Yes, it attempts to include the required Cargo feature for each documented API item on a best-effort basis.

What kind of API items can I search with this MCP?

You can search for functions, structs, enums, and other items within the Rust windows crate documentation.

Can this MCP server be used with different LLM providers?

Yes, it is compatible with models like Claude, OpenAI GPT, and Gemini through the MCP protocol.

How do I skip Playwright browser installation if needed?

Set the environment variable MCP_SKIP_PLAYWRIGHT_INSTALL before running the server.

Does windows-rs-mcp support searching documentation offline?

No, it interacts live with the online documentation website using Playwright.

What platforms does windows-rs-mcp support?

It supports any platform where Playwright and Rust can run, typically Windows, Linux, and macOS.