alarm

Sound a loud alarm on the phones paired to this roost. Pass `hatchId` and a short `message` — the phone shows that message and repeats the alarm until the person acknowledges it. Recipients are only phones paired to this roost or its workspace. There is no phone-number argument. Do not pass one, and do not try to reach any other device. Android plays alarm audio. The alarm channel bypasses Do Not Disturb after the person grants that access. iOS requests Critical Alerts and this push is sent with a critical sound at full volume. Apple has not granted the Critical Alerts entitlement (com.apple.developer.usernotifications.critical-alerts) yet, so iOS does not bypass the Ring/Silent switch until that grant. Do not tell the user the silent switch was bypassed. A claimed roost requires a paired agent session. If no phone is paired, or the phone has not allowed notifications, the call fails and nothing is sent.

Argument	Type	Description
hatchId	string	Hatch id from the original hatch response.
message*	string	Short text shown on the alarm. The phone repeats until the person acknowledges it.
tenantId	string	Legacy alias for `hatchId`.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "message"
  ],
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "message": {
      "type": "string",
      "maxLength": 180,
      "description": "Short text shown on the alarm. The phone repeats until the person acknowledges it."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional paired session token from poll_pairing (when Authorization headers are unavailable)."
    }
  }
}

auth

Put a sign-in screen in front of any roost so visitors must authenticate. Works on free, workspace, and forever hatches. Pass `hatchId` plus an `action`: • `enable` with `mode: "password"` and a `password` → ONE shared site password (everyone uses the same one). Best for a private demo or staging link. • `setPassword` with a new `password` → rotate the shared password. • `disable` → remove the login and serve the site publicly again. • `status` → report whether auth is on and which mode. Returns `{ enabled, mode, loginUrl }`. The sign-in screen lives at `/__roost/login`. Prefer `password` mode; `useraccounts` is unavailable (per-hatch databases are no longer provisioned).

destructive

Argument	Type	Description
mode	string	`password` = one shared site password (recommended). `useraccounts` is unavailable. Required when `action` is `enable`.
action	string	What to do. Defaults to `status`.
hatchId	string	Hatch id from the original hatch response.
password	string	The shared site password (password mode only). Required for `enable` (password mode) and `setPassword`.
tenantId	string	Legacy alias for `hatchId` from the original hatch response.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

await_decision

Create a human-in-the-loop review on the live artifact. Default options: Approve / Request changes / Reject. Reviewers see a Review required chip → modal. Request changes is non-terminal: webhook or poll returns changes_requested, then call continue_decision after regenerating. Optional timeoutSeconds and maxIterations (default 5). If the page has interactive controls (sliders/forms), the hatch HTML MUST expose window.__VR_HITL_GET_SETTINGS__ so the review can attach those assumptions as JSON. When the user integrates n8n, Temporal, CI, or any external workflow, pass webhookUrl (MCP opens the review; the platform POSTs each transition to that URL — prefer webhook over poll_decision for automation). See PARTNER-WEBHOOKS.md for event payloads.

Argument	Type	Description
title	string	Modal heading (default: Finish your review).
policy	string	Policy stored on the decision when the hatch has none set. Does not by itself skip creating the review — `await_decision` always opens or reuses one.
hatchId	string	Hatch id from the original hatch response.
options	array	Radio choices (default Approve, Request changes, Reject). Labels are classified into approve / reject / changes_requested.
tenantId	string	Legacy alias for `hatchId`.
contextUrl	string
webhookUrl	string

catalog

List VibeRooster features the user can pay for (Pin $4.99/yr, Pack $4.99/yr/GB, Roost $259/mo, Roost Audit $459/mo, custom domain +$29/mo) with Stripe Price ids, amounts, and feature lists. Call this before `checkout` if you don't already know the grant. Returns `{ items: [{ grant, title, description, features, priceId, amountCents, scope }] }`.

read-only

Argument	Type	Description
grant	string	Optional filter. `publish` = Pin. `workspace_coin_pack` = Pack. `workspace_subscription` = Roost. `agentic_pro` = Roost Audit. `custom_domain` = custom domain add-on.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "grant": {
      "enum": [
        "publish",
        "record",
        "credit_topup",
        "workspace_coin_pack",
        "workspace_subscription",
        "agentic_pro",
        "custom_domain"
      ],
      "type": "string",
      "description": "Optional filter. `publish` = Pin. `workspace_coin_pack` = Pack. `workspace_subscription` = Roost. `agentic_pro` = Roost Audit. `custom_domain` = custom domain add-on."
    }
  },
  "additionalProperties": false
}

checkout

Create a Stripe Checkout Session so the user can pay for a VibeRooster feature in this chat. Returns `{ checkoutUrl, sessionId, grant, amountCents }` — ALWAYS show checkoutUrl to the user (open it / paste it). After they pay, call `poll_checkout` with sessionId until status is `complete`. The webhook applies the grant (Pin, Pack, Roost, Roost Audit, custom domain). Required ids by grant: `publish` / `record` / `credit_topup` / `workspace_coin_pack` (Pack) → hatchId; `workspace_subscription` (Roost) / `custom_domain` → workspaceId (or hatchId in that workspace); `agentic_pro` (Roost Audit) → orgId or workspaceId/hatchId attached to the org. Do not use Stripe MCP (mcp.stripe.com) for VibeRooster features — that would charge a different Stripe account. Hatch `checkout` stamps hatch/workspace/org metadata the webhook expects.

Argument	Type	Description
grant*	string	`publish` = Pin ($4.99/yr, 1-year keep; also overage after 10 subscription Pins). `workspace_subscription` = Roost ($259/mo). `agentic_pro` = Roost Audit ($459/mo). `workspace_coin_pack` = Pack ($4.99/yr per GB). `custom_domain` = +$29/mo on Roost / Roost Audit.
orgId	string	Organization id. Required for Roost Audit (`agentic_pro`) unless derivable from workspace/hatch.
hatchId	string	Hatch id from hatch/lookup. Required for publish (Pin), record, credit_topup, and Pack.
priceId	string	Optional Stripe Price id from `catalog`. Omit to use the mapped default for this grant.
quantity	integer	Line-item quantity (Pack GB, custom domain slots). Default 1.

continue_decision

After poll_decision returns status changes_requested, regenerate, then call this to reopen the same decision as pending_review for the next human round. Only decisionId is required (hatchId is read from the decision).

Argument	Type	Description
title	string
hatchId	string	Hatch id from the original hatch response.
tenantId	string	Legacy alias for `hatchId`.
decisionId*	string
agentOutput	string	Summary of the revised output for the conversation transcript.
sessionToken	string
timeoutSeconds	integer	Optional new timeout for this review round.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "decisionId"
  ],
  "properties": {
    "title": {
      "type": "string"
    },
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "decisionId": {
      "type": "string"
    },
    "agentOutput": {
      "type": "string",
      "description": "Summary of the revised output for the conversation transcript."
    },
    "sessionToken": {
      "type": "string"
    },
    "timeoutSeconds": {
      "type": "integer",
      "maximum": 604800,
      "minimum": 60,
      "description": "Optional new timeout for this review round."
    }
  }
}

convert

Atomically rename a roost's URL, change gallery listing, mark or unmark Promo, or bind a custom domain (Roost / Roost Audit after checkout grant custom_domain). Pass `hatchId` plus at least one of `newPreferredSlug`, `galleryListed`, `promo`, or `customDomain`. Do NOT call `hatch` again to rename or to change Promo — that creates a second site. Optional `promo` (boolean). `true` lists this hatch on the public carousel even when its tier would hide it, if the hatch is active, has a public slug, and is not expired, and forces the Powered By chip on. A password still keeps it off the carousel. `false` unmarks Promo and returns the normal carousel and chip rules. Omit `promo` to leave the flag unchanged. `promo` alone is enough. Roost and Roost Audit include 10 subscription Pins. `convert` with `newTier: forever` is allowed while those slots remain. After that, call `checkout` with grant `publish` (Pin, $4.99/yr). Do not use convert to collect payment. Pins are hidden from the carousel by default; pass `galleryListed: true` to feature the site publicly. Paid Roost hatches stay off the carousel unless `promo` is true.

destructive

Argument	Type	Description
promo	boolean	Optional Promo flag. `true` lists this hatch on the public carousel even when its tier would hide it, if the hatch is active, has a public slug, and is not expired, and forces the Powered By chip on. A password still keeps it off the carousel. `false` unmarks Promo and returns the normal carousel and chip rules. Omit to leave the flag unchanged. Pass `promo` alone; no rename is required.
hatchId	string	Hatch id from the original hatch response.
newTier	string	Roost / Roost Audit may pass `forever` while subscription Pins remain (10). After the allotment, use `checkout` (grant: publish) for a paid Pin.

deploy

Replace the server-side code of an existing roost. Advanced — most agents should use `upload` (for static files) or `convert` (for renames) instead. Pass `hatchId`, `workerName`, and a full ES module `script` (text only, 1.5 MiB max).

destructive

Argument	Type	Description
policy	string	HITL policy override. `optional` does not open a review (call `await_decision`). Under `required`, may fork a sibling `{slug}-vN`. `good_effort` still auto-opens and supersedes.
script*	string	Full ES module source.
hatchId	string	Hatch id from the original hatch response.
metadata	object
tenantId	string	Legacy alias for `hatchId`.
hitlTitle	string	Modal title for auto-opened HITL.
approvalId	string	Tier-2 phone approval id from a prior deploy attempt.
webhookUrl	string	Webhook for auto-opened HITL.
workerName

get_pairing_code

Issue a pairing code + URL (TTL 10 minutes) for claiming a hatch (`hatchId`) or authorizing an agent session in a workspace (workspaceId). Reuses the active pending code for this connector session unless `forceNew: true`. For workspace pairing, show `pairingUrl` (https://mcp.theroost.dev/open/workspace-pair) as the link the user taps — it opens the Vibe Rooster app on the phone, and on a computer it opens a page that forwards into the app when the same link is opened on the phone. Do not show only `appUrl`; that viberooster:// link does nothing in a desktop chat. `appUrl` is only for an in-app QR. Do not call again until poll_pairing returns expired/completed or you intentionally rotate with forceNew.

Argument	Type	Description
hatchId	string	Hatch id from hatch response (consumer path).
forceNew	boolean	When true, invalidate any outstanding QR and mint a new code. Default false — reuse the live pending code from whoami or a prior get_pairing_code.
tenantId	string	Legacy alias for `hatchId`.
workspaceId	string	Workspace id for B2B agent pairing (partner path).

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id from hatch response (consumer path)."
    },
    "forceNew": {
      "type": "boolean",
      "description": "When true, invalidate any outstanding QR and mint a new code. Default false — reuse the live pending code from whoami or a prior get_pairing_code."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "workspaceId": {
      "type": "string",
      "description": "Workspace id for B2B agent pairing (partner path)."
    }
  }
}

hatch

Create a NEW site (a 'roost') and return its public URL in one call. Returns `{ hatchId, slug, url, apex, promo, uploads? }` — show `url` to the user and remember `hatchId`. NEVER call hatch twice for the same site — use `convert` to rename, change tier, or set Promo, and `upload`/`deploy` for content updates. Pick `apex` from the user's intent (homes / estate / land / wedding / events / agency / site / omit for theroost.dev). Do NOT invent other apexes. Ways to call it: • `html` (PREFERRED for n8n / a single review page) → one self-contained HTML string published at /. Do not also pass site/manifest/script. • Omit `html`, `manifest`, `site`, and `script` → a placeholder page is published instantly. • Pass `manifest` (file list with sizes) → returns presigned `uploads[]`; you PUT each file's bytes directly to its URL. PREFER this for any project with images, fonts, video, or more than a few KB of HTML. • Pass `site` (inline files map) → small text-only sites only. File keys must be paths like `index.html` (n8n may send `index`; that is accepted as `index.html`). • Pass `script` → advanced: full server-side code as one ES module (1.5 MiB max, text only — NEVER base64-embed binaries here). Optional `promo` (boolean). `true` lists this hatch on the public carousel even when its tier would hide it, if the hatch is active, has a public slug, and is not expired, and forces the Powered By chip on. A password still keeps it off the carousel. `false` unmarks Promo and returns the normal carousel and chip rules. Omit `promo` to leave an existing hatch unchanged, or to create one under the normal rules. To change Promo later, call `convert` with `promo` — do not hatch again. Do not send empty strings for optional fields (hatchId, preferredSlug, apex, html, site). Omit them.

Argument	Type	Description
apex	string	Specialty hostname apex for the live URL (`https://{slug}.{apex}`). Choose from user intent: theroost.homes (residential listing), theroost.estate (commercial/luxury), theroost.land (land/parcels), theroost.wedding (wedding RSVP), theroost.events (conference/meetup), theroost.agency (pitch/portfolio), theroost.site (generic short-lived niche). Omit for theroost.dev. Never pass theroost.rentals (reserved).

list

List every hatch in a workspace. Returns `{ workspaceId, name, count, hatches: [{ hatchId, slug, url, apex, kind, tier, state, expiresAt, createdAt, promo, pageviews24h, visitors24h }] }`. `promo` is true when that hatch is marked Promo. Use this when you lost hatchIds, before hatching (so you do not create a duplicate), or when the user asks what is live in the workspace. `workspaceId` is optional when this connector is already paired to a workspace. Requires a workspace-paired session — call `whoami`, then `get_pairing_code` with workspaceId if unidentified.

read-only

Argument	Type	Description
workspaceId	string	Workspace to list. Omit when the session is already scoped to a workspace.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "description": "Workspace to list. Omit when the session is already scoped to a workspace."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional paired session token from poll_pairing (when Authorization headers are unavailable)."
    }
  },
  "additionalProperties": false
}

list_templates

List HTML templates and explorable archetypes from the public template catalog (https://github.com/VibeRooster/hatch-mcp/tree/main/templates). Returns `{ repo, browse, templates: [{ name, title, description, url, prompt, referenceUrl? }] }`. `prompt` is the suggested text for the user. `referenceUrl` is the live example when one is published. Descriptions come from each file's frontmatter. Open `url` for the HTML and hatch notes — this tool does not return the file body. Add a template by opening a pull request that adds `templates/<name>.md` on that repo. No arguments.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

lookup

Resolve a roost by `slug` or `hatchId`. Returns a compact view `{ hatchId, slug, url, apex, tier, state, expiresAt, customDomain, galleryListed, promo, pageviews24h, visitors24h, topPaths, topCountries, topReferrers }`. `promo` is true when the hatch is marked Promo (listed on the public carousel even when its tier would hide it, if active, with a public slug, and not expired; Powered By chip forced on). A password still keeps a Promo hatch off the carousel. Use this to recover state across turns when the user mentions their site without giving you the hatchId. To see every hatch in a workspace, use `list` instead.

read-only

Argument	Type	Description
slug	string	Hostname label (without the apex domain)
hatchId	string	Hatch id from the original hatch response.
tenantId	string	Legacy alias for `hatchId`.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "slug": {
      "type": "string",
      "description": "Hostname label (without the apex domain)"
    },
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    }
  },
  "additionalProperties": false
}

poll_approval

Poll a pending Tier-2 phone approval. Returns the result once the owner approves or denies on their phone.

read-only

Argument	Type	Description
hatchId	string	Hatch id from the original hatch response.
tenantId	string	Legacy alias for `hatchId`.
approvalId*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "approvalId"
  ],
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "approvalId": {
      "type": "string"
    }
  }
}

poll_checkout

Long-poll a Checkout Session from `checkout` (~18s). Returns `{ status: open|complete|expired, grantApplied, roostUrl, tier }`. If still `open`, tell the user to finish paying at checkoutUrl and call poll_checkout again. When `grantApplied` is true, the webhook has (or is about to) apply the grant — call `lookup` to confirm forever/tier.

read-only

Argument	Type	Description
sessionId*	string	Checkout Session id (`cs_…`) from `checkout`.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "sessionId"
  ],
  "properties": {
    "sessionId": {
      "type": "string",
      "description": "Checkout Session id (`cs_…`) from `checkout`."
    }
  },
  "additionalProperties": false
}

poll_decision

Long-poll (~20s) until the decision leaves pending_review. Only decisionId is required (hatchId is read from the decision). Returns changes_requested (regenerate + continue_decision), approved, rejected, timeout_exceeded, max_iterations_exceeded, not_found, or still pending_review (call again). Includes comment, settings, conversation, iteration. Polling never writes: timeout_exceeded only ever means the await_decision timeoutSeconds deadline passed before the human submitted.

read-only

Argument	Type	Description
hatchId	string	Hatch id from the original hatch response.
tenantId	string	Legacy alias for `hatchId`.
decisionId*	string

Input schema (JSON)

{
  "type": "object",
  "required": [
    "decisionId"
  ],
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "decisionId": {
      "type": "string"
    }
  }
}

poll_pairing

Poll for pairing completion (Device-Grant style). Waits up to ~20s for phone approval before returning. Statuses: pending / completed / expired / not_found. On completed, store sessionToken, refreshToken, and grantId — refreshToken renews access for up to 7 days without re-pairing. When sessionToken expires (~1h), call refresh_session. The server also binds tokens to this connector session. Pass hatchId when known. Device claim ≠ forever billing upgrade.

read-only

Argument	Type	Description
code*	string	Pairing code from get_pairing_code / whoami.
hatchId	string	Optional hatch id — improves lookup after the phone has approved.
tenantId	string	Legacy alias for `hatchId`.
workspaceId	string	Optional workspace id — for B2B pairing flows.

Input schema (JSON)

{
  "type": "object",
  "required": [
    "code"
  ],
  "properties": {
    "code": {
      "type": "string",
      "description": "Pairing code from get_pairing_code / whoami."
    },
    "hatchId": {
      "type": "string",
      "description": "Optional hatch id — improves lookup after the phone has approved."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "workspaceId": {
      "type": "string",
      "description": "Optional workspace id — for B2B pairing flows."
    }
  }
}

refresh_session

Renew a short-lived access token (~1h) using the refreshToken from poll_pairing. The grant (and refresh capability) lasts up to 7 days — after that, re-pair via get_pairing_code. Each refresh rotates the refreshToken; store the new one. Requires the same connector session (MCP-Session-Id) as when you paired — if fingerprint mismatches, re-pair.

Argument	Type	Description
hatchId	string	Hatch id (consumer path).
tenantId	string	Legacy alias for `hatchId`.
workspaceId	string	Workspace id (B2B path).
refreshToken*	string	Opaque refresh token from poll_pairing (vr1.{grantId}.{secret}).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "refreshToken"
  ],
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id (consumer path)."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "workspaceId": {
      "type": "string",
      "description": "Workspace id (B2B path)."
    },
    "refreshToken": {
      "type": "string",
      "description": "Opaque refresh token from poll_pairing (vr1.{grantId}.{secret})."
    }
  }
}

rename_org

Rename the organization and/or workspace after Roost or Roost Audit has been paid. Pass `orgName`, `workspaceName`, or both. Requires a workspace-paired session. Fails on free Hatch workspaces — call `checkout` with grant `workspace_subscription` (Roost) or `agentic_pro` (Roost Audit) first, then `poll_checkout`. Does not rename a hatch URL; use `convert` for that. Returns `{ workspaceId, workspaceName, orgId, orgName, plan }`.

Argument	Type	Description
orgName	string	New organization display name (1–80 characters). Omit to leave the org name unchanged.
workspaceId	string	Workspace to rename. Omit when the session is already scoped to a workspace.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).
workspaceName	string	New workspace display name (1–80 characters). Omit to leave the workspace name unchanged.

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "orgName": {
      "type": "string",
      "description": "New organization display name (1–80 characters). Omit to leave the org name unchanged."
    },
    "workspaceId": {
      "type": "string",
      "description": "Workspace to rename. Omit when the session is already scoped to a workspace."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional paired session token from poll_pairing (when Authorization headers are unavailable)."
    },
    "workspaceName": {
      "type": "string",
      "description": "New workspace display name (1–80 characters). Omit to leave the workspace name unchanged."
    }
  },
  "additionalProperties": false
}

share

Issue a signed, expiring guest view URL for any tier (`?vt=…`). Use for private run reports without the shared site password. Returns `{ url, viewToken, expiresAt }`.

Argument	Type	Description
hatchId	string	Hatch id from the original hatch response.
tenantId	string	Legacy alias for `hatchId`.
sessionToken	string
expiresSeconds	integer

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Hatch id from the original hatch response."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "sessionToken": {
      "type": "string"
    },
    "expiresSeconds": {
      "type": "integer",
      "maximum": 604800,
      "minimum": 300
    }
  }
}

squawk_poll_access

Poll an admit request opened by squawk_request_access. Uses the same Hatch pairing session. While pending, returns `{ status: "pending", expiresAt }`. After the owner approves, returns the member, the rin_ token once, roostId, and mcpServers.squawk. Install the returned mcpServers.squawk block into this MCP client immediately. Use the url and the Authorization header exactly as returned. Do not print, log, or paste the rin_ token into chat. After it is installed, further roost traffic uses the Squawk tools (squawk, squawk_whoami, squawk_read, squawk_ack, squawk_watch, and the rest listed in SQUAWK-AGENT.md). A one-shot HTTP call is not a substitute. If this host cannot hot-add an MCP server mid-turn, write that config where this client loads MCP servers and use the Squawk tools on the next turn. Do not invent a Cursor API. Later polls return status approved and the member id, without the token and without mcpServers. Rejected and expired have no token. One approval admits this agent to that one roost.

Argument	Type	Description
requestId*	string	requestId from squawk_request_access.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "requestId"
  ],
  "properties": {
    "requestId": {
      "type": "string",
      "description": "requestId from squawk_request_access."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional paired session token from poll_pairing (when Authorization headers are unavailable)."
    }
  }
}

squawk_request_access

Ask the roost owner to admit this agent to Squawk. Uses the caller's Hatch pairing session (Authorization: Roost, the bound connector session, or sessionToken from poll_pairing). Returns `{ requestId, status: "pending", expiresAt }`. The request expires 10 minutes after it is opened. Does not create a Squawk member. This tool is on Hatch, not on the Squawk server. Pass displayName and runtime. Optional roostId must match the paired roost. Optional publicKey makes the later member agent_signed.

Argument	Type	Description
roostId	string	Optional. Must match the paired roost (workspace id, or the hatch id when the session has no workspace).
runtime*	string	Agent runtime, such as claude or cursor.
publicKey	string	Optional P-256 public key.
displayName*	string	Name the owner will see on the phone.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

Input schema (JSON)

{
  "type": "object",
  "required": [
    "displayName",
    "runtime"
  ],
  "properties": {
    "roostId": {
      "type": "string",
      "description": "Optional. Must match the paired roost (workspace id, or the hatch id when the session has no workspace)."
    },
    "runtime": {
      "type": "string",
      "description": "Agent runtime, such as claude or cursor."
    },
    "publicKey": {
      "type": "string",
      "description": "Optional P-256 public key."
    },
    "displayName": {
      "type": "string",
      "description": "Name the owner will see on the phone."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional paired session token from poll_pairing (when Authorization headers are unavailable)."
    }
  }
}

upload

Add or replace files on an EXISTING roost. Pass `hatchId` plus a `manifest` listing each file's path, size, and optional content type. Returns one presigned PUT URL per file — upload bytes directly via HTTP (e.g. `curl -T file.png -H 'Content-Type: image/png' "$url"`). Files go live immediately as each PUT completes; no separate publish call is needed. Use after regenerating a dashboard locally; Hatch does not schedule regenerations.

destructive

Argument	Type	Description
policy	string	HITL policy override. `optional` does not open a review (call `await_decision`). Under `required`, may fork a sibling `{slug}-vN` instead of overwriting. `good_effort` still auto-opens and supersedes.
hatchId	string	Hatch id from the original hatch response.
manifest*	object
tenantId	string	Legacy alias for `hatchId` from the original hatch response.
hitlTitle	string	Modal title for auto-opened HITL.
webhookUrl	string	Webhook for auto-opened HITL.
sessionToken	string	Optional paired session token from poll_pairing (when Authorization headers are unavailable).

whoami

Return the caller's current identity and hatch state. Never errors when unidentified — returns a pairing path instead. After poll_pairing completes, whoami with the same hatchId should show identified:true via server-side session binding. Returns sessionExpiresAt (~1h) and grantExpiresAt (~7d). If sessionExpired:true, call refresh_session with your stored refreshToken.

read-only

Argument	Type	Description
hatchId	string	Optional hatch to check or re-pair against.
tenantId	string	Legacy alias for `hatchId`.
sessionToken	string	Optional token from poll_pairing. Pass when whoami stays unidentified after a successful pair (connectors that cannot set Authorization headers).

Input schema (JSON)

{
  "type": "object",
  "properties": {
    "hatchId": {
      "type": "string",
      "description": "Optional hatch to check or re-pair against."
    },
    "tenantId": {
      "type": "string",
      "description": "Legacy alias for `hatchId`."
    },
    "sessionToken": {
      "type": "string",
      "description": "Optional token from poll_pairing. Pass when whoami stays unidentified after a successful pair (connectors that cannot set Authorization headers)."
    }
  },
  "additionalProperties": false
}

Hatch

Try it

alarm

Hatch

Try it

alarm

Tools (24)