Skip to main content
Glama

Get site status

get_site
Read-onlyIdempotent

Get the current status and details of a site. Use to poll for generation/refinement completion (every ~10s) and to get the preview/deployment URL. status is one of: generating (a round is running — this covers every phase, and is also what you get while the state is momentarily unknown, so keep polling) | ready | publishing | published | publish_held | error. "publish_held" means the last publish crashed or loaded blank in a browser check before going live, so it was NOT made live (any earlier version is still what visitors see) — tell the user publish_message, fix the page it names, then publish again. "error" after publish_site means that publish FAILED and was not made live (any deployment_url still serves the earlier version) — tell the user error_message, then publish again. Only "ready"/"published" mean the work is finished; generation_progress is informational and is NOT a completion signal on its own.

Input Schema

NameRequiredDescriptionDefault
site_idYesThe site ID to check
user_goalNoOptional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / user_goal
      Added value: +{
      +  "description": "Optional: the user's goal behind this call, in one short sentence of plain words (e.g. \"add a page so customers can book tables\"). No names, emails or other personal details.",
      +  "type": "string"
      +}
  2. First observed

TDQS

A4.4/5.0
Behavior5/5

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

Annotations already declare a safe read-only, idempotent, closed-world operation, and the description adds substantial context beyond that: the full status vocabulary, the operational meaning of publish_held and error (nothing went live, prior version still serving), and the caveat that generating also covers momentarily-unknown state. This is exactly the behavioral detail an agent needs while polling.

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?

Purpose and polling cadence are front-loaded, then the status table is enumerated with actionable consequences for each. It is long, and the closing sentence re-summarizes the completion rule already implied earlier, but the density is justified for a polling tool.

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?

With no output schema, the description carries the burden of explaining returned state and it does so thoroughly: enumerates all status values, interprets the ambiguous ones, and names the message/URL fields to surface. An agent can poll, interpret, and decide next steps without further information.

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

Parameters3/5

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

Schema description coverage is 100%, so site_id and user_goal are already documented; the description adds nothing about parameter meaning or formatting. The referenced fields (publish_message, error_message, deployment_url, generation_progress) are return values, not inputs, so the baseline of 3 applies.

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

Purpose4/5

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

States a specific verb and resource ("Get the current status and details of a site") and clarifies the two main uses: polling for generation/refinement completion and retrieving the preview/deployment URL. It doesn't explicitly contrast with close siblings like get_site_settings or get_render_diagnostics, but the status-polling framing makes the intent unambiguous.

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?

Gives concrete when-to-use guidance ("poll for generation/refinement completion, every ~10s") and then prescribes per-state behavior: what to tell the user for publish_held and error, and the follow-up action (fix the named page / republish). It also warns which signals are NOT completion criteria (generation_progress).

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.

Resources