Skip to main content
Glama
flowsery

flowsery

Official

List Websites

list_websites
Read-onlyIdempotent

Lists websites accessible with the current API token, including IDs, domains, timezones, currencies, and KPI goals, so you can get the websiteId or domain required by other tools.

Instructions

List the websites the current API token can read, with id, domain, timezone, currency, and KPI goal per site. A workspace token (flow_ws_) returns every website in the workspace; a website key (flow_) returns only its own. Call this first with a workspace token: every other tool then needs websiteId or domain from this list, and omitting both fails with 'Website ID or domain is required'. Takes no parameters. Use get_metadata instead when you already know the website and only need its settings.

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": "list_websites"
  }
}

Input Schema

NameRequiredDescriptionDefault
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. Changed10 schema fields changedv1.5.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / additionalProperties
      Added value: +false
    • 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 per website with id, domain, timezone, currency, kpi, logo, and trackingId. Use id as websiteId or domain as domain in other tools."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "data": {
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "apiKeyPrefix": {
      +          "$ref": "#/properties/result/properties/data/items/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/properties/logo",
      +          "description": "Goal name used as the website's KPI"
      +        },
      +        "kpiColorScheme": {
      +          "$ref": "#/properties/result/properties/data/items/properties/logo"
      +        },
      +        "logo": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "timezone": {
      +          "type": "string"
      +        },
      +        "trackingId": {
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "id",
      +        "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. Changed1 schema field changedv0.1.1
    • changedOutput schema / properties / result / description
      Previous value: -"List of websites the token can access, with identifiers and domains for use in other tools."New value: +"Object with status and data: one entry per website with id, domain, timezone, currency, kpi, logo, and trackingId. Use id as websiteId or domain as domain in other tools."
  3. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, and non-destructive, so the description rightly spends its words elsewhere: it explains token-type scoping (flow_ws_ returns the whole workspace vs flow_ returns a single site) and the exact failure mode when websiteId/domain is omitted. That is real behavioral context beyond the structured fields, though it does not discuss pagination or result ordering.

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 content is front-loaded: what is returned, then token scoping, then workflow ordering, then the alternative. Sentences are dense and purposeful. The only wasted words are the inaccurate "Takes no parameters" clause, which subtracts value rather than adding it.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

An output schema exists, so the description need not explain return values, and it covers the practical essentials: token scope, call ordering, and failure behavior. The one completeness gap is the false claim of no parameters, which leaves the workspaceId usage path unexplained in prose.

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

Parameters2/5

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

The schema fully documents workspaceId (100% coverage), so the schema itself carries parameter meaning. However, the description asserts "Takes no parameters," which directly contradicts the optional workspaceId parameter in the schema and could lead an agent to omit it when acting in a non-default workspace. That is an active misstatement rather than mere omission.

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 ("List the websites") and immediately scopes it by token capability ("the current API token can read"), then names the returned fields (id, domain, timezone, currency, KPI goal). It explicitly separates itself from get_metadata, so an agent can distinguish the two without opening either 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 explicit when-to-use guidance ("Call this first with a workspace token"), the reason why (every other tool needs websiteId or domain from this list), the consequence of skipping it (the 'Website ID or domain is required' error), and a named alternative ("Use get_metadata instead when you already know the website"). Both the positive and negative cases are covered.

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