Documentation

detect_recurring

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

npm

What it does

Detects recurring activity in the local Clovis ledger.

Signature(months?: number, year?: number | null, month?: number | null, min_occurrences?: number, amount_tolerance_pct?: number, account_id?: string | null) => Array<Record<string, unknown>>
read-only

Read-only. This is appropriate for inspection, reporting, diagnostics, and first-pass agent answers.

When to use it

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

Use it when an agent needs to inspect the ledger or answer a question without changing records.

Before calling

Agents should gather these facts or confirmations first.

1

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

Parameters

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

monthsoptional
integer

Numeric value used by this workflow.

Default: 6
yearoptional
integer | null

Four-digit year.

Default: null
monthoptional
integer | null

Month number from 1 to 12.

Default: null
min_occurrencesoptional
integer

Minimum repeated occurrences required before a pattern is reported.

Default: 2
amount_tolerance_pctoptional
number

Percent difference allowed when matching similar amounts.

Default: 5
account_idoptional
string | null

Ledger account id or resolvable account reference.

Default: null

Agent call shape

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

detect_recurring

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

{
  "tool": "detect_recurring",
  "arguments": {}
}

Metadata