Documentation

process_scheduled

process_scheduled MCP tool reference, parameters, return type, and safety hints.

What it does

Processes scheduled transactions in the local Clovis ledger.

Signature(through_date?: string | null, dry_run?: boolean) => Record<string, unknown>

can writedry-run

Can write, but supports dry-run. Ask the agent to preview the result before committing changes.

Use this section to decide whether the tool fits the user request before calling it.

Use it when an agent needs to prepare a change and show a preview before committing it.

Agents should gather these facts or confirmations first.

No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.

Start with dry_run=true, show the preview, then ask before applying the change.

State the intended ledger change in plain language before calling the tool.

Required inputs are marked clearly. Optional inputs can usually be omitted unless the workflow needs them.

through_dateoptional

string | null

Last date to process scheduled activity through.

Default: null

Use the exact tool name and pass arguments as structured JSON through the MCP client.

Copy this shape into agent instructions, evals, or MCP client tests.

{
  "tool": "process_scheduled",
  "arguments": {}
}

CategoryCore tools

ReturnsobjectReturns object from the local ledger.

AliasesNone