{ "source": { "name": "clovis", "version": "1.3.0", "description": "Local-first bookkeeping CLI, MCP server, and SQLite ledger engine", "license": "AGPL-3.0-or-later", "node": ">=26.3.0", "bins": { "clovis": "dist/cli/main.js", "clovis-mcp": "dist/mcp/main.js" }, "exports": { ".": { "types": "./dist/index.d.ts", "import": "./dist/index.js" }, "./core": { "types": "./dist/core/index.d.ts", "import": "./dist/core/index.js" }, "./app": { "types": "./dist/app/index.d.ts", "import": "./dist/app/index.js" }, "./mcp": { "types": "./dist/mcp/index.d.ts", "import": "./dist/mcp/index.js" } } }, "generatedBy": "apps/site/scripts/generate-clovis-docs.mjs", "server": { "name": "clovis", "transport": "stdio", "binary": "clovis-mcp", "startCommand": "CLOVIS_DB=./ledger.db clovis-mcp", "environment": [ { "name": "CLOVIS_DB", "required": true, "description": "Path to the local SQLite ledger file the agent may read or modify." } ] }, "instructions": "Use live Clovis data as the source of truth; do not answer from old chat memory when a read-only tool can check the ledger.\nPrefer QFX or OFX statement files when available because stable statement ids make duplicate detection safer; CSV remains supported as a fallback.\nCreate a statement plan before applying statement rows; inspect matches, pending-to-posted rows, stale pending rows, new rows, and ambiguous rows before committing.\nBefore using include_planned:true, inspect or reconcile realized planned rows so landed income or bills are not counted twice.\nDo not treat transfers, credit-card payments, debt movement, or balance moves as spending. Keep cash, liabilities, earmarks, income, and expenses separate.\nUse read-only tools and dry-run-capable tools before mutating the ledger. Destructive or bulk tools should be run with explicit intent.\nApplied mutations should leave an audit event and a ledger-level reversal path.", "resources": [ { "name": "clovis_operating_manual", "uri": "clovis://manual", "title": "Clovis Operating Manual", "description": "Full operational guide for using Clovis safely through CLI, app tools, and MCP.", "topic": "all" }, { "name": "clovis_statement_import_manual", "uri": "clovis://manual/statement-import", "title": "Clovis Statement Import Manual", "description": "Statement import workflow, QFX/OFX guidance, pending review, duplicate checks, and commit safety.", "topic": "statement_import" }, { "name": "clovis_month_end_manual", "uri": "clovis://manual/month-end", "title": "Clovis Month-End Manual", "description": "Month-end projection and reporting guidance for assets, liabilities, earmarks, pending rows, and budgets.", "topic": "month_end" }, { "name": "clovis_runway_manual", "uri": "clovis://manual/runway", "title": "Clovis Cash Runway Manual", "description": "Cash runway guidance for spendable cash, burn assumptions, projections, and scenario work.", "topic": "runway" }, { "name": "clovis_safety_manual", "uri": "clovis://manual/safety", "title": "Clovis Safety Manual", "description": "Agent safety guidance for read-only tools, dry-runs, backups, destructive tools, and file access.", "topic": "safety" } ], "tools": [ { "name": "account_balances", "title": "Account Balances", "category": "Ledger and accounts", "summary": "Shows posted, pending, and current balances by account and asset.", "signature": "(account_type?: string | null, asset_id?: string | null, as_of?: string | null, rollup?: boolean, hide_zero?: boolean, native_asset_only?: boolean, presentation?: string, account_ids?: string[] | null, entity_id?: string | null) => Array>", "returns": { "type": "object[]" }, "parameters": [ { "name": "account_type", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Account type filter, such as asset, liability, equity, income, or expense." }, { "name": "asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset or currency id used by the ledger." }, { "name": "as_of", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Date to calculate balances through, usually YYYY-MM-DD." }, { "name": "rollup", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "hide_zero", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Hides zero-balance rows from the response." }, { "name": "native_asset_only", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Currency or asset symbol/id." }, { "name": "presentation", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "ledger", "description": "Input used by this tool." }, { "name": "account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "List of ledger account ids or account references." }, { "name": "entity_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Entity id to filter reports when entity tracking is used." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Shows posted, pending, and current balances by account and asset.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object[] from the local ledger.", "exampleArguments": {} } }, { "name": "account_register", "title": "Account Register", "category": "Ledger and accounts", "summary": "Shows the transaction register for one account, with date, status, branch, and pagination filters.", "signature": "(account_id: string, asset_id?: string | null, date_from?: string | null, date_to?: string | null, time_from?: string | null, time_to?: string | null, branch?: string | null, status?: string | null, limit?: number, offset?: number, summary?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Ledger account id or resolvable account reference." }, { "name": "asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset or currency id used by the ledger." }, { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." }, { "name": "time_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start timestamp filter." }, { "name": "time_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End timestamp filter." }, { "name": "branch", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Scenario branch name or id." }, { "name": "status", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "limit", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 100, "description": "Maximum number of rows to return." }, { "name": "offset", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 0, "description": "Number of rows to skip before returning results." }, { "name": "summary", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Shows the transaction register for one account, with date, status, branch, and pagination filters.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: account_id." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "account_id": "" } } }, { "name": "add_match_rule", "title": "Add Match Rule", "category": "Import, review, and reconciliation", "summary": "Adds match rule in the local Clovis ledger.", "signature": "(account_id: string, pattern: string, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Ledger account id or resolvable account reference." }, { "name": "pattern", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Text or regular-expression pattern used to match descriptions." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Adds match rule in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows." ], "beforeCalling": [ "Have exact values for required inputs: account_id, pattern.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "account_id": "", "pattern": "" } } }, { "name": "add_match_rules", "title": "Add Match Rules", "category": "Import, review, and reconciliation", "summary": "Adds match rules in the local Clovis ledger.", "signature": "(rules: Array>, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "rules", "type": "object[]", "required": true, "nullable": false, "variadic": false, "description": "Match rules to create or apply." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Adds match rules in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows." ], "beforeCalling": [ "Have exact values for required inputs: rules.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "rules": [] } } }, { "name": "age_of_money", "title": "Age Of Money", "category": "Core tools", "summary": "Estimates age of money in the local Clovis ledger.", "signature": "(days?: number, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "days", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 30, "description": "Number of days to include in the calculation." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Estimates age of money in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "apply_match_rules", "title": "Apply Match Rules", "category": "Import, review, and reconciliation", "summary": "Applies saved categorization rules to pending transactions, with dry-run on by default.", "signature": "(catch_all_account_id: string, date_from?: string | null, date_to?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "catch_all_account_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Fallback category account for rows that do not match a rule." }, { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Preview the result without committing changes." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": true }, "docs": { "summary": "Applies saved categorization rules to pending transactions, with dry-run on by default.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows." ], "beforeCalling": [ "Have exact values for required inputs: catch_all_account_id.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "catch_all_account_id": "", "dry_run": true } } }, { "name": "apply_pattern", "title": "Apply Pattern", "category": "Core tools", "summary": "Recategorizes transactions that match a description pattern, optionally saving the pattern as a rule.", "signature": "(pattern: string, target_account: string, force?: boolean, persist_rule?: boolean, dry_run?: boolean, source_account?: string | null, date_from?: string | null, date_to?: string | null) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "pattern", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Text or regular-expression pattern used to match descriptions." }, { "name": "target_account", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Target category or account for the matched rows." }, { "name": "force", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Allows the operation to continue through conflicts that would otherwise stop it." }, { "name": "persist_rule", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Saves the pattern as a future match rule." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Preview the result without committing changes." }, { "name": "source_account", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Optional source account filter." }, { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": true }, "docs": { "summary": "Recategorizes transactions that match a description pattern, optionally saving the pattern as a rule.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it." ], "beforeCalling": [ "Have exact values for required inputs: pattern, target_account.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "pattern": "", "target_account": "", "dry_run": true } } }, { "name": "apply_reconciliation_plan", "title": "Apply Reconciliation Plan", "category": "Core tools", "summary": "Applies a prepared statement reconciliation plan, usually after reviewing the proposed matches and imports.", "signature": "(file_path?: string | null, plan_id?: string | null, account_id?: string | null, counterpart_account_id?: string | null, expected_balance?: number | null, currency?: string | null, asset_id?: string | null, date_col?: string | null, amount_col?: string | null, desc_col?: string | null, inflow_col?: string | null, outflow_col?: string | null, skip_rows?: number, skip_footer_rows?: number, date_format?: string, amount_convention?: string, statement_type?: string | null, balance_sign?: string | null, date_tolerance_days?: number, min_likely_score?: number, row_indexes?: number[] | null, commit_imported?: boolean, annotate_posted_matches?: boolean, allow_review_skip?: boolean, require_balance_match?: boolean, sample_limit?: number, include_details?: boolean, verbosity?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "file_path", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Local file path made available to Clovis." }, { "name": "plan_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Previously generated plan id." }, { "name": "account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Ledger account id or resolvable account reference." }, { "name": "counterpart_account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Offsetting account used for imported rows or generated transactions." }, { "name": "expected_balance", "type": "number", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement ending balance expected after reconciliation." }, { "name": "currency", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Currency symbol when the file or workflow needs an explicit currency." }, { "name": "asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset or currency id used by the ledger." }, { "name": "date_col", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement column containing transaction dates." }, { "name": "amount_col", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement column containing signed amounts." }, { "name": "desc_col", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement column containing merchant or transaction descriptions." }, { "name": "inflow_col", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement column containing incoming amounts." }, { "name": "outflow_col", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement column containing outgoing amounts." }, { "name": "skip_rows", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 0, "description": "Number of header rows to ignore at the start of a statement file." }, { "name": "skip_footer_rows", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 0, "description": "Number of footer rows to ignore at the end of a statement file." }, { "name": "date_format", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "auto", "description": "Statement date parser format, or auto for automatic parsing." }, { "name": "amount_convention", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "signed", "description": "How statement amounts should be interpreted, such as signed or inflow/outflow." }, { "name": "statement_type", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Optional statement type hint, such as checking, credit card, or brokerage." }, { "name": "balance_sign", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "date_tolerance_days", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 3, "description": "Number of days a candidate match may differ by." }, { "name": "min_likely_score", "type": "number", "required": false, "nullable": false, "variadic": false, "default": 0.72, "description": "Minimum confidence score for accepting likely reconciliation matches." }, { "name": "row_indexes", "type": "integer[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Statement row indexes to apply or inspect." }, { "name": "commit_imported", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "annotate_posted_matches", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Adds match annotations to already-posted transactions when applying the plan." }, { "name": "allow_review_skip", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Allows the workflow to proceed even when review items remain." }, { "name": "require_balance_match", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Requires the final balance to match the statement expectation." }, { "name": "sample_limit", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 20, "description": "Numeric value used by this workflow." }, { "name": "include_details", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "verbosity", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Preview the result without committing changes." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": true }, "docs": { "summary": "Applies a prepared statement reconciliation plan, usually after reviewing the proposed matches and imports.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it only for local files the user has intentionally made available to Clovis." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.", "Confirm the file path, permissions, and whether the agent is allowed to read or write that location.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "dry_run": true } } }, { "name": "apply_rollover", "title": "Apply Rollover", "category": "Core tools", "summary": "Applies rollover in the local Clovis ledger.", "signature": "(year: number, month: number, quote_asset_id: string, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Month number from 1 to 12." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Applies rollover in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it." ], "beforeCalling": [ "Have exact values for required inputs: year, month, quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "year": 1, "month": 6, "quote_asset_id": "USD" } } }, { "name": "assert_balance", "title": "Assert Balance", "category": "Ledger and accounts", "summary": "Checks balance in the local Clovis ledger.", "signature": "(account_id: string, expected: number, date?: string | null, asset_id?: string | null, status?: string | null) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Ledger account id or resolvable account reference." }, { "name": "expected", "type": "number", "required": true, "nullable": false, "variadic": false, "description": "Expected balance amount to compare with the ledger." }, { "name": "date", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Ledger date in YYYY-MM-DD format." }, { "name": "asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset or currency id used by the ledger." }, { "name": "status", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Transaction status filter or value: posted, pending, planned, or void." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Checks balance in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: account_id, expected." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "account_id": "", "expected": 1 } } }, { "name": "assert_balances", "title": "Assert Balances", "category": "Ledger and accounts", "summary": "Checks balances in the local Clovis ledger.", "signature": "(assertions: unknown[], status?: string | null) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "assertions", "type": "array", "required": true, "nullable": false, "variadic": false, "description": "Balance assertions to check against the ledger." }, { "name": "status", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Transaction status filter or value: posted, pending, planned, or void." } ], "aliases": {}, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Checks balances in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: assertions." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "assertions": [] } } }, { "name": "audit_categorization", "title": "Audit Categorization", "category": "Import, review, and reconciliation", "summary": "Audits categorization in the local Clovis ledger.", "signature": "(date_from?: string | null, date_to?: string | null, catch_all_account_id?: string | null, min_occurrences?: number, status?: string, mode?: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." }, { "name": "catch_all_account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Fallback category account for rows that do not match a rule." }, { "name": "min_occurrences", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 2, "description": "Minimum repeated occurrences required before a pattern is reported." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "mode", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "budget", "description": "Workflow mode used by the tool." } ], "aliases": {}, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Audits categorization in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": {} } }, { "name": "backup_now", "title": "Backup Now", "category": "Maintenance and safety", "summary": "Creates a local backup of the selected Clovis ledger.", "signature": "(output_path?: string | null, compact?: boolean, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "output_path", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Local output path for a generated file or backup." }, { "name": "compact", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Returns a smaller response shape when true." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Preview the result without committing changes." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates a local backup of the selected Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it before or after risky operations to back up, inspect, or repair the ledger.", "Use it only for local files the user has intentionally made available to Clovis." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope.", "Confirm the file path, permissions, and whether the agent is allowed to read or write that location.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "dry_run": true } } }, { "name": "backup_status", "title": "Backup Status", "category": "Maintenance and safety", "summary": "Shows backup configuration and recent backup state for the local ledger.", "signature": "() => Record", "returns": { "type": "object" }, "parameters": [], "aliases": {}, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Shows backup configuration and recent backup state for the local ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it before or after risky operations to back up, inspect, or repair the ledger." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": {} } }, { "name": "balance_sheet", "title": "Balance Sheet", "category": "Ledger and accounts", "summary": "Builds an assets, liabilities, and equity report for a date or scenario branch.", "signature": "(date?: string | null, branch?: string | null, compact?: boolean, include_pending?: boolean, status?: string, hide_zero?: boolean, quote_asset_id: string, account_ids?: string[] | null, entity_id?: string | null) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "date", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Ledger date in YYYY-MM-DD format." }, { "name": "branch", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Scenario branch name or id." }, { "name": "compact", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Returns a smaller response shape when true." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Includes pending transactions in the calculation." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "active", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "hide_zero", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Hides zero-balance rows from the response." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." }, { "name": "account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "List of ledger account ids or account references." }, { "name": "entity_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Entity id to filter reports when entity tracking is used." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Builds an assets, liabilities, and equity report for a date or scenario branch.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "budget_rollover_preview", "title": "Budget Rollover Preview", "category": "Import, review, and reconciliation", "summary": "Runs budget rollover preview in the local Clovis ledger.", "signature": "(year: number, month: number, include_pending?: boolean, status?: string, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Month number from 1 to 12." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Runs budget rollover preview in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it during statement import, duplicate review, matching, categorization, or reconciliation workflows." ], "beforeCalling": [ "Have exact values for required inputs: year, month, quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "year": 1, "month": 6, "quote_asset_id": "USD" } } }, { "name": "budget_status", "title": "Budget Status", "category": "Planning and cash flow", "summary": "Shows budget status in the local Clovis ledger.", "signature": "(account?: string | null, year?: number | null, month?: number | null, rollup?: boolean, include_pending?: boolean, status?: string, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Account name or id to inspect." }, { "name": "year", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Month number from 1 to 12." }, { "name": "rollup", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Shows budget status in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "budget_summary", "title": "Budget Summary", "category": "Planning and cash flow", "summary": "Summarizes budget summary in the local Clovis ledger.", "signature": "(year?: number | null, month?: number | null, include_pending?: boolean, status?: string, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Month number from 1 to 12." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Summarizes budget summary in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "buy_security", "title": "Buy Security", "category": "Assets and investments", "summary": "Records security in the local Clovis ledger.", "signature": "(account_id: string, symbol: string, shares: number, total_cost_cents: number, date: string, commission_cents?: number, status?: string, asset_id?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Ledger account id or resolvable account reference." }, { "name": "symbol", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Input used by this tool." }, { "name": "shares", "type": "number", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "total_cost_cents", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "date", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Ledger date in YYYY-MM-DD format." }, { "name": "commission_cents", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 0, "description": "Numeric value used by this workflow." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset or currency id used by the ledger." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Records security in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it for assets, prices, holdings, securities, investment activity, or foreign-exchange movement." ], "beforeCalling": [ "Have exact values for required inputs: account_id, symbol, shares, total_cost_cents, date.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "account_id": "", "symbol": "", "shares": 1, "total_cost_cents": 1, "date": "2026-06-01" } } }, { "name": "cash_flow", "title": "Cash Flow", "category": "Planning and cash flow", "summary": "Reports cash flow in the local Clovis ledger.", "signature": "(year: number, month: number, branch?: string | null, compact?: boolean, include_pending?: boolean, status?: string, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Month number from 1 to 12." }, { "name": "branch", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Scenario branch name or id." }, { "name": "compact", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Returns a smaller response shape when true." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "status", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "posted", "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Reports cash flow in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: year, month, quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "year": 1, "month": 6, "quote_asset_id": "USD" } } }, { "name": "cash_projection", "title": "Cash Projection", "category": "Planning and cash flow", "summary": "Projects cash projection in the local Clovis ledger.", "signature": "(year?: number | null, month?: number | null, asset_account_ids?: string[] | null, liability_account_ids?: string[] | null, entity_id?: string | null, earmarks?: Array> | null, include_pending?: boolean, include_planned?: boolean, planned_match_tolerance_days?: number, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Month number from 1 to 12." }, { "name": "asset_account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset account ids to include in a projection." }, { "name": "liability_account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "List of identifiers from the local Clovis ledger." }, { "name": "entity_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Entity id to filter reports when entity tracking is used." }, { "name": "earmarks", "type": "object[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "include_planned", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes planned transactions in the calculation." }, { "name": "planned_match_tolerance_days", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 3, "description": "Numeric value used by this workflow." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Projects cash projection in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "cash_runway", "title": "Cash Runway", "category": "Planning and cash flow", "summary": "Estimates how long spendable cash can cover burn, based on the selected assumptions.", "signature": "(year?: number | null, month?: number | null, as_of?: string | null, asset_account_ids?: string[] | null, liability_account_ids?: string[] | null, earmarks?: Array> | null, include_pending?: boolean, include_planned?: boolean, include_partial_month?: boolean, reserve_remaining_budget?: boolean, include_sources?: boolean, summary?: boolean, trailing_months_short?: number, trailing_months_long?: number, discretionary_multiplier?: number, quote_asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "year", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Four-digit year." }, { "name": "month", "type": "integer", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Month number from 1 to 12." }, { "name": "as_of", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Date to calculate balances through, usually YYYY-MM-DD." }, { "name": "asset_account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Asset account ids to include in a projection." }, { "name": "liability_account_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "List of identifiers from the local Clovis ledger." }, { "name": "earmarks", "type": "object[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "include_pending", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes pending transactions in the calculation." }, { "name": "include_planned", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Includes planned transactions in the calculation." }, { "name": "include_partial_month", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "reserve_remaining_budget", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Boolean switch for this workflow." }, { "name": "include_sources", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "summary", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Boolean switch for this workflow." }, { "name": "trailing_months_short", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 3, "description": "Numeric value used by this workflow." }, { "name": "trailing_months_long", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 6, "description": "Numeric value used by this workflow." }, { "name": "discretionary_multiplier", "type": "number", "required": false, "nullable": false, "variadic": false, "default": 0.5, "description": "Numeric value used by this workflow." }, { "name": "quote_asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency used to quote report values. Clovis does not infer this." } ], "aliases": { "currency": "quote_asset_id", "quote": "quote_asset_id", "quote_id": "quote_asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Estimates how long spendable cash can cover burn, based on the selected assumptions.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: quote_asset_id.", "Choose the report currency or asset explicitly; Clovis does not infer report currency." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "quote_asset_id": "USD" } } }, { "name": "close_period", "title": "Close Period", "category": "Core tools", "summary": "Closes period in the local Clovis ledger.", "signature": "(name: string, as_of: string, description?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "name", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Human-readable name to create or update." }, { "name": "as_of", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Date to calculate balances through, usually YYYY-MM-DD." }, { "name": "description", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Human-readable transaction, account, rule, or journal description." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Closes period in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it." ], "beforeCalling": [ "Have exact values for required inputs: name, as_of.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "name": "", "as_of": "2026-06-01" } } }, { "name": "commit_batch", "title": "Commit Batch", "category": "Core tools", "summary": "Commits batch in the local Clovis ledger.", "signature": "(tx_ids?: string[] | null, batch_id?: string | null, date_from?: string | null, date_to?: string | null, account_id?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "tx_ids", "type": "string[]", "required": false, "nullable": true, "variadic": false, "default": null, "description": "List of transaction ids." }, { "name": "batch_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Import, commit, or mutation batch id." }, { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." }, { "name": "account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Ledger account id or resolvable account reference." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": false, "description": "Preview the result without committing changes." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Commits batch in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it." ], "beforeCalling": [ "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "dry_run": true } } }, { "name": "compare_scenarios", "title": "Compare Scenarios", "category": "Scenarios", "summary": "Compares scenarios in the local Clovis ledger.", "signature": "(as_of_a?: string | null, as_of_b?: string | null, asset_id: string) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "as_of_a", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "as_of_b", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Input used by this tool." }, { "name": "asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency id used by the ledger." } ], "aliases": { "asset": "asset_id" }, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Compares scenarios in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when exploring or managing scenario branches separate from posted records." ], "beforeCalling": [ "Have exact values for required inputs: asset_id." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": { "asset_id": "USD" } } }, { "name": "consolidate_transfers", "title": "Consolidate Transfers", "category": "Core tools", "summary": "Consolidates transfers in the local Clovis ledger.", "signature": "(account_a: string, account_b: string, transfer_account_id?: string | null, date_tolerance_days?: number, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_a", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Account selected from the local chart of accounts." }, { "name": "account_b", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Account selected from the local chart of accounts." }, { "name": "transfer_account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Identifier from the local Clovis ledger." }, { "name": "date_tolerance_days", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 1, "description": "Number of days a candidate match may differ by." }, { "name": "dry_run", "type": "boolean", "required": false, "nullable": false, "variadic": false, "default": true, "description": "Preview the result without committing changes." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": true }, "docs": { "summary": "Consolidates transfers in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it." ], "beforeCalling": [ "Have exact values for required inputs: account_a, account_b.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "account_a": "", "account_b": "", "dry_run": true } } }, { "name": "copy_budgets", "title": "Copy Budgets", "category": "Planning and cash flow", "summary": "Copies budgets in the local Clovis ledger.", "signature": "(from_year: number, from_month: number, to_year: number, to_month: number, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "from_year", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "from_month", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "to_year", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "to_month", "type": "integer", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Copies budgets in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it for budgets, goals, forecasts, month-end projections, runway, or cash planning." ], "beforeCalling": [ "Have exact values for required inputs: from_year, from_month, to_year, to_month.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "from_year": 1, "from_month": 1, "to_year": 1, "to_month": 1 } } }, { "name": "count_transactions", "title": "Count Transactions", "category": "Ledger and accounts", "summary": "Counts transactions in the local Clovis ledger.", "signature": "(account_id?: string | null, status?: string | null, date_from?: string | null, date_to?: string | null) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "account_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Ledger account id or resolvable account reference." }, { "name": "status", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Transaction status filter or value: posted, pending, planned, or void." }, { "name": "date_from", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Start date filter in YYYY-MM-DD format." }, { "name": "date_to", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "End date filter in YYYY-MM-DD format." } ], "aliases": {}, "annotations": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false }, "safety": { "readOnlyHint": true, "destructiveHint": false, "idempotentHint": true, "openWorldHint": false, "supportsDryRun": false, "defaultDryRun": false }, "docs": { "summary": "Counts transactions in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to inspect the ledger or answer a question without changing records.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "No required inputs are needed, but date, status, asset, and account filters should still be explicit when the user cares about scope." ], "safety": "Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.", "returns": "Returns object from the local ledger.", "exampleArguments": {} } }, { "name": "create_account", "title": "Create Account", "category": "Ledger and accounts", "summary": "Creates account in the local Clovis ledger.", "signature": "(name: string, type: string, code?: string, parent_id?: string | null, color_hex?: string, default_asset_id?: string | null, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "name", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Human-readable name to create or update." }, { "name": "type", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Input used by this tool." }, { "name": "code", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "", "description": "Input used by this tool." }, { "name": "parent_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Parent account id." }, { "name": "color_hex", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "#888888", "description": "Display color for the account or asset." }, { "name": "default_asset_id", "type": "string", "required": false, "nullable": true, "variadic": false, "default": null, "description": "Identifier from the local Clovis ledger." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates account in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: name, type.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "name": "", "type": "" } } }, { "name": "create_accounts", "title": "Create Accounts", "category": "Ledger and accounts", "summary": "Creates accounts in the local Clovis ledger.", "signature": "(accounts: Array>, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "accounts", "type": "object[]", "required": true, "nullable": false, "variadic": false, "description": "Account selected from the local chart of accounts." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates accounts in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it when working with accounts, transactions, balances, registers, or double-entry records." ], "beforeCalling": [ "Have exact values for required inputs: accounts.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "accounts": [] } } }, { "name": "create_asset", "title": "Create Asset", "category": "Assets and investments", "summary": "Creates asset in the local Clovis ledger.", "signature": "(symbol: string, asset_type?: string, decimals?: number, name?: string, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "symbol", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Input used by this tool." }, { "name": "asset_type", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "currency", "description": "Currency or asset symbol/id." }, { "name": "decimals", "type": "integer", "required": false, "nullable": false, "variadic": false, "default": 2, "description": "Numeric value used by this workflow." }, { "name": "name", "type": "string", "required": false, "nullable": false, "variadic": false, "default": "", "description": "Human-readable name to create or update." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates asset in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it for assets, prices, holdings, securities, investment activity, or foreign-exchange movement." ], "beforeCalling": [ "Have exact values for required inputs: symbol.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "symbol": "" } } }, { "name": "create_branch", "title": "Create Branch", "category": "Scenarios", "summary": "Creates scenario branch in the local Clovis ledger.", "signature": "(name: string, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "name", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Human-readable name to create or update." } ], "aliases": {}, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates scenario branch in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it when exploring or managing scenario branches separate from posted records." ], "beforeCalling": [ "Have exact values for required inputs: name.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "name": "" } } }, { "name": "create_price", "title": "Create Price", "category": "Assets and investments", "summary": "Creates price in the local Clovis ledger.", "signature": "(asset_id: string, quote_id: string, rate: number, time: string, dry_run?: boolean) => Record", "returns": { "type": "object" }, "parameters": [ { "name": "asset_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Asset or currency id used by the ledger." }, { "name": "quote_id", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Identifier from the local Clovis ledger." }, { "name": "rate", "type": "number", "required": true, "nullable": false, "variadic": false, "description": "Numeric value used by this workflow." }, { "name": "time", "type": "string", "required": true, "nullable": false, "variadic": false, "description": "Input used by this tool." } ], "aliases": { "quote_asset_id": "quote_id", "quote": "quote_id", "asset": "asset_id" }, "annotations": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false }, "safety": { "readOnlyHint": false, "destructiveHint": false, "idempotentHint": false, "openWorldHint": false, "supportsDryRun": true, "defaultDryRun": false }, "docs": { "summary": "Creates price in the local Clovis ledger.", "useWhen": [ "Use it when an agent needs to prepare a change and show a preview before committing it.", "Use it for assets, prices, holdings, securities, investment activity, or foreign-exchange movement." ], "beforeCalling": [ "Have exact values for required inputs: asset_id, quote_id, rate, time.", "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." ], "safety": "Can write, but supports dry-run. Ask the agent to preview the result before committing changes.", "returns": "Returns object from the local ledger.", "exampleArguments": { "asset_id": "USD", "quote_id": "USD", "rate": 1, "time": "