Skip to main content
Glama

Protect a site with a login

auth
DestructiveIdempotent

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).

Input Schema

NameRequiredDescriptionDefault
modeNo`password` = one shared site password (recommended). `useraccounts` is unavailable. Required when `action` is `enable`.
actionNoWhat to do. Defaults to `status`.
hatchIdNoHatch id from the original hatch response.
passwordNoThe shared site password (password mode only). Required for `enable` (password mode) and `setPassword`.
tenantIdNoLegacy alias for `hatchId` from the original hatch response.
sessionTokenNoOptional paired session token from poll_pairing (when Authorization headers are unavailable).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changed
    • addedInput schema / properties / hatchId
      Added value: +{
      +  "description": "Hatch id from the original hatch response.",
      +  "type": "string"
      +}
    • changedInput schema / properties / tenantId / description
      Previous value: -"Tenant id from the original hatch response."New value: +"Legacy alias for `hatchId` from the original hatch response."
    • removedInput schema / required
      Removed value: -[
      -  "tenantId"
      -]
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, destructiveHint=true, and idempotentHint=true, so the description doesn't need to restate those. It adds valuable behavioral context: the sign-in screen lives at `/__roost/login`, the return shape is `{ enabled, mode, loginUrl }`, and `useraccounts` is unavailable because per-hatch databases are no longer provisioned. It could go further by noting whether `disable` is reversible or whether `setPassword` invalidates existing sessions, but the disclosed behavior is solid.

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

Conciseness5/5

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

The description is compact and front-loaded: the core purpose is in the first sentence, followed by a scannable bullet list of actions. Every sentence earns its place, and the return shape and login URL are included without padding. The structure makes it easy for an agent to parse the action semantics quickly.

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

Completeness4/5

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

For a tool with 6 parameters, no required params, and no output schema, the description covers the main decision points: which action to use, which mode to prefer, what the return value is, and where the login screen lives. It doesn't explain the `tenantId` legacy alias or `sessionToken` pairing context, but those are fully documented in the schema. The description is complete enough for an agent to invoke the tool correctly in the common cases.

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 baseline is 3. The description adds meaning beyond the schema by explaining the action/mode/password combinations: e.g., `enable` with `mode: "password"` and a `password` creates ONE shared password, and `setPassword` rotates it. It also clarifies that `action` defaults to `status`, which is not in the schema. The only minor gap is that `tenantId` and `sessionToken` are not mentioned in the description, but the schema already documents them fully.

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 opens with a clear verb+resource: 'Put a sign-in screen in front of any roost so visitors must authenticate.' It then enumerates the four actions (enable, setPassword, disable, status) with concrete effects, which fully distinguishes this tool from siblings like share or deploy. The title 'Protect a site with a login' reinforces the purpose without being the sole source of meaning.

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?

The description gives explicit when-to-use guidance: 'Best for a private demo or staging link' for password mode, and explicitly says 'Prefer password mode; useraccounts is unavailable.' It also explains when to use setPassword (rotate the shared password) and disable (remove the login and serve publicly). This is strong routing guidance relative to alternatives.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.