Skip to main content
Glama

Inspect Candor schema

candor_schema

Discover contracts before using unfamiliar datasets, filters, or operations. Choose one mode: omit selectors for the workspace schema index, or set dataset for one dataset schema; set operation for an exact operation contract and call shape; set query to search the operation catalog. dataset, operation, and query are mutually exclusive, with no precedence. limit applies only to query (default 10, maximum 10). Reuse a known current schema or an exact next_actions call without rediscovering it. This tool returns contracts, not financial records. Workspace and dataset schema reads record private action history and audit events; catalog searches and operation descriptions are local lookups.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum operation search matches; default 10. Valid only with query.
queryNoSearch operation names and capability descriptions. Use the returned operation id with operation for its full contract; do not combine with dataset or operation.
reasonNoConcise user-visible purpose recorded in immutable action history, including for financial reads. A reason is not approval. Root operations require it except fixed-reason orientation operations; continuations inherit the parent reason only when no reason is supplied. Fixed-reason orientation operations always use their system reason.
datasetNoInspect one dataset: fields, supported query filters, and coverage contract. Omit all selectors for the workspace schema index.
task_keyNoOptional stable label grouping operations for the same user task. Omit to inherit the parent task key, if any. It does not schedule work or provide idempotency.
operationNoDescribe one exact operation id, including accepted_args, input_schema when applicable, and invocation shape. Do not combine with dataset or query.
parent_actionNoExisting action id in this workspace, typically returned in next_actions, whose root identity this continuation inherits. An omitted reason inherits the parent reason; an explicit reason is preserved, except for fixed-reason orientation operations. Omit for a new root action.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes
actionNo
errorsYes
statusYes
metadataNo
warningsYes
request_idYes
generated_atYes
next_actionsYes
user_messageNo
data_freshnessNo
schema_versionYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed8 schema fields changed
    • addedInput schema / properties / dataset / description
      Added value: +"Inspect one dataset: fields, supported query filters, and coverage contract. Omit all selectors for the workspace schema index."
    • removedInput schema / properties / inline_response
      Removed value: -{
      -  "description": "Return the full response payload in this MCP tool result instead of a resource link. Use only when the client can materialize large tool results into a code sandbox; the response may be very large.",
      -  "type": "boolean"
      -}
    • addedInput schema / properties / limit / description
      Added value: +"Maximum operation search matches; default 10. Valid only with query."
    • addedInput schema / properties / operation / description
      Added value: +"Describe one exact operation id, including accepted_args, input_schema when applicable, and invocation shape. Do not combine with dataset or query."
    • addedInput schema / properties / parent_action / description
      Added value: +"Existing action id in this workspace, typically returned in next_actions, whose root identity this continuation inherits. An omitted reason inherits the parent reason; an explicit reason is preserved, except for fixed-reason orientation operations. Omit for a new root action."
    • addedInput schema / properties / query / description
      Added value: +"Search operation names and capability descriptions. Use the returned operation id with operation for its full contract; do not combine with dataset or operation."
    • changedInput schema / properties / reason / description
      Previous value: -"Concise user-visible reason recorded in action history."New value: +"Concise user-visible purpose recorded in immutable action history, including for financial reads. A reason is not approval. Root operations require it except fixed-reason orientation operations; continuations inherit the parent reason only when no reason is supplied. Fixed-reason orientation operations always use their system reason."
    • addedInput schema / properties / task_key / description
      Added value: +"Optional stable label grouping operations for the same user task. Omit to inherit the parent task key, if any. It does not schedule work or provide idempotency."
  2. Changed3 schema fields changed
    • changedInput schema / properties / dataset / enum
      Previous value: -[
      -  "accounts",
      -  "balances",
      -  "account_terms",
      -  "transactions",
      -  "coverage",
      -  "recurring",
      -  "holdings",
      -  "investment_transactions",
      -  "budgets",
      -  "goals",
      -  "rules",
      -  "changes",
      -  "actions"
      -]New value: +[
      +  "properties",
      +  "accounts",
      +  "balances",
      +  "account_terms",
      +  "transactions",
      +  "coverage",
      +  "recurring",
      +  "holdings",
      +  "holding_valuations",
      +  "investment_transactions",
      +  "budgets",
      +  "goals",
      +  "rules",
      +  "categories",
      +  "changes",
      +  "actions"
      +]
    • addedOutput schema / properties / metadata / properties
      Added value: +{
      +  "view_url": {
      +    "format": "uri",
      +    "type": "string"
      +  }
      +}
    • removedOutput schema / properties / metadata / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  3. Changed1 schema field changed
    • addedOutput schema / properties / metadata
      Added value: +{
      +  "additionalProperties": {},
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
  4. Changed2 schema fields changed
    • removedOutput schema / properties / summary
      Removed value: -{
      -  "minLength": 1,
      -  "type": "string"
      -}
    • changedOutput schema / required
      Previous value: -[
      -  "data",
      -  "errors",
      -  "generated_at",
      -  "next_actions",
      -  "request_id",
      -  "schema_version",
      -  "status",
      -  "summary",
      -  "warnings"
      -]New value: +[
      +  "data",
      +  "errors",
      +  "generated_at",
      +  "next_actions",
      +  "request_id",
      +  "schema_version",
      +  "status",
      +  "warnings"
      +]
  5. Changed3 schema fields changed
    • changedInput schema / properties / dataset / enum
      Previous value: -[
      -  "accounts",
      -  "balances",
      -  "account_terms",
      -  "transactions",
      -  "coverage",
      -  "spending_categories",
      -  "merchants",
      -  "recurring",
      -  "holdings",
      -  "investment_transactions",
      -  "budgets",
      -  "goals",
      -  "rules",
      -  "changes",
      -  "actions"
      -]New value: +[
      +  "accounts",
      +  "balances",
      +  "account_terms",
      +  "transactions",
      +  "coverage",
      +  "recurring",
      +  "holdings",
      +  "investment_transactions",
      +  "budgets",
      +  "goals",
      +  "rules",
      +  "changes",
      +  "actions"
      +]
    • removedOutput schema / $defs / __schema1
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "number"
      -    },
      -    {
      -      "type": "boolean"
      -    },
      -    {
      -      "type": "null"
      -    },
      -    {
      -      "items": {
      -        "$ref": "#/$defs/__schema1"
      -      },
      -      "type": "array"
      -    },
      -    {
      -      "additionalProperties": {
      -        "$ref": "#/$defs/__schema1"
      -      },
      -      "propertyNames": {
      -        "type": "string"
      -      },
      -      "type": "object"
      -    }
      -  ]
      -}
    • removedOutput schema / properties / query_scope
      Removed value: -{
      -  "additionalProperties": false,
      -  "properties": {
      -    "population": {
      -      "additionalProperties": false,
      -      "properties": {
      -        "included_count": {
      -          "maximum": 9007199254740991,
      -          "minimum": 0,
      -          "type": "integer"
      -        },
      -        "total_available_count": {
      -          "anyOf": [
      -            {
      -              "maximum": 9007199254740991,
      -              "minimum": 0,
      -              "type": "integer"
      -            },
      -            {
      -              "type": "null"
      -            }
      -          ]
      -        }
      -      },
      -      "required": [
      -        "included_count",
      -        "total_available_count"
      -      ],
      -      "type": "object"
      -    },
      -    "query": {
      -      "additionalProperties": false,
      -      "properties": {
      -        "args": {
      -          "additionalProperties": {
      -            "$ref": "#/$defs/__schema1"
      -          },
      -          "propertyNames": {
      -            "type": "string"
      -          },
      -          "type": "object"
      -        },
      -        "operation": {
      -          "minLength": 1,
      -          "type": "string"
      -        }
      -      },
      -      "required": [
      -        "args",
      -        "operation"
      -      ],
      -      "type": "object"
      -    }
      -  },
      -  "required": [
      -    "population",
      -    "query"
      -  ],
      -  "type": "object"
      -}
  6. Changed3 schema fields changed
    • addedInput schema / properties / limit
      Added value: +{
      +  "maximum": 10,
      +  "minimum": 1,
      +  "type": "integer"
      +}
    • addedOutput schema / $defs / __schema1
      Added value: +{
      +  "anyOf": [
      +    {
      +      "type": "string"
      +    },
      +    {
      +      "type": "number"
      +    },
      +    {
      +      "type": "boolean"
      +    },
      +    {
      +      "type": "null"
      +    },
      +    {
      +      "items": {
      +        "$ref": "#/$defs/__schema1"
      +      },
      +      "type": "array"
      +    },
      +    {
      +      "additionalProperties": {
      +        "$ref": "#/$defs/__schema1"
      +      },
      +      "propertyNames": {
      +        "type": "string"
      +      },
      +      "type": "object"
      +    }
      +  ]
      +}
    • addedOutput schema / properties / query_scope
      Added value: +{
      +  "additionalProperties": false,
      +  "properties": {
      +    "population": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "included_count": {
      +          "maximum": 9007199254740991,
      +          "minimum": 0,
      +          "type": "integer"
      +        },
      +        "total_available_count": {
      +          "anyOf": [
      +            {
      +              "maximum": 9007199254740991,
      +              "minimum": 0,
      +              "type": "integer"
      +            },
      +            {
      +              "type": "null"
      +            }
      +          ]
      +        }
      +      },
      +      "required": [
      +        "included_count",
      +        "total_available_count"
      +      ],
      +      "type": "object"
      +    },
      +    "query": {
      +      "additionalProperties": false,
      +      "properties": {
      +        "args": {
      +          "additionalProperties": {
      +            "$ref": "#/$defs/__schema1"
      +          },
      +          "propertyNames": {
      +            "type": "string"
      +          },
      +          "type": "object"
      +        },
      +        "operation": {
      +          "minLength": 1,
      +          "type": "string"
      +        }
      +      },
      +      "required": [
      +        "args",
      +        "operation"
      +      ],
      +      "type": "object"
      +    }
      +  },
      +  "required": [
      +    "population",
      +    "query"
      +  ],
      +  "type": "object"
      +}
  7. Changed2 schema fields changed
    • addedOutput schema / $defs
      Added value: +{
      +  "__schema0": {
      +    "anyOf": [
      +      {
      +        "type": "string"
      +      },
      +      {
      +        "type": "number"
      +      },
      +      {
      +        "type": "boolean"
      +      },
      +      {
      +        "type": "null"
      +      },
      +      {
      +        "items": {
      +          "$ref": "#/$defs/__schema0"
      +        },
      +        "type": "array"
      +      },
      +      {
      +        "additionalProperties": {
      +          "$ref": "#/$defs/__schema0"
      +        },
      +        "propertyNames": {
      +          "type": "string"
      +        },
      +        "type": "object"
      +      }
      +    ]
      +  }
      +}
    • addedOutput schema / properties / next_actions / items / properties / args / additionalProperties / $ref
      Added value: +"#/$defs/__schema0"
  8. First observed

TDQS

A4.9/5.0
Behavior5/5

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

Annotations carry no safety hints, so the description carries the full burden. It discloses that workspace and dataset schema reads record private action history and audit events, while catalog searches and operation descriptions are local lookups. It also explains the reason parameter is recorded in immutable action history, that a reason is not approval, and how parent_action inheritance works—far beyond what annotations provide.

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 description is long but each sentence carries load—purpose, modes, constraints, behavioral notes, and usage tips. It front-loads the core purpose and uses a logical mode-based structure. A couple of details (e.g., 'no precedence' and 'fixed-reason orientation operations') are dense but necessary for correctness. No filler.

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 7-parameter tool with an output schema and complex interaction rules, the description covers all critical aspects: parameter relationships, side effects, reason/parent semantics, and when to use each mode. It even preempts common mistakes (e.g., combining selectors, using limit without query). 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.

Parameters5/5

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

Schema coverage is 100%, but the description adds substantial meaning: mutual exclusivity rules, the scope of limit ('applies only to query, default 10, maximum 10'), reason semantics (immutability, not approval, root requirement, inheritance), task_key grouping behavior, and parent_action inheritance rules. These are not in the schema and materially affect correct invocation.

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?

The description opens with a clear, specific purpose: 'Discover contracts before using unfamiliar datasets, filters, or operations.' It then enumerates the exact modes (workspace index, dataset, operation, query) and distinguishes the tool from siblings like candor_get and candor_query by focusing on contract discovery rather than data retrieval.

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?

The description gives explicit when-to-use guidance ('before using unfamiliar datasets, filters, or operations') and detailed mode selection rules, including mutual exclusivity of dataset/operation/query, the scope of limit, and a tip to reuse known schemas or next_actions calls without rediscovering. It also clarifies that this tool returns contracts, not financial records, steering agents away from misuse.

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.