Skip to main content
Glama

Get Website Settings

get_metadata
Read-only

Get one website's settings: domain, timezone, currency, KPI goal name, logo, and color scheme. Read-only; nothing is changed. Call it after list_websites to learn the timezone and currency before running date-range reports, then pass that timezone to the report tools. With a workspace token pass websiteId or domain; with neither it returns the same website list as list_websites, so prefer list_websites for discovery. A website key needs no selector.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
domainNoWebsite domain from list_websites (e.g. "example.com"). Alternative to websiteId with a workspace token.
websiteIdNoWebsite ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key.
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoObject with status and data: one entry with domain, timezone, currency, kpi, kpiColorScheme, and logo. Without a selector on a workspace token, the website list instead.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
  2. Changed1 schema field changed
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
  3. Changed3 schema fields changed
    • changedInput schema / properties / domain / description
      Previous value: -"Website domain to query. Required when using a workspace token unless websiteId is provided."New value: +"Website domain from list_websites (e.g. \"example.com\"). Alternative to websiteId with a workspace token."
    • changedInput schema / properties / websiteId / description
      Previous value: -"Website ID to query. Required when using a workspace token unless domain is provided."New value: +"Website ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key."
    • changedOutput schema / properties / result / description
      Previous value: -"Website configuration including domain, timezone, currency, KPI goal, and color scheme."New value: +"Object with status and data: one entry with domain, timezone, currency, kpi, kpiColorScheme, and logo. Without a selector on a workspace token, the website list instead."
  4. 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, destructiveHint, and openWorldHint, so the safety profile is covered. The description adds important auth/selector behavior: workspace-token calls need websiteId or domain, without either it behaves like list_websites, and a website key needs no selector. It does not discuss rate limits or error behavior.

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 and information-dense, with the purpose and fields stated first. It is slightly longer than necessary because 'Read-only; nothing is changed' repeats the readOnlyHint annotation, but the remaining sentences earn their place.

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?

Given that an output schema exists and schema coverage is complete, the description does not need to explain return values. It covers the purpose, when to use it, selector behavior, auth-token variations, and the preferred sibling for discovery, making it complete for an agent to call 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 defines the three parameters. The description adds meaningful conditional semantics beyond the schema: workspace-token calls should pass websiteId or domain, a website key needs no selector, and calling with neither returns the website list.

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 states a specific verb and resource: get one website's settings, and enumerates the key fields returned (domain, timezone, currency, KPI goal name, logo, color scheme). It also distinguishes itself from list_websites by saying list_websites is preferred for discovery.

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 explicitly says to call it after list_websites to learn timezone and currency before running date-range reports, then pass that timezone to report tools. It also gives clear selector guidance: with a workspace token pass websiteId or domain, with neither it returns the website list, and a website key needs no selector.

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