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

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

Output Schema

NameRequiredDescriptionDefault
itemsNo
warningsNo
missingIdsNo
paginationNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / include / properties / checklist
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "Setup rewards: each step, its credits, whether it is claimed, and how to complete it.",
      +  "properties": {},
      +  "type": "object"
      +}
  2. 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."
  3. Added

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive. The description adds real value beyond them: caps on includes, that truncation and pagination must be reported, and that results carry missingIds and warnings. It repeats 'read-only' from the annotation, which is minor redundancy rather than added disclosure.

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, then usage, then alternatives. Slightly verbose — the 'stable collection envelope' idea is restated ('The response still uses the same collection envelope'), which is mild padding in an otherwise dense paragraph.

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 read tool with a rich nested include schema and an output schema, the description covers identity, usage, id semantics, include discipline, and truncation/pagination reporting. Nothing an agent needs to call it correctly is missing.

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% and the description compensates: it explains the ids list-vs-fetch behavior and that include should only be used for extra details the user asked for, going beyond the schema's per-field descriptions.

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') and names the sibling tools it is not (campaignstack_get_campaigns, campaignstack_get_identities), so an agent can distinguish it 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?

Explicitly says when to use it ('when the user needs workspace identity, settings, members, billing...') and routes elsewhere for campaign setup and identity/voice ownership. It also spells out the id-passing semantics (omit/one/several).

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