Skip to main content
Glama

Describe workspace schema

describe_schema
Read-only

Read the complete workspace shape: built-in/custom objects and fields, valid values and semantic roles, relationships (FK graph), pipelines/stages, active motions, qualification framework, programs, rollups and automation rules. Every role can read; schema changes stay admin-only. Custom field/object and named pipeline definitions include the id accepted by update_record/delete_record with object_type field/object/pipeline.

When to use: Discover the workspace's model and valid keys before reading or writing.

Example: What objects, fields, and valid values does my workspace have?

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
schemaNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • removedInput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
  2. Changed23 schema fields changed
    • removedOutput schema / $schema
      Removed value: -"https://json-schema.org/draft/2020-12/schema"
    • removedOutput schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / schema / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / schema / properties / templates / items / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / schema / properties / templates / items / properties / counts / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / schema / properties / workspace / additionalProperties
      Removed value: -false
    • removedOutput schema / properties / schema / properties / workspace / properties / currency_display / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / currency_display / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / date_format / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / date_format / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / default_currency / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / default_currency / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / flags / additionalProperties
      Removed value: -{}
    • removedOutput schema / properties / schema / properties / workspace / properties / framework / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / framework / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / logo_url / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / logo_url / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / name / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / name / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / recorder_auto_scope / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / recorder_auto_scope / type
      Added value: +[
      +  "string",
      +  "null"
      +]
    • removedOutput schema / properties / schema / properties / workspace / properties / timezone / anyOf
      Removed value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]
    • addedOutput schema / properties / schema / properties / workspace / properties / timezone / type
      Added value: +[
      +  "string",
      +  "null"
      +]
  3. First observed

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered; the description adds genuinely new context beyond that – 'Every role can read; schema changes stay admin-only' and the fact that custom field/object/pipeline definitions carry the id consumed by update_record/delete_record. It says nothing about response size or pagination for what is clearly a large payload.

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 core statement, then a labeled 'When to use' and a labeled example – a clean, scannable structure. The long comma-separated resource enumeration is dense but each item conveys real scope, so it earns its space.

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?

With an output schema present, the description needn't explain return values, and it already covers scope, read permissions, the discovery-before-write trigger, and id reuse across tools. The only omission is any hint about payload size or how to narrow what is described as a 'complete' workspace dump.

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?

The tool takes zero parameters, so there is nothing for the description to disambiguate and the baseline applies. The only parameter-adjacent content is the note about ids accepted by update_record/delete_record with object_type, which is cross-tool context rather than input semantics.

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?

Names a specific verb (Read) and a richly enumerated resource set: objects, fields, valid values, FK graph, pipelines/stages, motions, qualification framework, programs, rollups, automation rules. That enumeration makes it unmistakable against siblings like get_context, show_workspace_setup, or get_pipeline_summary, which each cover only a slice.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

An explicit 'When to use: Discover the workspace's model and valid keys before reading or writing' gives a clear trigger condition. It does not name a competing alternative (e.g. get_context or get_help) or state when NOT to call it, so it stops short of a 5.

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