Skip to main content
Glama

Read a site's settings

get_site
Read-only

Reads a site's settings, state, and versions to show serving mode, password, forms, takedown, pause, served version, and plan limits.

Instructions

Reads one site's settings and state — serving mode, password, forms, scheduled takedown, folder, whether it is paused — and its versions, newest first, with the one being served marked. Also says which settings the account's plan does not include.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

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

Input Schema

NameRequiredDescriptionDefault
siteYesSubdomain or site id, from list_sites.

Output Schema

NameRequiredDescriptionDefault
urlYesIts live URL.
modeYesHow it serves its files.
nameYesWhat it is called, or null.
siteIdYesIdentifier of the site.
statusYes`active`, `paused`, or a state the platform put it in.
apiProxyYesIts API proxy, or null where the proxy is not available.
commentsYesWho may comment on its pages: nobody, the people invited to comment (only while it is invite-only), or anybody signed in. Null when that could not be read.
folderIdYesThe folder it is filed in, or null at the top level.
versionsYesIts versions, newest first.
availableYesWhich settings the account's plan includes.
expiresAtYesWhen it is scheduled to come down, or null.
subdomainYesIts subdomain.
invitedOnlyYesWhether only invited people can open it, or null when that could not be read. Null does not mean public.
expiryActionYesWhat the takedown does: `pause` or `delete`, or null when none is scheduled.
formsEnabledYesWhether it accepts form submissions.
formerSubdomainsYesThe subdomains it used to answer on, newest first; each redirects to it.
passwordProtectedYesWhether visitors must type a password.
subdomainChangesLeftYesHow many more times change_subdomain may move it, or null when there is no limit.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv0.2.6
    • addedOutput schema / properties / apiProxy
      Added value: +{
      +  "anyOf": [
      +    {
      +      "additionalProperties": false,
      +      "properties": {
      +        "perMonth": {
      +          "description": "Proxied requests the plan allows a month; 0 when it has none.",
      +          "type": "number"
      +        },
      +        "resetsAt": {
      +          "description": "When the count starts again.",
      +          "type": "string"
      +        },
      +        "routes": {
      +          "description": "Proxy routes in the live version's _redirects.",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "from": {
      +                "type": "string"
      +              },
      +              "to": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "from",
      +              "to"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "suspended": {
      +          "description": "Whether the month is spent and calls answer 429.",
      +          "type": "boolean"
      +        },
      +        "switchedOff": {
      +          "description": "Whether Drop2Run switched this site's proxy off.",
      +          "type": "boolean"
      +        },
      +        "upstreams": {
      +          "description": "Origins its /api/* routes may call, as update_site's `upstream` sets them.",
      +          "items": {
      +            "additionalProperties": false,
      +            "properties": {
      +              "blocked": {
      +                "description": "Whether Drop2Run blocked this origin for every site.",
      +                "type": "boolean"
      +              },
      +              "headers": {
      +                "description": "Header names and each value's last four characters; never a value.",
      +                "items": {
      +                  "additionalProperties": false,
      +                  "properties": {
      +                    "last4": {
      +                      "type": "string"
      +                    },
      +                    "name": {
      +                      "type": "string"
      +                    }
      +                  },
      +                  "required": [
      +                    "name",
      +                    "last4"
      +                  ],
      +                  "type": "object"
      +                },
      +                "type": "array"
      +              },
      +              "methods": {
      +                "items": {
      +                  "type": "string"
      +                },
      +                "type": "array"
      +              },
      +              "origin": {
      +                "type": "string"
      +              }
      +            },
      +            "required": [
      +              "origin",
      +              "methods",
      +              "headers",
      +              "blocked"
      +            ],
      +            "type": "object"
      +          },
      +          "type": "array"
      +        },
      +        "used": {
      +          "description": "Proxied requests this month, every site of the account.",
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "perMonth",
      +        "used",
      +        "suspended",
      +        "resetsAt",
      +        "switchedOff",
      +        "upstreams",
      +        "routes"
      +      ],
      +      "type": "object"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "Its API proxy, or null where the proxy is not available."
      +}
    • addedOutput schema / properties / formerSubdomains
      Added value: +{
      +  "description": "The subdomains it used to answer on, newest first; each redirects to it.",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": "array"
      +}
    • addedOutput schema / properties / subdomainChangesLeft
      Added value: +{
      +  "anyOf": [
      +    {
      +      "maximum": 9007199254740991,
      +      "minimum": -9007199254740991,
      +      "type": "integer"
      +    },
      +    {
      +      "type": "null"
      +    }
      +  ],
      +  "description": "How many more times change_subdomain may move it, or null when there is no limit."
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "siteId",
      -  "name",
      -  "mode",
      -  "passwordProtected",
      -  "invitedOnly",
      -  "formsEnabled",
      -  "comments",
      -  "expiresAt",
      -  "expiryAction",
      -  "folderId",
      -  "subdomain",
      -  "url",
      -  "status",
      -  "available",
      -  "versions"
      -]New value: +[
      +  "siteId",
      +  "name",
      +  "mode",
      +  "passwordProtected",
      +  "invitedOnly",
      +  "formsEnabled",
      +  "comments",
      +  "expiresAt",
      +  "expiryAction",
      +  "folderId",
      +  "subdomain",
      +  "url",
      +  "status",
      +  "available",
      +  "versions",
      +  "subdomainChangesLeft",
      +  "formerSubdomains",
      +  "apiProxy"
      +]
  2. Addedv0.2.5

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and openWorldHint=true, so the safety profile is covered. The description adds real behavioral context beyond that: versions are returned newest first, the currently served version is marked, and the response flags settings the account's plan excludes — all useful for interpreting the result without guessing.

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?

One front-loaded sentence led by the verb and resource, with the field enumeration tucked into an em-dash clause. No filler, no repetition of the title, and the most important information (what is read, from how many sites) comes first.

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?

An output schema exists, so return values need not be spelled out, yet the description still previews the response shape (settings, ordered versions, served marker, plan-gated settings). Combined with the annotations and 100% schema coverage, an agent has everything needed to call this correctly.

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?

There is a single parameter and schema description coverage is 100%, so the schema already documents 'site' as a subdomain or site id from list_sites. The description adds no additional meaning about the identifier's format or resolution behavior, 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 ('Reads one site's settings and state') and then enumerates the exact fields returned (serving mode, password, forms, scheduled takedown, folder, paused) plus the version list. This is clearly distinguishable from the sibling list_sites, which reads many sites, and from update_site, which mutates.

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

Usage Guidelines3/5

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

Usage is implied by the singular scope ('one site's settings'), which tells the agent this is the per-site read rather than a bulk listing, but there is no explicit when-to-use statement, no prerequisites (e.g. does the caller need to own the site?), and no named alternative such as list_sites for enumeration.

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