{"schemaVersion":"1","contentVersion":"2026-11-01.13","slug":"agents","title":"Documentation for AI agents","summary":"Read the same Rumata guides through JSON, Markdown, or a read-only MCP server.","category":"Go deeper","minutes":8,"prerequisites":["An HTTP client, or an MCP client with Streamable HTTP support.","Use the documentation site’s current origin for the endpoints below."],"sections":[{"id":"start","title":"Choose your access method","blocks":[{"type":"table","headers":["Interface","Use it for"],"rows":[["/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."]]},{"type":"paragraph","text":"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."}]},{"id":"audience","title":"Choose the right depth","blocks":[{"type":"paragraph","text":"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."},{"type":"code","language":"bash","text":"DOCS_ORIGIN=\"https://docs.rumata.dev\"\ncurl --fail \"$DOCS_ORIGIN/api/docs\"\ncurl --fail \"$DOCS_ORIGIN/api/docs/workflows?audience=technical\"\ncurl --fail \"$DOCS_ORIGIN/api/search?q=storage&limit=5\""},{"type":"note","title":"Use the available origin","text":"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."}]},{"id":"mcp-connect","title":"Connect through MCP","blocks":[{"type":"paragraph","text":"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."},{"type":"code","language":"json","text":"{\n  \"mcpServers\": {\n    \"rumata-docs\": {\n      \"type\": \"http\",\n      \"url\": \"https://docs.rumata.dev/mcp\"\n    }\n  }\n}"},{"type":"paragraph","text":"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."}]},{"id":"tools","title":"Available documentation tools","blocks":[{"type":"table","headers":["Tool","Arguments and result"],"rows":[["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."]]},{"type":"paragraph","text":"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."}]},{"id":"agent-behavior","title":"Use the docs responsibly","blocks":[{"type":"list","items":["[Read the guide](/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."]}]}],"technical":[],"related":["getting-started","architecture","system-explorer-workflows","glossary"],"sources":["Documentation API and MCP implementation in this package","https://modelcontextprotocol.io/specification/2025-11-25/basic/transports"],"updated":"2026-09-06","audience":"general","media":[],"video":null,"url":"https://docs.rumata.dev/guides/agents"}