Skip to main content
Glama
flowsery

flowsery

Official

Get Website Settings

get_metadata
Read-onlyIdempotent

Retrieves a website's settings—timezone, currency, KPI goal name, logo, and color scheme—read-only, so you can pass the correct timezone to date-range report tools.

Instructions

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.

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_metadata"
  }
}

Input 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

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.5.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • 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"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed 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."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "data": {
      +    "description": "One entry with the website's settings, or the full website list when a workspace token passes no selector",
      +    "items": {
      +      "anyOf": [
      +        {
      +          "additionalProperties": true,
      +          "properties": {
      +            "apiKeyPrefix": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo"
      +            },
      +            "currency": {
      +              "type": "string"
      +            },
      +            "domain": {
      +              "type": "string"
      +            },
      +            "id": {
      +              "description": "Pass as websiteId to other tools",
      +              "type": "string"
      +            },
      +            "kpi": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo",
      +              "description": "Goal name used as the website's KPI"
      +            },
      +            "kpiColorScheme": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo"
      +            },
      +            "logo": {
      +              "type": [
      +                "string",
      +                "null"
      +              ]
      +            },
      +            "timezone": {
      +              "type": "string"
      +            },
      +            "trackingId": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "id",
      +            "domain",
      +            "timezone",
      +            "currency"
      +          ],
      +          "type": "object"
      +        },
      +        {
      +          "additionalProperties": true,
      +          "properties": {
      +            "currency": {
      +              "type": "string"
      +            },
      +            "domain": {
      +              "type": "string"
      +            },
      +            "kpi": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo"
      +            },
      +            "kpiColorScheme": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo"
      +            },
      +            "logo": {
      +              "$ref": "#/properties/result/properties/data/items/anyOf/0/properties/logo"
      +            },
      +            "timezone": {
      +              "type": "string"
      +            }
      +          },
      +          "required": [
      +            "domain",
      +            "timezone",
      +            "currency"
      +          ],
      +          "type": "object"
      +        }
      +      ]
      +    },
      +    "type": "array"
      +  },
      +  "status": {
      +    "description": "\"success\" on every successful call",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "status",
      +  "data"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed3 schema fields changedv0.1.1
    • 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."
  3. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Annotations already declare readOnlyHint/idempotentHint/destructiveHint, but the description adds behavior those annotations cannot express: the surprising fallback where omitting selectors returns a website list, and the differing selector requirements for a workspace token versus a website key. That is exactly the context an agent needs to avoid mis-calling it.

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?

Four dense sentences, front-loaded with what is returned, then workflow, then selector rules — no filler. The clause 'Read-only; nothing is changed' restates the readOnlyHint annotation and is the one mildly wasteful phrase.

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?

For a 3-parameter, zero-required read tool with an output schema and full schema descriptions, everything an agent needs is present: purpose, return fields, ordering relative to siblings, auth-mode selector rules, and the degenerate no-selector case.

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 coverage is 100%, so the baseline is 3, and the description goes modestly beyond it by explaining the selector logic as a whole (websiteId or domain with a workspace token; nothing needed with a website key) rather than per-field. It does not mention workspaceId at all, leaving that entirely to the already-detailed schema.

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 first sentence names a specific verb and resource (get one website's settings) and enumerates the fields returned: domain, timezone, currency, KPI goal name, logo, color scheme. It is immediately distinguishable from the sibling list_websites, which is named explicitly later in the text.

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 gives an explicit workflow position (call after list_websites, before date-range reports) and the reason (to learn timezone and currency, then pass that timezone to report tools). It also states the negative case — with no selector it returns the website list, so prefer list_websites for discovery — and the auth-mode rule that 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.