Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.vobiz.ai/llms.txt

Use this file to discover all available pages before exploring further.

The Vobiz docs ship with a hosted Model Context Protocol (MCP) server. Point any MCP‑aware client — Claude Desktop, Claude Code, Cursor, VS Code, ChatGPT desktop — at it and the assistant can search and read every page of these docs in‑context, so answers stay current with the live site instead of the model’s training snapshot.

​
Install with one command

npx add-mcp https://docs.vobiz.ai/mcp
That’s it. add-mcp scans your machine for installed MCP clients (Claude Desktop, Claude Code, Cursor, VS Code, Windsurf…), shows a checklist of which ones to wire up, writes the right config block to each, and prompts you to restart anything that needs it. The command is idempotent — re‑run it any time you install a new client.
Server endpoint
https://docs.vobiz.ai/mcp
  • Transport: Streamable HTTP (no auth, public).
  • What it exposes: full‑text search and page fetch across the Vobiz documentation site.
  • What it is not: this is not the Vobiz REST or Partner API — it only reads docs. For programmatic call/account access, use the API Reference instead.
Testing against a local Mintlify preview? Point add-mcp at the dev server instead:
npx add-mcp http://localhost:3000/mcp
(Use whatever port mintlify dev is bound to — 3001 if you started it with --port 3001.)

​
Prerequisites

  • An MCP‑aware client (Claude Desktop, Claude Code, Cursor, VS Code 1.99+, etc.).
  • Node.js 18+ for npx. If node --version prints v18 or higher, you’re set.
  • An internet connection — the server is hosted, nothing runs locally.

​
Manual setup per client

If you’d rather wire each client up by hand (or add-mcp didn’t detect yours), the sections below show the exact config for each.

​
Claude Desktop

Claude Desktop currently launches MCP servers over stdio, so you wrap the hosted HTTP endpoint with mcp-remote. No global install needed — npx fetches it on first run.
1

Open the config file

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json
If the file doesn’t exist yet, create it with {} as its content.
2

Add the Vobiz server

Merge this block into your config:
claude_desktop_config.json
{
  "mcpServers": {
    "vobiz-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.vobiz.ai/mcp"]
    }
  }
}
3

Restart Claude Desktop

Quit Claude fully (⌘Q on macOS) and reopen it. The new tools surface under the 🔌 / hammer icon in the prompt bar — you should see entries like search and fetch listed under vobiz-docs.
4

Try it

Ask Claude:
Using the vobiz-docs MCP server, how do I start an audio stream from XML?
Claude will call the search/fetch tools and answer from the live docs.

​
Claude Code

Claude Code (the CLI) speaks Streamable HTTP natively — no mcp-remote shim required.
1

Add the server

Run from any project directory:
claude mcp add --transport http vobiz-docs https://docs.vobiz.ai/mcp
Use --scope user to make the server available across every project, or --scope project to commit the config alongside the repo:
claude mcp add --transport http --scope user vobiz-docs https://docs.vobiz.ai/mcp
2

Verify it loaded

claude mcp list
vobiz-docs should appear with a ✓ next to it. Inside a session, type /mcp to see live status and the tools the server exposes.
3

Use it in a session

Anywhere in a Claude Code conversation:
Look up the <Stream> XML attributes in the Vobiz docs and write me a minimal handler.
Claude Code will call vobiz-docs__search / vobiz-docs__fetch automatically.

​
Cursor

Cursor reads MCP servers from ~/.cursor/mcp.json (global) or .cursor/mcp.json (per‑project).
1

Edit the MCP config

Open Cursor → Settings → MCP → Edit Config, or edit the file directly:
~/.cursor/mcp.json
{
  "mcpServers": {
    "vobiz-docs": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://docs.vobiz.ai/mcp"]
    }
  }
}
2

Enable & test

Back in Settings → MCP, toggle vobiz-docs on. The status dot should turn green within a few seconds. Open a new chat and ask a Vobiz‑specific question — Cursor surfaces an “MCP” badge when it pulls from the server.

​
VS Code

VS Code 1.99+ has first‑class MCP support behind the Copilot Chat → Agent mode.
1

Create the workspace config

Inside your project, create .vscode/mcp.json:
.vscode/mcp.json
{
  "servers": {
    "vobiz-docs": {
      "type": "http",
      "url": "https://docs.vobiz.ai/mcp"
    }
  }
}
Prefer a global setup? Run the MCP: Add Server command from the palette (⇧⌘P) and paste the same URL.
2

Use it in agent mode

Open the Copilot Chat panel, switch to Agent, and click the 🛠 tools menu — enable vobiz-docs. Ask the agent anything about Vobiz and it will fetch from the docs automatically.

​
Any other MCP client

The hosted URL works with any client that speaks Streamable HTTP. Two common one‑off invocations:
Run mcp-remote directly
npx -y mcp-remote https://docs.vobiz.ai/mcp
Probe with the MCP Inspector
npx -y @modelcontextprotocol/inspector npx -y mcp-remote https://docs.vobiz.ai/mcp
The Inspector launches a small web UI where you can list tools, call search with a query, and inspect raw JSON‑RPC traffic — handy when integrating a brand‑new client.

​
Verify the connection

A quick sanity check that works in any client:
Use the Vobiz MCP server to find the page that documents the playedStream event, then quote its first paragraph.
If the assistant returns content from /xml/stream/stream-events, the connection is healthy. If it answers from memory (or gets details wrong), the server isn’t actually wired up — re‑check the config file and restart the client.

​
Troubleshooting

Most issues are config‑file syntax or stale processes — not server‑side problems. The endpoint is publicly reachable; if curl https://docs.vobiz.ai/mcp returns a response, the server is up.
  • Claude Desktop shows no tools after editing the config. Fully quit (⌘Q / right‑click → Quit). A window close alone keeps the process alive and the old config cached.
  • npx: command not found. Install Node.js 18+. On macOS with Homebrew: brew install node.
  • mcp-remote errors out on first run. Clear the npx cache: rm -rf ~/.npm/_npx and try again. Corporate proxies sometimes block the npm registry — set HTTPS_PROXY accordingly.
  • Claude Code says Server failed to connect. Run claude mcp list to see the current entry, remove it with claude mcp remove vobiz-docs, then re‑add. The --transport http flag is required — without it the CLI assumes stdio.
  • VS Code: tools menu is empty. You’re not in Agent mode. Switch the Copilot Chat dropdown from Ask to Agent; MCP tools only surface there.