Skip to main content
Glama

Inspect Candor schema

candor_schema

Returns Candor API contracts, not financial records. Use when a dataset's filters or an operation's arguments are not already known. With no selector it returns the workspace schema index; dataset returns one dataset's fields, filters, and coverage contract; operation returns one operation's accepted arguments, input schema, and call shape; query searches the operation catalog, with limit up to 10 (default 10). dataset, operation, and query are mutually exclusive. Workspace and dataset schema reads are recorded in private action history; catalog searches and operation descriptions are local lookups. API reference: https://candor.money/developers

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMaximum operation search matches; default 10. Valid only with query.
queryNoText to search operation names and capability descriptions; results list operation ids. Cannot be combined with dataset or operation.
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.
datasetNoOne dataset whose fields, supported query filters, and coverage contract to return. With no selector, the workspace schema index is returned.
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.
operationNoOne exact operation id whose accepted_args with each query argument's type, allowed values, and meaning (arg_details), input_schema when applicable, and invocation shape to return. Cannot be combined with dataset or query.
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. Changed2 schema fields changed
    • changedInput schema / properties / operation / description
      Previous value: -"One exact operation id whose accepted_args, input_schema when applicable, and invocation shape to return. Cannot be combined with dataset or query."New value: +"One exact operation id whose accepted_args with each query argument's type, allowed values, and meaning (arg_details), input_schema when applicable, and invocation shape to return. Cannot be combined with dataset or query."
    • 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. Changed1 schema field changed
    • changedInput schema / properties / dataset / 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"
      +]
  3. Changed4 schema fields changed
    • changedInput schema / properties / dataset / description
      Previous value: -"Inspect one dataset: fields, supported query filters, and coverage contract. Omit all selectors for the workspace schema index."New value: +"One dataset whose fields, supported query filters, and coverage contract to return. With no selector, the workspace schema index is returned."
    • changedInput schema / properties / operation / description
      Previous value: -"Describe one exact operation id, including accepted_args, input_schema when applicable, and invocation shape. Do not combine with dataset or query."New value: +"One exact operation id whose accepted_args, input_schema when applicable, and invocation shape to return. Cannot be combined with dataset or query."
    • changedInput schema / properties / query / description
      Previous 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."New value: +"Text to search operation names and capability descriptions; results list operation ids. Cannot be combined with dataset or operation."
    • 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. 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."
  5. 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"
      -}
  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. 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"
      -}
  9. 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"
      +}
  10. 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"
  11. First observed

TDQS

A4.6/5.0
Behavior5/5

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

Annotations declare readOnlyHint=false, which is counterintuitive for a schema-inspection tool; the description resolves that tension by disclosing that workspace and dataset schema reads are recorded in private action history while catalog searches and operation descriptions are local lookups. That side-effect split is behavioral context annotations cannot express.

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?

A single dense paragraph, but front-loaded with purpose and usage before mode enumeration and side effects. Semicolon-separated clauses keep it scannable, though the run-on structure costs a point versus crisper sentence breaks.

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, multi-mode inspection tool with an output schema present, the description covers purpose, trigger condition, mode exclusivity, defaults, side-effect semantics, and an external API reference. 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.

Parameters3/5

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

Schema description coverage is 100% and every parameter is already documented in the schema, including limit's default/ceiling and the mutual-exclusivity rules. The description mostly restates those facts ('limit up to 10 (default 10)', 'mutually exclusive') rather than adding format or interaction detail, so the baseline 3 applies.

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?

Opens with a specific verb+resource plus a disambiguating negation ('Returns Candor API contracts, not financial records'), then enumerates the four selector modes and what each returns. An agent can distinguish it from candor_query or candor_get without opening any schema.

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?

'Use when a dataset's filters or an operation's arguments are not already known' states the triggering condition explicitly, and 'dataset, operation, and query are mutually exclusive' plus the no-selector default removes all routing ambiguity. It also names the correct entry point for each discovery need.

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.