WebMCP

Added in v2.1.0

Rspress enables webMcp by default, so agents can use WebMCP to search, read, and navigate Rspress documentation. For more details, see ChatGPT - Site tools.

## Task

Open https://rspress.rs in a browser and check which WebMCP tools the current page makes available to you. Use the actual tool names and descriptions returned by the browser to list each tool by name and explain in one sentence what it can do.

## WebMCP connection options

- Native connection: If your agent environment provides a WebMCP browser connection, use it to discover the page's tools.
- CLI fallback: Run this command to open the page, wait for loading, list its WebMCP tools as JSON, and close the browser:

npx -y agent-browser@latest --session rspress-webmcp --json batch "open https://rspress.rs" "wait --load networkidle" "webmcp list" "close"

If Chrome is missing, run npx -y agent-browser@latest install first, then retry. See https://agent-browser.dev/webmcp for command details.

Read the live tool registry rather than inferring tools from HTML or documentation. If setup or discovery fails, report the actual error; distinguish this from a successfully retrieved empty tool list.

rspress.config.ts

import { defineConfig } from '@rspress/core';

export default defineConfig({
  webMcp: true, // default value
});

Set webMcp: false to disable the Rspress built-in tools. The useWebMcp hook remains available for registering custom tools.

Built-in tools

Tool	Purpose
`get_site_info`	Site metadata, locales, versions, navigation, and the active sidebar.
`list_pages`	Filter and paginate page metadata, defaulting to the active language and version. Works independently of search.
`get_page`	Read metadata, frontmatter, TOC, and Markdown for a known route without navigating (enabled with SSG-MD).
`get_current_page`	Read metadata, frontmatter, TOC, and Markdown for the current page (enabled with SSG-MD).
`search_docs`	Search the local documentation index for the active language and version (default theme local search only).
`navigate`	Navigate to a known internal route, then return committed page metadata, section routes, and previous/next pages.

View tool input schemas

toolInputSchemas.json

{
  "get_current_page": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false
  },
  "get_page": {
    "type": "object",
    "properties": {
      "routePath": {
        "type": "string",
        "minLength": 1
      }
    },
    "required": ["routePath"],
    "additionalProperties": false
  },
  "get_site_info": {
    "type": "object",
    "properties": {},
    "required": [],
    "additionalProperties": false
  },
  "list_pages": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "minLength": 1
      },
      "lang": {
        "type": "string"
      },
      "version": {
        "type": "string"
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 100
      },
      "offset": {
        "type": "integer",
        "minimum": 0
      }
    },
    "required": [],
    "additionalProperties": false
  },
  "navigate": {
    "type": "object",
    "properties": {
      "routePath": {
        "type": "string",
        "minLength": 1
      }
    },
    "required": ["routePath"],
    "additionalProperties": false
  },
  "search_docs": {
    "type": "object",
    "properties": {
      "query": {
        "type": "string",
        "minLength": 1
      },
      "limit": {
        "type": "integer",
        "minimum": 1,
        "maximum": 20
      }
    },
    "required": ["query"],
    "additionalProperties": false
  }
}

Cross-origin agents

Use webMcp.exposedTo to allow specific secure origins to discover tools.

Custom tools

Use useWebMcp from @rspress/core/runtime to register tools in your own components. Tools are automatically removed when the component unmounts.

#WebMCP

#Built-in tools

#Cross-origin agents

#Custom tools

WebMCP

Built-in tools

Cross-origin agents

Custom tools