# Documentation for AI agents

Read the same Rumata guides through JSON, Markdown, or a read-only MCP server.

Source: https://docs.rumata.dev/guides/agents
Reviewed: 2026-09-06

## Before you start

- An HTTP client, or an MCP client with Streamable HTTP support.
- Use the documentation site’s current origin for the endpoints below.

<a id="start"></a>

## Choose your access method

| Interface | Use it for |
| --- | --- |
| /api/docs | Browse the document catalog as JSON. |
| /api/docs/{slug} | Read a complete guide as JSON. |
| /api/search?q=workflow | Search titles, summaries, sections, and content. |
| /api/openapi.json | Discover the JSON API contract. |
| /llms.txt | Find machine-readable documentation entry points. |
| /llms-full.txt | Read the full corpus as Markdown text. |
| /mcp | Connect an MCP client over Streamable HTTP. |

These interfaces expose public documentation. They do not read your Rumata account, run workflows, change projects, or provide authenticated product API access. A documentation MCP connection is not a Rumata workspace connection.

<a id="audience"></a>

## Choose the right depth

Guides have shared walkthrough sections and optional technical sections. JSON returns both by default. Add audience=general for the walkthrough only, or audience=technical for the walkthrough plus technical detail. This preserves context for developers instead of making a separate, inconsistent manual.

```bash
DOCS_ORIGIN="https://docs.rumata.dev"
curl --fail "$DOCS_ORIGIN/api/docs"
curl --fail "$DOCS_ORIGIN/api/docs/workflows?audience=technical"
curl --fail "$DOCS_ORIGIN/api/search?q=storage&limit=5"
```

> **Use the available origin**
> If you are viewing a preview or an alternate deployment URL, substitute that origin until docs.rumata.dev is connected. Relative links on this page use the site you are currently reading.

<a id="mcp-connect"></a>

## Connect through MCP

In your agent client, add a remote MCP server using this site’s /mcp URL and Streamable HTTP transport. The public documentation server does not require a Rumata API key. Client-specific configuration formats differ; use the remote-server settings documented by your client.

```json
{
  "mcpServers": {
    "rumata-docs": {
      "type": "http",
      "url": "https://docs.rumata.dev/mcp"
    }
  }
}
```

The snippet is a common configuration shape, not a universal client format. The endpoint is the important value. After connection, ask the client to list tools and read the getting-started guide.

<a id="tools"></a>

## Available documentation tools

| Tool | Arguments and result |
| --- | --- |
| search_docs | query (required), limit (optional), audience (optional). Returns matching guide sections and links. |
| get_doc | slug (required), section (optional), audience (optional). Returns the selected guide, or one section of it. |
| list_docs | No arguments. Returns the document catalog. |

MCP resources also expose each guide as Markdown. Use resources/list to discover them and resources/read with the returned URI. Tool results include canonical links that you can cite to a user.

<a id="agent-behavior"></a>

## Use the docs responsibly

- [Read the guide](https://docs.rumata.dev/guides/controls-home-account#navigation) and cite the relevant section when explaining product behavior.
- Check the actual product state before deciding a resource is available or a workflow succeeded.
- Treat examples as examples; replace illustrative schemas and URLs with verified project values.
- Never interpret documentation as authorization to publish, delete, spend, or change permissions.
- Ask a person to resolve a business decision when the guide cannot determine the intended behavior.

## Related guides

- [Set up your account](https://docs.rumata.dev/guides/getting-started)
- [How Rumata fits together](https://docs.rumata.dev/guides/architecture)
- [Workflows](https://docs.rumata.dev/guides/system-explorer-workflows)
- [Rumata, in plain language](https://docs.rumata.dev/guides/glossary)