Rumatadocs
SupportOpen Rumata
Browse documentation

Documentation for AI agents

Open MarkdownOpen JSON

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

8 min readUpdated Sep 6, 2026

Step-by-step guidance.

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.

Choose your access method

InterfaceUse it for
/api/docsBrowse the document catalog as JSON.
/api/docs/{slug}Read a complete guide as JSON.
/api/search?q=workflowSearch titles, summaries, sections, and content.
/api/openapi.jsonDiscover the JSON API contract.
/llms.txtFind machine-readable documentation entry points.
/llms-full.txtRead the full corpus as Markdown text.
/mcpConnect 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.

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"

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.

Available documentation tools

ToolArguments and result
search_docsquery (required), limit (optional), audience (optional). Returns matching guide sections and links.
get_docslug (required), section (optional), audience (optional). Returns the selected guide, or one section of it.
list_docsNo 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.

Use the docs responsibly

  • Read the guide 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.

Open the interfaces

/api/docs/api/openapi.json/llms.txt/llms-full.txt