{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs-realm.sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["configOptionRequirements","partial"]},"redocly_category":"Realm","type":"markdown"},"seo":{"title":"WebMCP tools","description":"OpenAPI-generated documentation tool with 24k+ stars on Github - make APIs your company's superpower.","siteUrl":"https://redocly.com","image":"/assets/redocly-card.f670aae34a39545a5ea633a540cb3a4a333a1f23bb2ed3c4a1b17a5fbcf0ac85.db81178d.png","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"webmcp-tools","__idx":0},"children":["WebMCP tools"]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Experimental"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is an experimental feature."," ","Its behavior may change in future releases."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://github.com/webmachinelearning/webmcp"},"children":["WebMCP"]}," is a proposed browser standard."," ","A page registers tools, and an AI agent that runs in the reader's browser can call them."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your project publishes these tools automatically."," ","An agent can search your documentation, read and open pages, instead of guessing at URLs or reading the rendered HTML."," ","The reader sees every page the agent opens, because the tools drive the same site the reader is looking at."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["WebMCP is different from the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/mcp-server"},"children":["MCP server"]},"."," ","The MCP server serves agents that connect from outside the browser, such as Cursor or Claude Code."," ","WebMCP serves the agent that is already in the tab with the reader."," ","You can use either or both in your project."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tools-on-every-page","__idx":1},"children":["Tools on every page"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_current_page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reports the page the reader is on, the product and version in scope, and whether the page is an API reference."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_docs"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Searches the project and returns matching pages with their titles and URLs."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["read_page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the Markdown source of a page."," ","Omit the page to read the page the reader is on."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_site_overview"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the navigation tree, limited to the pages the reader can access."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["read_skill"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/agent-skills"},"children":["agent skills"]}," the project publishes, or returns one by name."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["navigate_page"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Moves the browser tab to another page of the project."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["leave_feedback"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Reports that a page is wrong, outdated, confusing, or incomplete."," ","The report is available on the Reunite ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Feedback"]}," page."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"tools-on-api-reference-pages","__idx":2},"children":["Tools on API reference pages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Your project adds the following tools while the reader is on an API reference page."," ","It removes them again when the reader leaves that page."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Tool"},"children":["Tool"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list_api_operations"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Lists the operations of the API on the page, with the method, the path, and the documentation URL of each one."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_api_operation"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns one operation in full: the parameters, the request body, the responses, and the examples."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_api_authentication"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Returns the servers and the security schemes of the API."," ","Credentials are never included."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"access-control","__idx":3},"children":["Access control"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The tools return only the content the reader can access."," ","Anonymous readers receive only the pages, search results, and navigation tree they can see on the site."," ","For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/access/rbac"},"children":["RBAC"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Agents never receive stored credentials."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["get_api_authentication"]}," tool returns the type of each security scheme and its OAuth flows."," ","It removes the values that ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/configure-request-values"},"children":["Try it"]}," puts into a request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"turn-off-the-feedback-tool","__idx":4},"children":["Turn off the feedback tool"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["leave_feedback"]}," tool is removed when you hide the feedback form:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"feedback:\n  hide: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For more information, see ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/feedback"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["feedback"]}]},"."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"browser-support","__idx":5},"children":["Browser support"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["WebMCP is an origin trial in Chrome 149 and later, and in Edge 150 and later."," ","Safari and Firefox do not support it."," ","A browser without WebMCP shows your documentation normally and registers no tools."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":6},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/mcp-server"},"children":["MCP server"]}]}," - Serve your documentation to agents that connect from outside the browser"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/customization/agent-skills"},"children":["Agent skills"]}]}," - Describe tasks that an agent can complete against your product"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/ai-ready"},"children":["Make docs AI ready"]}]}," - Every way to serve your documentation to AI tools"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/docs/realm/config/feedback"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["feedback"]}]}]}," - Configure the feedback form and the feedback tool"]}]}]},"headings":[{"value":"WebMCP tools","id":"webmcp-tools","depth":1},{"value":"Tools on every page","id":"tools-on-every-page","depth":2},{"value":"Tools on API reference pages","id":"tools-on-api-reference-pages","depth":2},{"value":"Access control","id":"access-control","depth":2},{"value":"Turn off the feedback tool","id":"turn-off-the-feedback-tool","depth":2},{"value":"Browser support","id":"browser-support","depth":2},{"value":"Resources","id":"resources","depth":2}],"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"seo":{"title":"WebMCP tools"}},"lastModified":"2026-09-24T15:07:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/realm/customization/webmcp","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}