Skip to content

OpenVidu Docs

by openvidu.io · remote · no sign-in to list tools · v1.0.0 · published by io.openvidu

The official OpenVidu documentation, per version, for coding agents.

Read only

7 tools: 7 only read.

Scanned Oct 21, 2026

1 check matched something in the tool definitions. No finding is not a safety guarantee. How the checks work.

claude mcp add --transport http docs https://docs-mcp.openvidu.io/mcp

Findings

Matches of fixed checks, with the text they matched.

1 info

Tools

Open a tool for its reasons and full description. Descriptions are the publisher's own words, shown as they are.

7 tools

Only reads 7Claude Code: allow
  • get_changelogReturns the release notes / changelog page(s) already indexed for a version (e.g.No findings

    Why it is in this group

    • The name "get_changelog" says "get": a word for reading.
    Description, as the server wrote it
    Returns the release notes / changelog page(s) already indexed for a version (e.g. 'OpenVidu Meet release notes', 'OpenVidu Platform release notes'), without having to guess the URL via search_docs or list_doc_sections. A page cut at 'max_chars' carries 'truncated', 'next_offset' and 'headings': pass its 'url' to get_doc_page with that offset to read on, or with one of those headings to read just that release. The response includes 'version_used': always tell the user which documentation version what you're telling them corresponds to. If it also carries 'version_warning', or 'version_sensitive': true on a result or in a page's 'version_note', the page changes between versions: say so explicitly and explain how to specify a different one. The index has no notion of edition or product, so if the answer depends on either, say which one you assumed.

    Annotations the server declares

    • title: Get release notes
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • get_doc_pageReturns the content of a page of the OpenVidu documentation (openvidu.io) for a specific version, or of several pages at once with 'urls' (one round trip instead of several).No findings

    Why it is in this group

    • The name "get_doc_page" says "get": a word for reading.
    Description, as the server wrote it
    Returns the content of a page of the OpenVidu documentation (openvidu.io) for a specific version, or of several pages at once with 'urls' (one round trip instead of several). Pass exactly one of 'url' and 'urls'. A URL ending in a #anchor, as search_docs returns for a match under a heading, returns only that heading's section, subsections included; 'heading' does the same by name, and comes with the page's 'intro' and 'headings': when the answer may also depend on setup or context described elsewhere, read those sections too, or drop the anchor to read the whole page. A page longer than 'max_chars' comes back cut: 'truncated' is true, 'total_chars' is its full length, 'next_offset' is the 'offset' that reads the next chunk, and 'headings' lists its sections and their sizes, so you can read only the one you need. Every URL returned is the page as a person opens it: link those in answers. list_doc_sections with 'section' gives valid URLs; so does search_docs. The response includes 'version_used': always tell the user which documentation version what you're telling them corresponds to. If it also carries 'version_warning', or 'version_sensitive': true on a result or in a page's 'version_note', the page changes between versions: say so explicitly and explain how to specify a different one. The index has no notion of edition or product, so if the answer depends on either, say which one you assumed.

    Annotations the server declares

    • title: Get a documentation page
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • get_pricing_infoReturns the content of OpenVidu's pricing page (editions, plans, cost model).No findings

    Why it is in this group

    • The name "get_pricing_info" says "get": a word for reading.
    Description, as the server wrote it
    Returns the content of OpenVidu's pricing page (editions, plans, cost model). Not versioned: pricing is the same across every indexed documentation version, so this tool takes no 'version' argument. When cut at 'max_chars' it carries 'truncated', 'next_offset' and 'headings': pass its 'url' to get_doc_page with that offset to read on, or with a heading to read just that section.

    Annotations the server declares

    • title: Get pricing information
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • list_doc_sectionsBrowses the indexed documentation of a version.No findings

    Why it is in this group

    • The name "list_doc_sections" says "list": a word for reading.
    Description, as the server wrote it
    Browses the indexed documentation of a version. Without arguments it returns an overview: every section and how many pages it holds. With 'section' it returns that section's pages, with their URLs and descriptions. Use it to find out what exists before requesting a specific page. The response includes 'version_used': always tell the user which documentation version what you're telling them corresponds to. If it also carries 'version_warning', or 'version_sensitive': true on a result or in a page's 'version_note', the page changes between versions: say so explicitly and explain how to specify a different one. The index has no notion of edition or product, so if the answer depends on either, say which one you assumed.

    Annotations the server declares

    • title: List documentation sections
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • list_versionsLists the available documentation versions and the default one, plus where to look for the user's version-edition-product.No findings

    Why it is in this group

    • The name "list_versions" says "list": a word for reading.
    Description, as the server wrote it
    Lists the available documentation versions and the default one, plus where to look for the user's version-edition-product. Use it if you don't know what value to pass for 'version'. It does NOT establish the user's deployment: for the procedure that does, and for the snippet that pins the result in their AGENTS.md/CLAUDE.md, call 'resolve_openvidu_version_edition_product'.

    Annotations the server declares

    • title: List documentation versions
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • resolve_openvidu_version_edition_productAnswers "which OpenVidu version, edition and product does this project use?".1 finding

    Why it is in this group

    • The name "resolve_openvidu_version_edition_product" says "resolve": a word for reading.

    Findings

    • Info

      The description mentions "credentials".

      Matched text

      description: "...et, locating the deployment URL and its credentials, querying the endpoint that reports ver..."

      What this check looks for
    Description, as the server wrote it
    Answers "which OpenVidu version, edition and product does this project use?". Called with NO arguments, it returns the full procedure a coding agent follows to find out from the deployment itself: telling OpenVidu Platform (LiveKit SDKs) from OpenVidu Meet, locating the deployment URL and its credentials, querying the endpoint that reports version and edition, the fallbacks when that endpoint is unavailable, and the security rules that apply throughout. Use it before answering anything version-, edition- or product-dependent, unless the project's AGENTS.md/CLAUDE.md already pins it. Called WITH 'livekit_version', it additionally translates a LiveKit Server version (as printed in OpenVidu LiveKit Server's startup log) into the OpenVidu version(s) built on it — the fallback path of the procedure for deployments before 3.9.0, which cannot report their own version. Called with 'commands': true, it returns the exact commands that ask a deployment for its version and edition, keeping its credentials out of sight. Never infer any of the three facts from the project's client SDK dependency versions.

    Annotations the server declares

    • title: Resolve version, edition and product
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false
  • search_docsSearches for a term in the indexed documentation of a version.No findings

    Why it is in this group

    • The name "search_docs" says "search": a word for reading.
    Description, as the server wrote it
    Searches for a term in the indexed documentation of a version. Applies stemming and domain synonyms, so morphological variants and synonyms also match. Pass exactly one of 'query' and 'queries' — the latter runs several searches in one call, each under 'searches'. When 'truncated' is true, 'next_page' is the value of 'page' for the next results. A match under a heading names it in 'heading', and its 'url' ends in that section's #anchor: get_doc_page on that URL reads just the section. May also return a `livekit` block: pointers to LiveKit's SDK documentation, which is NOT OpenVidu documentation and carries its own version caveat — read that block's own guidance before using it. The response includes 'version_used': always tell the user which documentation version what you're telling them corresponds to. If it also carries 'version_warning', or 'version_sensitive': true on a result or in a page's 'version_note', the page changes between versions: say so explicitly and explain how to specify a different one. The index has no notion of edition or product, so if the answer depends on either, say which one you assumed.

    Annotations the server declares

    • title: Search the documentation
    • readOnlyHint: true
    • destructiveHint: false
    • idempotentHint: true
    • openWorldHint: false

This is not a safety rating, and no finding is not a safety guarantee. The groups and findings come from fixed checks of the tool definitions the server returned on the date shown, not from its code or what it does when called. How the checks work.

Install

Pinned to version 1.0.0. Values in angle brackets are yours to fill in.

claude mcp add --transport http docs https://docs-mcp.openvidu.io/mcp

Run in a terminal.

Claude Code permissions

Allow the reads, ask before a change, deny the deletes. Paste into .claude/settings.json.

.claude/settings.json
{
  "permissions": {
    "allow": [
      "mcp__docs__resolve_openvidu_version_edition_product",
      "mcp__docs__list_versions",
      "mcp__docs__list_doc_sections",
      "mcp__docs__get_doc_page",
      "mcp__docs__search_docs",
      "mcp__docs__get_changelog",
      "mcp__docs__get_pricing_info"
    ],
    "ask": [],
    "deny": []
  }
}

Tools that only read are allowed, tools that change things ask first, tools that delete or cancel are denied. It assumes the server is installed as docs. Review it before you use it.