Hoppscotch Public Docs MCP

A read-only MCP server for published Hoppscotch API documentation. Search requests, inspect endpoint details, and read saved response examples. It uses Hoppscotch's public documentation endpoint; no Hoppscotch account or token is required.

Installation

For Agents

Copy one of these prompts and paste it into your MCP-capable AI agent.

Using uv

Install the Hoppscotch Public Docs MCP server for this AI client from https://github.com/KidiXDev/hoppscotch-public-docs-mcp.

Follow the repository README and install it using uv. Install uv first if needed.

Configure this client to run:
hoppscotch-public-docs-mcp

Do not set a default Hoppscotch document URL. I will give you a published URL for each project; pass it as doc_url on every tool call.

Verify that the server exposes get_document, search_documentation, list_endpoints, and get_endpoint.

Tell me what you configured and whether I need to restart the client.

Using Docker

Install the Hoppscotch Public Docs MCP server for this AI client from https://github.com/KidiXDev/hoppscotch-public-docs-mcp.

Use the prebuilt Docker image:
ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest

Configure this client to run the MCP server over stdio using:
docker run --rm -i ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest

Do not set a default Hoppscotch document URL. I will give you a published URL for each project; pass it as doc_url on every tool call.

Verify that the server exposes get_document, search_documentation, list_endpoints, and get_endpoint.

Tell me what you configured and whether I need to restart the client.

For Humans

Using uv

Requires Python 3.10+ and uv.

Install directly from GitHub:

uv tool install git+https://github.com/KidiXDev/hoppscotch-public-docs-mcp.git

Or install from a checkout:

uv tool install .

Then configure your MCP client.

To check a published document:

hoppscotch-public-docs-mcp --check https://api-docs.hoppscotch.io/view/YOUR_DOC_ID

If the command is not found after installation, run uv tool update-shell, reopen your terminal, or use the executable's absolute path in your MCP client.

Using Docker

Pull the prebuilt image:

docker pull ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest

Check a published document:

docker run --rm \
  ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest \
  --check https://api-docs.hoppscotch.io/view/YOUR_DOC_ID

For an MCP client's stdio configuration, use:

docker run --rm -i ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest

Keep -i and do not detach the container.

Related MCP server: Documentation Fetcher & RAG Search

Choose a document per call

Start the server without a document URL. Pass the project's published /view/<slug> URL as doc_url on each tool call, optionally ending in a version.

For example:

search_documentation(
  query="tenant",
  doc_url="https://api-docs.hoppscotch.io/view/YOUR_DOC_ID"
)

Include the relevant URL in your request to the agent so it can pass the right URL for each project.

Without a document URL, a tool call returns an error.

For compatible self-hosted deployments, these optional settings change where the server reads published docs:

For a self-hosted deployment using the same /v1/published-docs route, set both values to that deployment's viewer origin and backend /v1 URL.

Per-call doc_url values must match the configured viewer origin.

MCP tools

Manual MCP client setup

These configurations start a stdio server without selecting a project.

Give your agent the published URL for the project you are working on; it passes that URL as doc_url when calling tools.

The server normally prints nothing in a terminal because it exchanges protocol messages over stdin/stdout.

The examples below use the uv installation.

If you use Docker, replace the executable with:

{
  "command": "docker",
  "args": [
    "run",
    "--rm",
    "-i",
    "ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest"
  ]
}

Codex

Add this to ~/.codex/config.toml or a project .codex/config.toml:

[mcp_servers.hoppscotch_docs]
command = "hoppscotch-public-docs-mcp"

Run:

codex mcp list

See the Codex MCP guide.

Claude Code

claude mcp add --scope user --transport stdio hoppscotch-docs -- hoppscotch-public-docs-mcp
claude mcp get hoppscotch-docs

See the Claude Code MCP guide.

For Claude Desktop, edit ~/Library/Application Support/Claude/claude_desktop_config.json on macOS or %APPDATA%\Claude\claude_desktop_config.json on Windows, then fully restart the app:

{
  "mcpServers": {
    "hoppscotch-docs": {
      "command": "hoppscotch-public-docs-mcp"
    }
  }
}

Use the command's absolute path if Claude Desktop cannot find it.

See the MCP Python SDK host guide.

Google Antigravity

In the IDE, open:

MCP Servers → Manage MCP Servers → View raw config

In Antigravity CLI, edit ~/.gemini/config/mcp_config.json or .agents/mcp_config.json in a workspace:

{
  "mcpServers": {
    "hoppscotch-docs": {
      "command": "hoppscotch-public-docs-mcp"
    }
  }
}

See the Antigravity MCP guide.

GitHub Copilot

For Copilot in VS Code, create .vscode/mcp.json in your project or use MCP: Open User Configuration:

{
  "servers": {
    "hoppscotch-docs": {
      "type": "stdio",
      "command": "hoppscotch-public-docs-mcp"
    }
  }
}

Use Copilot Chat Agent mode and enable the server in its tools picker.

For Copilot CLI:

copilot mcp add hoppscotch-docs -- hoppscotch-public-docs-mcp
copilot mcp get hoppscotch-docs

The CLI also accepts a portable ~/.copilot/mcp-config.json with a top-level mcpServers object. VS Code's .vscode/mcp.json uses servers.

See VS Code's MCP configuration reference and the Copilot CLI MCP guide.

HTTP transport

To run an HTTP server locally with Docker:

docker run --rm \
  -p 127.0.0.1:8000:8000 \
  ghcr.io/kidixdev/hoppscotch-public-docs-mcp:latest \
  --http \
  --host 0.0.0.0

Connect a Streamable HTTP MCP client to:

http://127.0.0.1:8000/mcp

Pass doc_url to each tool call.

For a local Python process:

hoppscotch-public-docs-mcp --http

Develop

uv run python -m unittest -v
uv run hoppscotch-public-docs-mcp --check https://api-docs.hoppscotch.io/view/YOUR_DOC_ID

Build the Docker image locally:

docker build -t hoppscotch-public-docs-mcp .

License

This project is licensed under MIT.