Skip to main content
Glama

Get site details

get_site
Read-onlyIdempotent

Return one site's details: live URL, status, plan, served file paths, whether editable source is stored (and its build settings), custom domains, bandwidth and the last 10 deploys. Use get_site to inspect a site before editing it; use list_sites to find site names, and get_app_status for container services.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "get_site"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameNoSite name as shown by list_sites, e.g. my-portfolio. Provide name or siteId.
siteIdNoSite id from list_sites or get_site. Use instead of name.

Output Schema

NameRequiredDescriptionDefault
urlYes
nameYes
planYes
filesYesNumber of files the site serves now (live count). After a patch deploy it can exceed the last deploy's fileCount.
siteIdYes
statusYesLifecycle state. Sites are usable only in 'active'. 'deleted' is the soft-delete recovery bucket (returned until the team's restore window expires and the sweeper purges the row). 'deleting' is the transient state of an in-flight hard-delete request.
historyYes
bandwidthYes
filePathsNoSite-relative paths of every served file, to pick paths to read, patch or delete. Omitted when the pod cannot be inspected (e.g. not ready); `files` then falls back to the last deploy's fileCount.
lastDeployAtYes
sourceStoredYesWhether editable source is stored. Read and edit source, then build_and_deploy when true.
customDomainsYesCustom domains of this site and the team's custom-domain allowance; null when they could not be read.
sourceManifestYesSaved source build settings. Preserve these when rebuilding.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedOutput schema / properties / lastDeployAt / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / lastDeployAt / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. Changed2 schema fields changed
    • addedOutput schema / properties / customDomains
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "allowance": {
      +          "description": "Custom domains the team's current plan includes.",
      +          "type": "number"
      +        },
      +        "connected": {
      +          "description": "Custom domains on this site from both sources, one entry per hostname.",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "domain": {
      +                "description": "Hostname, e.g. shop.example.com.",
      +                "type": "string"
      +              },
      +              "source": {
      +                "description": "dashboard: linked on the dashboard Web Addresses page. mcp: added with add_custom_domain or the site API.",
      +                "enum": [
      +                  "dashboard",
      +                  "mcp"
      +                ],
      +                "type": "string"
      +              },
      +              "status": {
      +                "description": "live: verified and serving this site. pending: linked, not verified yet.",
      +                "enum": [
      +                  "live",
      +                  "pending"
      +                ],
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "domain",
      +              "status",
      +              "source"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "nextTool": {
      +          "const": "add_custom_domain",
      +          "description": "Present when this site has no custom domain yet and the team has room for one.",
      +          "type": "string"
      +        },
      +        "used": {
      +          "description": "Distinct custom domains in use across the team, both sources (same count as get_account).",
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "connected",
      +        "allowance",
      +        "used"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Custom domains of this site and the team's custom-domain allowance; null when they could not be read."
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "siteId",
      -  "name",
      -  "url",
      -  "plan",
      -  "status",
      -  "files",
      -  "sourceStored",
      -  "sourceManifest",
      -  "lastDeployAt",
      -  "bandwidth",
      -  "history"
      -]New value: +[
      +  "siteId",
      +  "name",
      +  "url",
      +  "plan",
      +  "status",
      +  "files",
      +  "sourceStored",
      +  "sourceManifest",
      +  "lastDeployAt",
      +  "bandwidth",
      +  "history",
      +  "customDomains"
      +]
  3. Changed5 schema fields changed
    • addedInput schema / properties / name / description
      Added value: +"Site name as shown by list_sites, e.g. my-portfolio. Provide name or siteId."
    • addedInput schema / properties / siteId / description
      Added value: +"Site id from list_sites or get_site. Use instead of name."
    • changedOutput schema / properties / bandwidth / properties / usedMb / description
      Previous value: -"Outbound MB served by this site over the window (usage only — the bandwidth cap is team-scoped, see get_account)."New value: +"Outbound MB served by this site over the window (usage only; the bandwidth cap is team-scoped, see get_account)."
    • changedOutput schema / properties / filePaths / description
      Previous value: -"Site-relative paths of every file currently on the pod (same scope as `files`). Lets a caller see what's there before deciding which paths to patch or delete, without having to download the site. Omitted when the live introspection step fails (e.g. pod not ready) — `files` then falls back to the most recent deploy's fileCount."New value: +"Site-relative paths of every served file, to pick paths to read, patch or delete. Omitted when the pod cannot be inspected (e.g. not ready); `files` then falls back to the last deploy's fileCount."
    • changedOutput schema / properties / files / description
      Previous value: -"Number of files currently served by the site (live count from the pod, excluding lost+found and _staging). After update_site(mode:'patch'), this may be larger than the most recent deploy's fileCount because patch keeps the existing files. After update_site(mode:'replace'), it equals the most recent deploy's fileCount."New value: +"Number of files the site serves now (live count). After a patch deploy it can exceed the last deploy's fileCount."
  4. Changed1 schema field changed
    • removedOutput schema / properties / request_id
      Removed value: -{
      -  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      -  "type": "string"
      -}
  5. Changed3 schema fields changed
    • addedOutput schema / properties / sourceManifest
      Added value: +{
      +  "anyOf": [
      +    {},
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Saved source build settings. Preserve these when rebuilding."
      +}
    • addedOutput schema / properties / sourceStored
      Added value: +{
      +  "description": "Whether editable source is stored. Read and edit source, then build_and_deploy when true.",
      +  "type": "boolean"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "siteId",
      -  "name",
      -  "url",
      -  "plan",
      -  "status",
      -  "files",
      -  "lastDeployAt",
      -  "bandwidth",
      -  "history"
      -]New value: +[
      +  "siteId",
      +  "name",
      +  "url",
      +  "plan",
      +  "status",
      +  "files",
      +  "sourceStored",
      +  "sourceManifest",
      +  "lastDeployAt",
      +  "bandwidth",
      +  "history"
      +]
  6. Changed1 schema field changed
    • addedOutput schema / properties / request_id
      Added value: +{
      +  "description": "Server-assigned request correlation id. Quote it when contacting support.",
      +  "type": "string"
      +}
  7. First observed

TDQS

A4.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint=false, so the safety profile is fully covered by structured data. The description adds genuine behavioral detail beyond that: the bounded return ('the last 10 deploys') and the fact that editable-source presence and build settings are included. It stops short of describing size, latency, or behavior when the site does not exist.

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?

Two sentences, front-loaded with the core action and then the routing rule. The return-field list is long and partly overlaps the output schema, but every item is field-selection relevant, so nothing is truly wasted; slight redundancy is the only cost.

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 a rich annotation set, 100% schema coverage, only two optional parameters, and an output schema present, the definition covers everything an agent needs to choose and call it. Return-value enumeration is technically redundant given the output schema, but it does not leave gaps.

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% and the schema itself states 'Provide name or siteId' with an example ('my-portfolio'), plus a mutual-exclusion note. The description adds no parameter guidance beyond the schema, so the baseline of 3 applies.

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?

States a specific verb and resource ('Return one site's details') and enumerates the returned surface: live URL, status, plan, served file paths, editable-source flag with build settings, custom domains, bandwidth, and the last 10 deploys. The scope word 'one site's' and the explicit contrast with list_sites and get_app_status let an agent distinguish it from siblings without opening any schema.

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 an explicit trigger ('inspect a site before editing it') plus two named alternatives with the condition that selects each: list_sites when you need to find a site name, get_app_status for container services. That is a complete routing rule, not an implied one.

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.