Skip to main content

MCP server to parse documentation for the windows crate

Project description

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

windows_rs_mcp-0.4.0.tar.gz (39.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

windows_rs_mcp-0.4.0-py3-none-any.whl (19.6 kB view details)

Uploaded Python 3

File details

Details for the file windows_rs_mcp-0.4.0.tar.gz.

File metadata

  • Download URL: windows_rs_mcp-0.4.0.tar.gz
  • Upload date:
  • Size: 39.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.9.0

File hashes

Hashes for windows_rs_mcp-0.4.0.tar.gz
Algorithm Hash digest
SHA256 cc213e16da52c484ea23b7cb6d02b2ea791834c050b6494888d011ce4b5b1235
MD5 e8475d14c6881de280135db513c02a39
BLAKE2b-256 f4215aad80932c5b0c48c940edfa63b90cf37325fc288f871f96cc133d2ab39b

See more details on using hashes here.

File details

Details for the file windows_rs_mcp-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for windows_rs_mcp-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e5c366f8f366b41d5bc1b6c7727ce1fbcc9a3b7569c4cb7495ee0d5e5cf0c2bc
MD5 34cdb2925fe8d17fa6eba69465ebcbed
BLAKE2b-256 b628a1adae1e00a2bc32c95811c798865f2983f080d71d7d128bf640bb206320

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page