accueil / serveurs / Dev & Code / com.viberooster/hatch
com.viberooster/hatch
serveur MCP (Model Context Protocol) · viberooster-hatch 2026-10-19+9be9a68
Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur.
Est-ce que com.viberooster/hatch est sûr ?
Au dernier audit MCP Hub, le serveur MCP « com.viberooster/hatch » est classé « Non encore testé ». Référencé dans l'annuaire. Seul le pentest comportemental fait foi, et il n'a pas encore été exécuté sur ce serveur. Le verdict est réévalué en continu ; consultez la fiche pour l'état à jour.
Méthode : MCP Hub analyse la description de chaque outil (couche 1) et, pour le verdict fort, exécute le serveur dans une micro-VM isolée avec leurres et réseau bloqué (couche 2). On publie des noms et des compteurs, jamais le contenu brut renvoyé par un outil.
Les 24 outils
- alarm≈ 422 tokens
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.
Paramètres, retour & exemple (4)
ParamètreshatchId· string · optionnel
Hatch id from the original hatch response.message· string · requis
Short text shown on the alarm. The phone repeats until the person acknowledges it.tenantId· string · optionnel
Legacy alias for `hatchId`.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "alarm", "arguments": {"message": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - auth≈ 453 tokens
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).
Paramètres, retour & exemple (6)
Paramètresmode· string · optionnel · password | useraccounts
`password` = one shared site password (recommended). `useraccounts` is unavailable. Required when `action` is `enable`.action· string · optionnel · enable | disable | setPassword | status
What to do. Defaults to `status`.hatchId· string · optionnel
Hatch id from the original hatch response.password· string · optionnel
The shared site password (password mode only). Required for `enable` (password mode) and `setPassword`.tenantId· string · optionnel
Legacy alias for `hatchId` from the original hatch response.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "auth", "arguments": {"mode": "password", "action": "enable", "hatchId": "texte", "password": "texte", "tenantId": "texte", "sessionToken": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - await_decision≈ 664 tokens
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.
Paramètres, retour & exemple (11)
Paramètrestitle· string · optionnel
Modal heading (default: Finish your review).policy· string · optionnel · required | good_effort | optional
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 · optionnel
Hatch id from the original hatch response.options· array · optionnel
Radio choices (default Approve, Request changes, Reject). Labels are classified into approve / reject / changes_requested.tenantId· string · optionnel
Legacy alias for `hatchId`.contextUrl· string · optionnelwebhookUrl· string · optionnel
HTTPS URL that receives a POST on every HITL transition (decision.resolved, decision.changes_requested, timeout, superseded, etc.). Prefer this over poll_decision when wiring n8n, Temporal, or other automation — MCP creates the review; the webhook delivers the outcome. Full payload: PARTNER-WEBHOOKS.md.agentOutput· string · optionnel
Optional seed of the agent’s current output into the conversation transcript.sessionToken· string · optionnelmaxIterations· integer · optionnel
Max review rounds (default 5). Requesting changes at the last iteration fails with max_iterations_exceeded.timeoutSeconds· integer · optionnel
Wall-clock timeout for this review round; omit for no timeout.
Exemple d'appel{"name": "await_decision", "arguments": {"title": "texte", "policy": "required", "hatchId": "texte", "options": [], "tenantId": "texte", "contextUrl": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - catalog≈ 247 tokens
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 }] }`.
Paramètres, retour & exemple (1)
Paramètresgrant· string · optionnel · publish | record | credit_topup | workspace_coin_pack | workspace_subscription | agentic_pro | custom_domain
Optional filter. `publish` = Pin. `workspace_coin_pack` = Pack. `workspace_subscription` = Roost. `agentic_pro` = Roost Audit. `custom_domain` = custom domain add-on.
Exemple d'appel{"name": "catalog", "arguments": {"grant": "publish"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - checkout≈ 593 tokens
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.
Paramètres, retour & exemple (7)
Paramètresgrant· string · requis · publish | record | credit_topup | workspace_coin_pack | workspace_subscription | agentic_pro | custom_domain
`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 · optionnel
Organization id. Required for Roost Audit (`agentic_pro`) unless derivable from workspace/hatch.hatchId· string · optionnel
Hatch id from hatch/lookup. Required for publish (Pin), record, credit_topup, and Pack.priceId· string · optionnel
Optional Stripe Price id from `catalog`. Omit to use the mapped default for this grant.quantity· integer · optionnel
Line-item quantity (Pack GB, custom domain slots). Default 1.tenantId· string · optionnel
Legacy alias for `hatchId`.workspaceId· string · optionnel
Workspace id. Required for Roost (`workspace_subscription`) and custom_domain.
Exemple d'appel{"name": "checkout", "arguments": {"grant": "publish"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - continue_decision≈ 270 tokens
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).
Paramètres, retour & exemple (7)
Paramètrestitle· string · optionnelhatchId· string · optionnel
Hatch id from the original hatch response.tenantId· string · optionnel
Legacy alias for `hatchId`.decisionId· string · requisagentOutput· string · optionnel
Summary of the revised output for the conversation transcript.sessionToken· string · optionneltimeoutSeconds· integer · optionnel
Optional new timeout for this review round.
Exemple d'appel{"name": "continue_decision", "arguments": {"decisionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - convert≈ 747 tokens
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.
Paramètres, retour & exemple (8)
Paramètrespromo· boolean · optionnel
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 · optionnel
Hatch id from the original hatch response.newTier· string · optionnel · free | forever
Roost / Roost Audit may pass `forever` while subscription Pins remain (10). After the allotment, use `checkout` (grant: publish) for a paid Pin.tenantId· string · optionnel
Legacy alias for `hatchId`.customDomain· string · optionnel
Customer-owned hostname. Roost / Roost Audit only, after checkout grant custom_domain (+$29/mo). Pass an empty string to clear.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).galleryListed· boolean · optionnel
Opt in (`true`) or out (`false`) of the public Barnyard carousel. Pins require `true` to appear; free is listed unless `false`. Paid Roost hatches (`tier: workspace`) are never listed by this flag. Use `promo` to list a hatch its tier would hide.newPreferredSlug· string · optionnel
New hostname label. The old slug is released atomically.
Exemple d'appel{"name": "convert", "arguments": {"promo": true, "hatchId": "texte", "newTier": "free", "tenantId": "texte", "customDomain": "texte", "sessionToken": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - deploy≈ 397 tokens
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).
Paramètres, retour & exemple (10)
Paramètrespolicy· string · optionnel · required | good_effort | optional
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 · requis
Full ES module source.hatchId· string · optionnel
Hatch id from the original hatch response.metadata· object · optionneltenantId· string · optionnel
Legacy alias for `hatchId`.hitlTitle· string · optionnel
Modal title for auto-opened HITL.approvalId· string · optionnel
Tier-2 phone approval id from a prior deploy attempt.webhookUrl· string · optionnel
Webhook for auto-opened HITL.workerName· string · requissessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "deploy", "arguments": {"script": "texte", "workerName": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - get_pairing_code≈ 364 tokens
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.
Paramètres, retour & exemple (4)
ParamètreshatchId· string · optionnel
Hatch id from hatch response (consumer path).forceNew· boolean · optionnel
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 · optionnel
Legacy alias for `hatchId`.workspaceId· string · optionnel
Workspace id for B2B agent pairing (partner path).
Exemple d'appel{"name": "get_pairing_code", "arguments": {"hatchId": "texte", "forceNew": true, "tenantId": "texte", "workspaceId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - hatch≈ 1766 tokens
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.
Paramètres, retour & exemple (18)
Paramètresapex· string · optionnel · theroost.dev | theroost.homes | theroost.estate | theroost.land | theroost.wedding | theroost.events | theroost.agency | theroost.site
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).html· string · optionnel
Self-contained HTML document (inline CSS) published at /. Preferred for n8n and other AI tools that cannot pass nested site.files maps. Mutually exclusive with site, manifest, and script.kind· string · optionnel · site | run-report
Artifact kind. Use `run-report` for agent observability / compliance run reports; default `site` for consumer sites.site· object · optionnel
Inline file map. Suitable ONLY for small text-only sites (a handful of HTML/CSS files). For anything with images or binaries, use `manifest` instead.tier· string · requis · free | forever
`free` auto-expires (default 48h; override with `ttlSeconds`). In a paid Roost workspace, hatch stores `workspace` (still expires; not carousel-listed) even if you pass `free`. `forever` is a Pin (subscription slot or paid 1-year keep) — on this connector, hatch `free` then `checkout` with grant `publish`, or convert while subscription Pins remain.promo· boolean · optionnel
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.policy· string · optionnel · required | good_effort | optional
HITL policy override for workspace-paired hatches. `optional` (default for a new Roost) does not open a review — call `await_decision` when you want one. `required` forks sibling `{slug}-vN` roosts when review is outstanding or approved. `good_effort` overwrites in place, supersedes open HITL, and auto-opens a fresh review. Inherits the stored workspace policy when omitted.script· string · optionnel
Advanced: full server-side code as one ES module. Text only, 1.5 MiB hard limit. NEVER embed images/fonts/binaries here — use `manifest` instead.hatchId· string · optionnel
Optional id to reuse. Omit entirely to auto-generate. Do not send an empty string (n8n: leave this field unmapped). Lowercase letters, numbers, and hyphens only; 1–50 chars; must start and end alphanumeric.manifest· object · optionnel
PREFERRED for sites with assets. List every file you want served, with its byte size and optional MIME type. The response includes one presigned PUT URL per file; upload bytes directly via HTTP (e.g. `curl -T file.png -H 'Content-Type: image/png' "$url"`).tenantId· string · optionnel
Legacy alias for `hatchId`.hitlTitle· string · optionnel
Modal title for auto-opened HITL.ttlSeconds· integer · optionnel
Free-tier TTL in seconds (1h–7d). Default 172800 (48h). Ignored for `forever`.webhookUrl· string · optionnel
Webhook for auto-opened HITL under workspace policy (see PARTNER-WEBHOOKS.md).workspaceId· string · optionnel
Workspace to hatch into (B2B). Omit when this connector is already paired to a workspace — the session supplies it. Do not hatch twice for a site that already exists in the workspace; call `list` first.preferredSlug· string · optionnel
Hostname label. Omit for a friendly auto-name (e.g. swift-falcon-7a).tosAcceptedAt· string · optionnel
ISO-8601 timestampscriptMetadata· object · optionnel
Exemple d'appel{"name": "hatch", "arguments": {"tier": "free"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list≈ 286 tokens
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.
Paramètres, retour & exemple (2)
ParamètresworkspaceId· string · optionnel
Workspace to list. Omit when the session is already scoped to a workspace.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "list", "arguments": {"workspaceId": "texte", "sessionToken": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - list_templates≈ 220 tokens
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.
Paramètres, retour & exemple (0)
Exemple d'appel{"name": "list_templates", "arguments": {}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - lookup≈ 290 tokens
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.
Paramètres, retour & exemple (3)
Paramètresslug· string · optionnel
Hostname label (without the apex domain)hatchId· string · optionnel
Hatch id from the original hatch response.tenantId· string · optionnel
Legacy alias for `hatchId`.
Exemple d'appel{"name": "lookup", "arguments": {"slug": "texte", "hatchId": "texte", "tenantId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - poll_approval≈ 157 tokens
Poll a pending Tier-2 phone approval. Returns the result once the owner approves or denies on their phone.
Paramètres, retour & exemple (3)
ParamètreshatchId· string · optionnel
Hatch id from the original hatch response.tenantId· string · optionnel
Legacy alias for `hatchId`.approvalId· string · requis
Exemple d'appel{"name": "poll_approval", "arguments": {"approvalId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - poll_checkout≈ 190 tokens
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.
Paramètres, retour & exemple (1)
ParamètressessionId· string · requis
Checkout Session id (`cs_…`) from `checkout`.
Exemple d'appel{"name": "poll_checkout", "arguments": {"sessionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - poll_decision≈ 249 tokens
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.
Paramètres, retour & exemple (3)
ParamètreshatchId· string · optionnel
Hatch id from the original hatch response.tenantId· string · optionnel
Legacy alias for `hatchId`.decisionId· string · requis
Exemple d'appel{"name": "poll_decision", "arguments": {"decisionId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - poll_pairing≈ 286 tokens
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.
Paramètres, retour & exemple (4)
Paramètrescode· string · requis
Pairing code from get_pairing_code / whoami.hatchId· string · optionnel
Optional hatch id — improves lookup after the phone has approved.tenantId· string · optionnel
Legacy alias for `hatchId`.workspaceId· string · optionnel
Optional workspace id — for B2B pairing flows.
Exemple d'appel{"name": "poll_pairing", "arguments": {"code": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - refresh_session≈ 252 tokens
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.
Paramètres, retour & exemple (4)
ParamètreshatchId· string · optionnel
Hatch id (consumer path).tenantId· string · optionnel
Legacy alias for `hatchId`.workspaceId· string · optionnel
Workspace id (B2B path).refreshToken· string · requis
Opaque refresh token from poll_pairing (vr1.{grantId}.{secret}).
Exemple d'appel{"name": "refresh_session", "arguments": {"refreshToken": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - rename_org≈ 330 tokens
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 }`.
Paramètres, retour & exemple (4)
ParamètresorgName· string · optionnel
New organization display name (1–80 characters). Omit to leave the org name unchanged.workspaceId· string · optionnel
Workspace to rename. Omit when the session is already scoped to a workspace.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).workspaceName· string · optionnel
New workspace display name (1–80 characters). Omit to leave the workspace name unchanged.
Exemple d'appel{"name": "rename_org", "arguments": {"orgName": "texte", "workspaceId": "texte", "sessionToken": "texte", "workspaceName": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - share≈ 176 tokens
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 }`.
Paramètres, retour & exemple (4)
ParamètreshatchId· string · optionnel
Hatch id from the original hatch response.tenantId· string · optionnel
Legacy alias for `hatchId`.sessionToken· string · optionnelexpiresSeconds· integer · optionnel
Exemple d'appel{"name": "share", "arguments": {"hatchId": "texte", "tenantId": "texte", "sessionToken": "texte", "expiresSeconds": 1}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - squawk_poll_access≈ 390 tokens
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.
Paramètres, retour & exemple (2)
ParamètresrequestId· string · requis
requestId from squawk_request_access.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "squawk_poll_access", "arguments": {"requestId": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - squawk_request_access≈ 347 tokens
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.
Paramètres, retour & exemple (5)
ParamètresroostId· string · optionnel
Optional. Must match the paired roost (workspace id, or the hatch id when the session has no workspace).runtime· string · requis
Agent runtime, such as claude or cursor.publicKey· string · optionnel
Optional P-256 public key.displayName· string · requis
Name the owner will see on the phone.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).
Exemple d'appel{"name": "squawk_request_access", "arguments": {"runtime": "texte", "displayName": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - upload≈ 530 tokens
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.
Paramètres, retour & exemple (8)
Paramètrespolicy· string · optionnel · required | good_effort | optional
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 · optionnel
Hatch id from the original hatch response.manifest· object · requistenantId· string · optionnel
Legacy alias for `hatchId` from the original hatch response.hitlTitle· string · optionnel
Modal title for auto-opened HITL.webhookUrl· string · optionnel
Webhook for auto-opened HITL.sessionToken· string · optionnel
Optional paired session token from poll_pairing (when Authorization headers are unavailable).expiresSeconds· integer · optionnel
URL TTL in seconds (default 3600).
Exemple d'appel{"name": "upload", "arguments": {"manifest": {}}}Exemple de retour{"content": [{"type": "text", "text": "…"}]} - whoami≈ 257 tokens
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.
Paramètres, retour & exemple (3)
ParamètreshatchId· string · optionnel
Optional hatch to check or re-pair against.tenantId· string · optionnel
Legacy alias for `hatchId`.sessionToken· string · optionnel
Optional token from poll_pairing. Pass when whoami stays unidentified after a successful pair (connectors that cannot set Authorization headers).
Exemple d'appel{"name": "whoami", "arguments": {"hatchId": "texte", "tenantId": "texte", "sessionToken": "texte"}}Exemple de retour{"content": [{"type": "text", "text": "…"}]}
C'est votre serveur ?
Revendiquez-le sur l'espace créateur (preuve GitHub, domaine ou npm) pour afficher le badge « propriétaire vérifié » et lancer un pentest comportemental à la demande afin d'obtenir le badge « Vérifié ».