get_guide

Preview

This feature is in preview and is subject to change.

Load a Guide by UUID. Find a guide's UUID with list_guides or through the entry points get_query_guide, get_dive_guide, and get_flight_guide.

Description

The get_guide tool returns a guide's full markdown content plus its metadata and references. Guides are identified by UUID, consistent with Dives and Flights. Pass version to read a specific historical version; by default the current version is returned.

Input parameters

Parameter	Type	Required	Description
uuid	string	Yes	The guide's UUID, as returned by list_guides or a previous mutation.
version	integer	No	Version number to read. Defaults to the current version.

Output

On success, the tool returns the guide as a plain-text document rather than a JSON object: the title, a metadata line (UUID, topic, version, access level), the description, the full markdown content, and a references footer. The response is mirrored into structured content as:

{
  "text": string  // The rendered guide document
}

On failure, the tool returns a structured error:

{
  "success": false,
  "error": string
}

Example usage

Read a guide found through the topic overview:

How should I calculate MRR for our billing data?

The assistant calls get_query_guide or list_guides to find the relevant guide's UUID, then loads it:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Read a specific historical version:

{
  "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "version": 2
}

Success response example

MRR and ARR Definitions
uuid: a1b2c3d4-e5f6-7890-abcd-ef1234567890 · topic: revenue-billing · v3 · organization

How monthly and annual recurring revenue are calculated

# MRR and ARR Definitions

MRR is calculated as...

## References
- catalog md:billing main.subscriptions

Related

• get_query_guide — Entry point: query guidance plus a topic overview.
• list_guides — Browse the guide catalog to find a UUID.
• update_guide — Append a version to a guide.
• edit_guide_content — Make targeted in-place edits.
• Guides how-to — Step-by-step instructions for creating and managing Guides.