Skip to main content

Add your description here

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.

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.1.0.tar.gz (20.8 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.1.0-py3-none-any.whl (7.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for windows_rs_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 98d6357f03d15a41c97e8ecf0d07f2a35e7ce587181988382ec120a9c3c6e1ef
MD5 c9ff69e05d8626f5f32793fb44bd83eb
BLAKE2b-256 a1eee4d46808ef2f43f435b5be223761558cc7c96decc77e9e198f6547725a77

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for windows_rs_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 563d8bc4ebed69d3e9428391d142fe4a92b64f343844e53d90a9184ecf414bf1
MD5 7c0144c67ffed99583a7c7ac65372f66
BLAKE2b-256 14e6680ac90f714ff2261eb3388b328b33e174728a9e762a0477c28b8ad9a8e3

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