Skip to main content
Glama
Sign In

Hatch

by com.viberooster
OverviewDiscussionsAdmin

Rename or change tier

convert
DestructiveIdempotent

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.

Input Schema

NameRequiredDescriptionDefault
promoNoOptional 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.
hatchIdNoHatch id from the original hatch response.
newTierNoRoost / Roost Audit may pass `forever` while subscription Pins remain (10). After the allotment, use `checkout` (grant: publish) for a paid Pin.
tenantIdNoLegacy alias for `hatchId`.
customDomainNoCustomer-owned hostname. Roost / Roost Audit only, after checkout grant custom_domain (+$29/mo). Pass an empty string to clear.
sessionTokenNoOptional paired session token from poll_pairing (when Authorization headers are unavailable).
galleryListedNoOpt 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.
newPreferredSlugNoNew hostname label. The old slug is released atomically.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / galleryListed / description
      Previous value: -"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."New value: +"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."
    • addedInput schema / properties / promo
      Added value: +{
+  "description": "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.",
+  "type": "boolean"
+}
  2. Changed3 schema fields changed
    • addedInput schema / properties / customDomain
      Added value: +{
+  "description": "Customer-owned hostname. Roost / Roost Audit only, after checkout grant custom_domain (+$29/mo). Pass an empty string to clear.",
+  "type": "string"
+}
    • changedInput schema / properties / galleryListed / description
      Previous value: -"Opt in (`true`) or out (`false`) of the public Barnyard carousel. Forever requires `true` to appear; free is listed unless `false`. Paid Workspace hatches (`tier: workspace`) are never listed."New value: +"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."
    • changedInput schema / properties / newTier / description
      Previous value: -"Operator/webhook only on the public connector. Agents must use `checkout` (grant: publish) for forever — do not pass newTier: forever."New value: +"Roost / Roost Audit may pass `forever` while subscription Pins remain (10). After the allotment, use `checkout` (grant: publish) for a paid Pin."
  3. Changed1 schema field changed
    • changedInput schema / properties / galleryListed / description
      Previous value: -"Opt in (`true`) or out (`false`) of the public Barnyard carousel. Forever tier requires `true` to appear; free tier is listed unless set to `false`."New value: +"Opt in (`true`) or out (`false`) of the public Barnyard carousel. Forever requires `true` to appear; free is listed unless `false`. Paid Workspace hatches (`tier: workspace`) are never listed."
  4. Changed3 schema fields changed
    • addedInput schema / properties / hatchId
      Added value: +{
+  "description": "Hatch id from the original hatch response.",
+  "type": "string"
+}
    • addedInput schema / properties / tenantId / description
      Added value: +"Legacy alias for `hatchId`."
    • removedInput schema / required
      Removed value: -[
-  "tenantId"
-]
  5. Changed1 schema field changed
    • changedInput schema / properties / newTier / description
      Previous value: -"New tier. Clears `expiresAt` when promoting to `forever`."New value: +"Operator/webhook only on the public connector. Agents must use `checkout` (grant: publish) for forever — do not pass newTier: forever."
  6. First observed

TDQS

A4.8/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond annotations, it discloses atomic rename behavior, atomic old-slug release, the side effect of creating a second site if `hatch` is called again, Promo conditional rules, Pin/carousel default visibility, and the custom-domain checkout grant requirement. It is consistent with annotations (`destructiveHint: true`, `idempotentHint: true`, `openWorldHint: true`) and adds useful operational context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is front-loaded with purpose and constraints in a logical order, but some passages duplicate schema parameter descriptions, especially the Promo rules. It is lengthy for a tool description, though much of the length is justified by the multi-action complexity.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex multi-purpose mutation tool with no output schema, the description covers operations, parameter combinations, alternatives, constraints, and side effects. Annotations already carry the safety profile, and the description fills in the remaining behavioral and routing context needed to invoke the tool correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the schema already documents parameters, but the description adds a critical cross-parameter constraint: `hatchId` plus at least one of the four action parameters, with `promo` alone being sufficient. It also clarifies `newTier`/`checkout` boundaries and the custom-domain grant condition, though it does not cover every parameter such as `tenantId` or `sessionToken`.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description explicitly states the tool's multiple actions: atomically rename a roost URL, change gallery listing, mark/unmark Promo, or bind a custom domain. It distinguishes the tool from siblings by warning against using `hatch` for rename/Promo and by pointing to `checkout` for paid Pins.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It gives explicit when-to-use and when-not-to-use guidance: pass `hatchId` plus at least one of `newPreferredSlug`, `galleryListed`, `promo`, or `customDomain`; do not call `hatch` again to rename or change Promo; after subscription Pin slots are exhausted, use `checkout` with grant `publish`; do not use `convert` to collect payment.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

All Hatch toolsInspect
Try in Browser
Context Every Agent Can ShareAgents share what they learn, hand off work, and keep it when you switch models. Start with 5 GB free.fulcradynamics.comAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources