> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mirage.strukto.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Docs MCP Server

> Search and read the published Mirage documentation from an MCP client.

Connect your coding agent to `https://docs.mirage.strukto.ai/mcp` to search
current Mirage documentation and retrieve full pages. Mintlify hosts this
public HTTP MCP endpoint; no account or API key is required.

The docs server reads the published website. To work with your mounted files,
connect to a [workspace MCP server](/home/access/mcp) as well. The docs endpoint
has no access to your workspace, mounts, or credentials.

## Connect

For Claude Code:

```bash theme={null}
claude mcp add --transport http mirage-docs https://docs.mirage.strukto.ai/mcp
```

For clients with an `mcpServers` configuration, add an HTTP server:

```json theme={null}
{
  "mcpServers": {
    "mirage-docs": {
      "type": "http",
      "url": "https://docs.mirage.strukto.ai/mcp"
    }
  }
}
```

Ask your agent to use `mirage-docs` to find the S3 setup instructions or explain
Mirage mount modes, then read the matching page before proposing code.

## Available Tools

| Tool | Purpose |
| - | - |
| `search_mirage` | Search the docs for a question; returns excerpts and page links. |
| `query_docs_filesystem_mirage` | Read documentation pages with commands such as `head`, `cat`, `rg`, and `tree`. |
| `submit_feedback` | Send a documentation problem to the docs team. This tool writes feedback; invoke it only when you intend to send a report. |

Search first to discover page paths. A result at `/home/setup/s3` can be read
with `head -100 /home/setup/s3.mdx` through `query_docs_filesystem_mirage`.
These commands operate on the documentation filesystem only.

## Verify the Deployment

From a Mirage checkout:

```bash theme={null}
python3 scripts/check_docs_mcp.py --config-only
python3 scripts/check_docs_mcp.py
```

The first command validates the local docs configuration without network access.
The second initializes MCP, discovers its tools, retrieves the installation
page, and checks that search returns its canonical link. It does not submit
feedback. Pull requests run the local check; a daily and manually dispatchable
GitHub Actions job checks the deployed endpoint.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.