Skip to main content
Glama

Scribe Mail

Workspace plan, seats & tracking setup

get_workspace
Read-onlyIdempotent

A snapshot of the current workspace's commercial state: plan (tier, kind, status, billing_interval, cancel_at_period_end + start/end dates), seat_count (invoiced seats — what Stripe is billed for), and event_tracking (conversion-tracking setup: the Event Tracking ID to paste into the website snippet / @scribemail/js init, plus whether events would be ingested). When helping a user set up conversion tracking, read the ID here and search_docs for 'conversion tracking' to walk them through the snippet, identify() and track() calls. There is no id — it is always the API key's own workspace. Read-only: plan and seats are managed in the dashboard / by the billing system, never via the API.

Input Schema

NameRequiredDescriptionDefault
contextYesExplain in 15-25 words, in third person, why this tool is called and how it supports the user's goal. For analytics only. You MUST describe only the abstract purpose of the tool call. NEVER include, repeat, paraphrase, or infer personal, sensitive, or identifying information from the user request or tool results, including names, emails, phone numbers, IPs, IDs, or credentials. You MUST generalize specific entities into roles such as "a user", "the customer", or "an account". Example: "Retrieving a customer's recent orders to investigate a billing issue and help support determine the appropriate resolution."

Output Schema

NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • removedOutput schema / properties / data / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / plan / properties / ends_at / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / plan / properties / ends_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / plan / properties / started_at / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / plan / properties / started_at / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / data / properties / plan / properties / status / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / data / properties / plan / properties / status / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  2. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already cover readOnly/idempotent/non-destructive, and the description reinforces with 'Read-only' plus the valuable constraint that plan and seats cannot be mutated through the API at all. It also notes events-tracking tells whether events 'would be ingested,' a behavioral nuance not in annotations, though it does not discuss cost, rate limits, or staleness of the snapshot.

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 the resource and its components, then the workflow hint, then the scope/read-only caveats. The parenthetical enumeration of plan fields partially duplicates the output schema, which is mild redundancy but keeps the description skimmable.

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 an output schema already defines return values, the description adds the missing pieces an agent needs: scope (API key's own workspace), mutation limits, and the conversion-tracking follow-up path via search_docs. Nothing required to call it correctly is absent.

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 single 'context' parameter is already documented and the description needn't repeat it. It does add meaning by clarifying that no identifier parameter exists — the workspace is implied by the API key — which prevents an agent from searching the schema for an id field.

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+resource ('snapshot of the current workspace's commercial state') and enumerates the three returned components (plan, seat_count, event_tracking). It also disambiguates scope explicitly: 'There is no id — it is always the API key's own workspace,' which no sibling tool claims.

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 an explicit when-to-use trigger ('When helping a user set up conversion tracking, read the ID here and search_docs for conversion tracking') and names the follow-on sibling tool. It also states a when-not: plan and seats are managed in the dashboard / billing system, never via the API.

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.