使用说明

项目简介

本项目是一个 MCP 服务器，旨在为 LLM 客户端提供搜索 Rust 'windows' crate API 文档的功能。通过集成此 MCP 服务器，LLM 应用可以调用 'search_windows_api' 工具，查询 Windows API 的相关信息，例如函数、结构体、枚举等，并获取详细的文档内容，包括描述、签名和所需的 Cargo feature。

主要功能点

Windows API 搜索: 使用 'search_windows_api' 工具在 Rust 'windows' crate 文档中查找 API。
文档获取: 检索精确匹配项的详细文档，包含描述、签名和 Cargo feature 信息。
相关 API 查找: 列出搜索结果中相关的 API 条目。

安装步骤

环境准备: 确保已安装 Python 和 'uv' 或 'uvx' 包管理器。（推荐使用 'uvx' 简化操作）
安装 MCP 服务器: 使用 'uv pip install windows-rs-mcp' 命令安装该 MCP 服务器。
```
uv pip install windows-rs-mcp
```
Playwright 浏览器: 首次运行服务器时，会自动检查并安装 Playwright 浏览器 (Chromium)。如果需要跳过自动安装，可以设置环境变量 'MCP_SKIP_PLAYWRIGHT_INSTALL=true'。您也可以通过设置 'MCP_PLAYWRIGHT_BROWSER' 环境变量来指定要安装的浏览器，例如 'firefox' 或 'webkit'。

服务器配置

要将此 MCP 服务器与 MCP 客户端（如 Claude Desktop 或 Cursor）连接，您需要在客户端的 MCP 服务器配置中添加以下 JSON 配置信息。

Claude Desktop 配置 (推荐使用 'uvx' 启动)

打开 Claude Desktop 的设置，找到 MCP 服务器配置，添加如下配置：

{
  "mcpServers": {
    "windows-docs": {  //  服务器名称，可自定义
      "command": "uvx",  //  启动命令，使用 uvx 简化启动
      "args": [
        "windows-rs-mcp" //  uvx 运行的参数，即服务器包名
      ]
    }
  }
}

Cursor 配置 (使用 'uvx' 启动)

打开 Cursor 的 '.cursor/mcp.json' 文件 (如果不存在则创建)，添加如下配置：

{
  "mcpServers": {
    "windows-rs-mcp": {  //  服务器名称，可自定义
      "command": "uvx",  //  启动命令，使用 uvx 简化启动
      "args": ["windows-rs-mcp"] // uvx 运行的参数，即服务器包名
    }
  }
}

基本使用方法

配置完成后，重启 MCP 客户端。在客户端中，您可以通过自然语言指令或客户端提供的工具调用界面来使用 'search_windows_api' 工具。例如，在 Claude Desktop 中，您可以提问类似 “使用 'search_windows_api' 工具搜索 'CreateFile' 函数的 windows API 文档” 的问题。MCP 服务器将响应 LLM 客户端的请求，并返回搜索结果和文档信息。

关键词

使用说明

信息