zaira_get_docs
Retrieve reference documentation for the Zaira Guide API and MCP server on demand.
Topics:
getting_started — how to connect via MCP or REST, first queries
endpoints — full REST endpoint reference with parameters
mcp_tools — MCP tool reference with when-to-use guidance and a routing matrix
schema — the tool entry schema
errors — error taxonomy for REST (RFC 9457) and MCP (JSON-RPC)
Call with no topic to get an index of available topics.
Returns: the requested topic as a Markdown-KV block. With no topic, returns an index listing all available topics with short descriptions; call again with the relevant topic for the full content.
Examples (topic selection):
"How do I call the REST API?" → {topic: "getting_started"}
"What parameters does /tools accept?" → {topic: "endpoints"}
"What fields are in a tool entry?" → {topic: "schema"}
"What error shapes do I handle, and what are the recovery steps?" → {topic: "errors"}
"Which MCP tool fits my task?" → {topic: "mcp_tools"}
Edge cases:
No topic argument is valid — you get the index. This is the deferred-loading path; don't load every topic at once.
Topic must match the enum exactly (lowercase, underscore). "getting-started" with a hyphen is rejected as an unknown parameter.
Risk: read-only, closed-world, idempotent — no state change possible.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| topic | No | Optional topic. One of: getting_started, endpoints, mcp_tools, schema, errors. Omit to get an index of available topics. |