> ## Documentation Index
> Fetch the complete documentation index at: https://heybtw.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# get_guide

> Fetch a heyBTW workflow or guide: how to do a job step by step, such as loading the first events, recording a guest list or following up after an event.

get\_guide is the canonical source for workflow and guide text. Called with no name it lists every workflow and guide. Called with a name it returns that one's text and version, the same text the prompt or resource serves. It reads no workspace data and changes nothing.

Reach for it when the user asks how to do a job ("set up heyBTW", "record this guest list", "write the follow-up") and when a client shows neither prompts nor resources.

Follows the [heyBTW MCP rules](https://heybtw.com/docs/mcp/rules.md).

## When to use it

* "Set up heyBTW."
* "How do I get my past events in?"
* "What does sourced mean in this answer?"
* "Which workflows does heyBTW have?"

## Parameters

| Parameter | Type | Required | Notes |
| - | - | - | - |
| `name` | string | No | A workflow or guide name from the list below. Omit it to list them all. |
| `event` | string | No | For a workflow that runs on one event: the event's name or `channel_id`. |
| `contract_version` | string | No | Omit for v1, the only version advertised. |

## What it serves

| Name | Kind | What it is |
| - | - | - |
| `onboard_events` | workflow | A new workspace's first session: load upcoming and past events from what the user already has. |
| `record_roster` | workflow | Put one event's guests into heyBTW from its link and its guest list. |
| `next_event_standup` | workflow | Where one event stands today, as five lines for the team channel. Reads only. |
| `invite_sprint` | workflow | Fill one event's RSVPs before it runs. |
| `debrief` | workflow | The days just after one event: who met whom, what was said, which follow-ups are accepted. |
| `follow_through` | workflow | From the third day after: who has not been followed up, by owner. |
| `format_attendee_list` | workflow | Turn an attendee list that is not a table into the CSV record\_signups takes. |
| `event-follow-up` | guide | How to write the immediate follow-up after an event. |
| `crm-join` | guide | How to join heyBTW to any CRM through the user's own connector or an export. |
| `attribution-definitions` | guide | What each attribution word in a heyBTW answer means. |

[Prompts and resources](https://heybtw.com/docs/mcp/prompts-and-resources.md) describes each one, with its arguments and windows.

## Response

With no `name`, `data` holds one row per workflow or guide:

| Field | Meaning |
| - | - |
| `name` | The name to pass back. |
| `kind` | `workflow` or `guide`. |
| `title` | A short title. |
| `description` | What it does and when it runs. |
| `applies_to` | For a workflow, the event windows it runs in (`pre_event`, `sprint`, `event_week`, `wind_down`, `wrapped`). Null for a guide. |
| `version` | The text's version number. |

With a `name`, `data[0]` carries the same fields without `description`, plus `text`: the full workflow or guide.

A list call, trimmed here to two of its ten rows and shown without `query_time_ms` and `metadata`:

```json theme={null}
{
  "tool": "get_guide",
  "result_count": 10,
  "data": [
    {
      "name": "record_roster",
      "kind": "workflow",
      "title": "Record roster",
      "description": "Put one event's guests into heyBTW: create or find the collab from its link, record who registered from the platform's guest export, mark only the people who attended, and check the counts. For an event before or after it runs.",
      "applies_to": ["pre_event", "sprint", "event_week", "wind_down", "wrapped"],
      "version": 7
    },
    {
      "name": "event-follow-up",
      "kind": "guide",
      "title": "Event follow-up guide",
      "description": "How to write the immediate follow-up after an event and build the list to send it to: claim only what the evidence supports for each person, state the basis, context first, in the host's voice.",
      "applies_to": null,
      "version": 1
    }
  ],
  "status": "ok",
  "gaps": []
}
```

Versions change as the workflows improve. Read the version from the response and never assume one.

## Rules the agent must follow

* Follow a workflow's text as served. It is the manual for that job.
* A workflow reads first, proposes in the conversation and writes only what the user accepts.
* A workflow run outside its `applies_to` windows says how far the event is and hands off.

## Errors and gaps

* `entity_not_found`: no workflow or guide has that `name`. The error's `what_to_do` lists the valid names.
* `rate_limit_exceeded`: wait for `Retry-After`. See [Limits and errors](https://heybtw.com/docs/mcp/limits-and-errors.md).

## Related

* [Prompts and resources](https://heybtw.com/docs/mcp/prompts-and-resources.md): the same workflows and guides, as your client shows them.
* [Your first session](https://heybtw.com/docs/mcp/first-session.md): what "Set up heyBTW" does.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.