Skip to main content
Glama

Build Candor snapshot

candor_snapshot

Returns an explicitly scoped analytical snapshot built from the requested snapshot datasets and filters, in one response. Use when an analysis needs several datasets together, such as a spending review across accounts. Only datasets declared as snapshot datasets in the Candor schema are available. Dataset reads are recorded in private action history; financial records are not changed.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
reasonNoConcise user-visible purpose recorded in immutable action history, including for financial reads. It names the task, such as "Check this month's dining budget", and needs no personal details from the conversation. 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.
filtersNoShared filters applied to each selected dataset query. Inspect each dataset schema for supported fields; omit for per-dataset defaults. The dataset selector is supplied by datasets.
datasetsYesUnique declared datasets to include in this analytical snapshot; select only those needed for the analysis.
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.
parent_actionNoExisting action id in this workspace, typically returned in next_actions, that this continuation follows. A continuation with the parent's reason joins the parent's root action, whether the reason is omitted (it is then inherited) or repeated exactly; a distinct explicit reason is preserved and starts a new root that keeps this parent link. Fixed-reason orientation operations always start a new root. 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. Changed1 schema field changed
    • changedInput schema / properties / parent_action / description
      Previous 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."New value: +"Existing action id in this workspace, typically returned in next_actions, that this continuation follows. A continuation with the parent's reason joins the parent's root action, whether the reason is omitted (it is then inherited) or repeated exactly; a distinct explicit reason is preserved and starts a new root that keeps this parent link. Fixed-reason orientation operations always start a new root. Omit for a new root action."
  2. Changed2 schema fields changed
    • changedInput schema / properties / datasets / items / enum
      Previous value: -[
      -  "properties",
      -  "accounts",
      -  "balances",
      -  "account_terms",
      -  "transactions",
      -  "coverage",
      -  "recurring",
      -  "holdings",
      -  "holding_valuations",
      -  "investment_transactions",
      -  "budgets",
      -  "goals",
      -  "rules",
      -  "categories",
      -  "changes",
      -  "actions"
      -]New value: +[
      +  "properties",
      +  "accounts",
      +  "balances",
      +  "account_terms",
      +  "transactions",
      +  "coverage",
      +  "recurring",
      +  "holdings",
      +  "holding_valuations",
      +  "investment_transactions",
      +  "budgets",
      +  "goals",
      +  "rules",
      +  "categories",
      +  "cashflow",
      +  "changes",
      +  "actions"
      +]
    • changedInput schema / properties / datasets / maxItems
      Previous value: -16New value: +17
  3. Changed1 schema field changed
    • changedInput schema / properties / reason / description
      Previous 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."New value: +"Concise user-visible purpose recorded in immutable action history, including for financial reads. It names the task, such as \"Check this month's dining budget\", and needs no personal details from the conversation. 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."
  4. Changed7 schema fields changed
    • addedInput schema / properties / datasets / description
      Added value: +"Unique declared datasets to include in this analytical snapshot; select only those needed for the analysis."
    • changedInput schema / properties / filters / description
      Previous value: -"Arguments listed in accepted_args by candor_schema for the selected operation, including declared shorthand such as open.acknowledge checkpoint. Put action context such as parent_action at the top level, including when it comes from a returned next action. Request-body fields belong in input unless the operation explicitly accepts them as shorthand args."New value: +"Shared filters applied to each selected dataset query. Inspect each dataset schema for supported fields; omit for per-dataset defaults. The dataset selector is supplied by datasets."
    • 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 / 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."
    • 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."
    • changedInput schema / required
      Previous value: -[
      -  "reason",
      -  "datasets"
      -]New value: +[
      +  "datasets"
      +]
  5. Changed5 schema fields changed
    • changedInput schema / properties / datasets / items / 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"
      +]
    • changedInput schema / properties / datasets / maxItems
      Previous value: -13New value: +16
    • changedInput schema / properties / filters / description
      Previous value: -"Path and query arguments declared by the selected operation. Do not put request-body fields here."New value: +"Arguments listed in accepted_args by candor_schema for the selected operation, including declared shorthand such as open.acknowledge checkpoint. Put action context such as parent_action at the top level, including when it comes from a returned next action. Request-body fields belong in input unless the operation explicitly accepts them as shorthand args."
    • addedOutput schema / properties / metadata / properties
      Added value: +{
      +  "view_url": {
      +    "format": "uri",
      +    "type": "string"
      +  }
      +}
    • removedOutput schema / properties / metadata / propertyNames
      Removed value: -{
      -  "type": "string"
      -}
  6. Changed1 schema field changed
    • addedOutput schema / properties / metadata
      Added value: +{
      +  "additionalProperties": {},
      +  "propertyNames": {
      +    "type": "string"
      +  },
      +  "type": "object"
      +}
  7. 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"
      +]
  8. Changed4 schema fields changed
    • changedInput schema / properties / datasets / items / 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"
      +]
    • changedInput schema / properties / datasets / maxItems
      Previous value: -15New value: +13
    • 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"
      -}
  9. Changed2 schema fields changed
    • 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"
      +}
  10. Changed4 schema fields changed
    • addedInput 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"
      +      }
      +    ]
      +  }
      +}
    • addedInput schema / properties / filters / additionalProperties / $ref
      Added value: +"#/$defs/__schema0"
    • 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"
  11. First observed

TDQS

A4/5.0
Behavior4/5

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

Annotations supply the safety profile (destructiveHint=false, openWorldHint=false), and the description usefully adds that dataset reads are recorded in private action history and that financial records are not changed. That explains the non-obvious readOnlyHint=false side effect, which the structured annotations alone leave ambiguous. It does not cover rate limits or response size, keeping it short of a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Four tight sentences with the core behavior front-loaded, followed by usage, dataset restriction, and the side-effect/no-mutation note. No filler or repetition of the schema contents.

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?

An output schema exists, so return values need no explanation, and the description covers the dataset eligibility rule and the action-history side effect for a 5-parameter, nested-object tool. It stops short of noting limits on dataset count or snapshot size, which would matter at 17 datasets.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

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

Schema description coverage is 100%, so datasets, filters, reason, task_key and parent_action are already documented in-schema; baseline is 3. The description adds one meaningful constraint — only datasets declared as snapshot datasets in the Candor schema are selectable — but no filter syntax or dataset-combination guidance beyond what the schema provides.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Names a specific verb and resource ('returns an explicitly scoped analytical snapshot') and clarifies scope ('built from the requested snapshot datasets and filters, in one response'). It conveys the multi-dataset nature that separates it from a single-dataset read, but never names the sibling (e.g. candor_query) that an agent must choose against, so differentiation is implicit rather than explicit.

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?

Gives a clear triggering context: 'Use when an analysis needs several datasets together, such as a spending review across accounts.' That is a genuine when-to-use signal, but there are no exclusions and no alternative tool is named for the single-dataset or non-snapshot case, so the agent still has to infer the boundary with candor_query.

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.