Skip to main content
Glama

Query Candor data

candor_query

Run one limited query against a declared financial dataset in the Candor API. The full response returns in this tool result; use limit and cursor pagination to keep each page bounded. A cursor is bound to the exact filters of the page that issued it, so replay the returned next_actions call unchanged. This read records private action history and audit events without changing financial records. Run one bounded query against a declared financial dataset. Inspect the selected dataset schema for accepted filters and defaults; omitting filters uses those defaults. Cursor-paginated results keep records, calculations, and pagination under data.page. Calculations cover exactly the returned records, not later pages or the full workspace. Follow next_actions for the exact continuation, preserving the query filters.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
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.
datasetYesDeclared dataset to read. Inspect its schema when its fields or filters are unfamiliar.
filtersNoDataset query filters declared by candor_schema({dataset}), including supported limit and cursor fields. Omit to use that dataset's defaults. Do not put action context here.
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, 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. Changed7 schema fields changed
    • addedInput schema / properties / dataset / description
      Added value: +"Declared dataset to read. Inspect its schema when its fields or filters are unfamiliar."
    • 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: +"Dataset query filters declared by candor_schema({dataset}), including supported limit and cursor fields. Omit to use that dataset's defaults. Do not put action context here."
    • 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",
      -  "dataset"
      -]New value: +[
      +  "dataset"
      +]
  2. Changed4 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"
      +]
    • 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"
      -}
  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. 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"
      +}
  7. 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"
  8. First observed

TDQS

A3.7/5.0
Behavior4/5

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

With annotations all set to false/negative, the description carries the responsibility and it does well: it discloses that reads are recorded in private action history and audit events, that financial records are not changed, and that an op cursor is bound to the exact filters of the page that issued it. It also explains that calculations cover only the returned records, not later pages.

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

Conciseness3/5

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

The description is front-loaded and substantive, but it repeats the core instruction ('Run one limited query...' and then 'Run one bounded query...') and states cursor/pagination guidance multiple times. It is redundant enough to cost it a higher score.

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?

For a tool with five parameters, one required parameter, an output schema, and non-helpful annotations, the description is largely complete: it covers the single-query constraint, filter defaults, cursor pagination, action-history side effects, and next_action continuation. It does not cover authorization or rate limits, but that is a minor gap given its complexity.

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 input schema already describes all parameters at 100% coverage, so the baseline is 3. The description raises the score by adding important behavioral guidance around parameters: cursor binding, replaying next_actions unchanged, filter defaults, and pagination placement under data.page.

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?

The description clearly states the tool's action and scope: 'Run one limited query against a declared financial dataset in the Candor API' and clarifies it is a read that does not change financial records. It does not explicitly compare itself with sibling tools such as candor_get or candor_schema, so it misses the strongest distinction-level guidance.

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

Usage Guidelines3/5

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

The description provides implied usage guidance: inspect the selected dataset schema, omit filters to use defaults, use limit/cursor pagination, and follow next_actions for continuation. It does not state explicit when-to-use/when-not-to-use rules versus sibling tools, so the guidance is useful but not fully explicit.

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.