Skip to main content
Glama

Get workspaces

campaignstack_get_workspaces
Read-onlyIdempotent

Read workspaces and optional workspace details in one stable collection envelope. Use this when the user needs workspace identity, settings, members, billing, credits, metrics, setup, branding, compliance, playbook, playbook history, or the pending playbook proposal. Omit ids to list matching records, pass one id for one record, or pass several ids for several records. The response still uses the same collection envelope. Use include only for extra details the user asked for. Large, computed, historical, or external includes must use their documented caps and must report when data is truncated or paginated. This read-only tool does not change data. Instead use campaignstack_get_campaigns for campaign setup, and campaignstack_get_identities for account or voice ownership. The result returns items, pagination, missingIds when requested ids are unavailable, and warnings for capped includes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idsNoOptional entity ids to fetch, capped at 25.
limitNoMaximum items to return, capped at 50.
cursorNoOpaque pagination cursor.
filtersNo
includeNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
itemsNo
warningsNo
missingIdsNo
paginationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • changedInput schema / properties / filters / properties / workspaceId / description
      Previous value: -"Workspace ID. REQUIRED for a user key (csu_), which spans every workspace you belong to; omitted for a workspace key (cs_), which is bound to one and ignores this argument. campaignstack_whoami reports which kind of key you are holding and, for a user key, the workspaces it can reach."New value: +"Workspace ID. Omit it when this connection reaches one workspace: a workspace key (cs_) is bound to its own, and a user key (csu_) or connected app whose person belongs to exactly one workspace defaults to that one. Required only when the person belongs to several; the error then lists them, and campaignstack_whoami reports them too."
  2. Added

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already cover readOnly, idempotent and non-destructive, so the description's job is to add beyond that. It does: caps on large/computed/historical includes, mandatory truncation/pagination reporting, missingIds for unavailable ids, and warnings for capped includes. It stops short of describing concrete cap values or the warning shape, but the behavioral contract is well disclosed.

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?

Front-loaded with purpose and routing, then the id/include mechanics, then boundary tools. It is on the longer side and somewhat clause-heavy, but virtually every sentence carries actionable information about caps, truncation, or alternatives.

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?

For a read tool with nested include objects, an output schema, and rich annotations, the description supplies routing, id semantics, truncation behavior and non-mutation reassurance. The remaining gap is the omitted workspaceId defaulting rule, which is only discoverable in the schema.

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 60%, so the description must compensate for some parameters and does: it explains the ids cardinality semantics (none/one/many) and the include-only-what-was-asked-for rule, plus the cap/reporting obligation for expensive includes. The workspaceId defaulting nuance lives only in the schema, leaving a small gap versus a 5.

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 ('Read workspaces and optional workspace details') plus the stable collection envelope shape. It explicitly names the sibling alternatives (campaignstack_get_campaigns, campaignstack_get_identities), so an agent can disambiguate without opening other schemas.

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 concrete routing rules: omit ids to list, one id for one record, several ids for several records, and 'use include only for extra details the user asked for'. It also names two sibling tools and the domains they own, which is exactly the when/when-not guidance an agent needs.

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