Skip to main content

Tools

Tools are how the assistant reads the claim. Each is a provider-neutral JSON-schema definition plus a run() that executes in the Worker against the one claim in the request (api/src/capabilities/). Every tool is offered on every turn (the one screen action only when the caller can perform it), shared readers first so the prompt-cache prefix stays stable; a capability "owns" a tool only in the sense that its playbook tells the model to call it first. There are 16 tools: 5 shared and 11 owned by capabilities.

Generated from the code

This page is generated by docusaurus/scripts/generate-reference.ts from the source it describes. Edit the source, then run npm run docs:reference.

Shared tools​

get_claim_section​

Read one section of the claim record in full. Use this whenever you need detail beyond the brief in your instructions — e.g. policy wording, the diary, payments, documents, tasks, risk flags.

Shared: available on every turn

ParameterTypeRequiredDescription
sectionclient · policy · claimant · incident · loss · diagnosis · adjuster · statusHistory · dates · financials · payments · reimbursements · recovery · involvements · serviceProviders · litigation · investigation · riskFlags · compliance · feedback · diary · tasks · documents · miyesWhich section of the claim to read.

search_claim​

Keyword search across the diary, documents, tasks, investigation findings and risk flags. Returns matching entries with their section. Use for "when did…", "has anyone…", "is there a letter about…".

Shared: available on every turn

ParameterTypeRequiredDescription
querystringyesOne or more keywords (case-insensitive).

get_document​

Read one document on the claim by its id (e.g. DOC-4). Returns the document metadata and its content summary.

Shared: available on every turn

ParameterTypeRequiredDescription
documentIdstringyes

financial_summary​

Compute the money position: reserves, paid, incurred and outstanding by head (indemnity/expense/legal) and by coverage; loss estimate vs reserve; pending/issued payments; provider bills in review.

Shared: available on every turn

No parameters.

highlight_panel​

Draw the user’s eye to a panel on the claim screen (it pulses briefly). Use when your answer refers to something on screen — e.g. highlight "finance" when discussing reserves, "schedule_table" for tasks, "system_checks" for risk flags.

Shared: available on every turn · Screen action: offered only when the caller sets screenActions (see Embedding)

ParameterTypeRequiredDescription
panelhome · schedule · documents · finance · involvements · proceedings · strategy · finance_resolution · mi · system_checks · key_facts · schedule_table · proceedings_table · notesyes

Capability tools​

build_timeline​

Assemble every dated event on the claim — status changes, diary entries, documents, payments, tasks (due/done), investigation findings, hearings, deadlines — into one chronological list. Call this before writing a timeline or a handover.

Owned by: timeline

No parameters.

claim_metrics​

Compute the claim’s numbers for data insights: days open, days to report/assign, reserve vs paid vs loss estimate, spend by head and by payee, provider bill totals and discount rates, diary activity by month, task completion, and SLA performance against the client rules.

Owned by: data_insights

No parameters.

check_policy_in_force​

Deterministic check: compares the date of loss with the policy period and state, matches loss items to coverages, and lists limits/deductibles, conditions, exclusions and endorsements. Call this first when validating cover.

Owned by: policy_validation

No parameters.

list_deadlines​

List every dated obligation on the claim — open tasks, regulatory deadlines, hearings, RTW dates, SLA checkpoints — sorted by date with days remaining (negative = overdue). Call this before recommending next actions.

Owned by: next_actions

No parameters.

settlement_position​

Gather everything relevant to settling: loss items by head, offers and counter-offers found in the diary/documents, the injury and prognosis, wage evidence, liability position and split, litigation stage, costs to date, authority limits, and the reserve. Call this before giving settlement or negotiation guidance.

Owned by: settlement_guidance, litigation_risk

No parameters.

run_risk_cross_checks​

Deterministic fraud/leakage cross-checks: duplicate or near-duplicate payments and provider bills, off-panel providers, reporting lag, payments above the handler’s authority approved by the handler, proximity of the loss to policy inception, witness/police evidence, and existing risk flags. Call this first in a fraud check.

Owned by: fraud_check

No parameters.

scan_vulnerability_signals​

Sweep the diary, documents, complaints, claimant details and incident narrative for phrases suggesting customer vulnerability under the FCA’s four drivers (health, life events, resilience, capability). Returns each hit with the verbatim text so nothing is flagged without evidence. Call this first in a vulnerable customer check.

Owned by: vulnerable_customer

No parameters.

scan_expressions_of_dissatisfaction​

Sweep diary entries, documents and logged complaints for expressions of dissatisfaction, with the verbatim text and date of each, and compute the regulatory clocks (3 business days for summary resolution, 8 weeks for a final response) from the earliest expression. Call this first in complaints guidance.

Owned by: complaints_guidance

No parameters.

run_handling_checks​

Mechanical QA checks against the client’s SLAs and rules: acknowledgement and first-contact timing, reserve review cadence, overdue tasks, missed regulatory deadlines, payments approved within authority, documents referred to in the diary, and the gap since the last diary entry. Call this first in a QA review.

Owned by: qa_review

No parameters.

get_party​

Look up a party on the claim by name, role or organisation (claimant, policyholder, solicitor, insurer, provider, witness, court…). Returns their involvement record, contact details where held, reference numbers, and every diary entry and document that mentions them. Use before drafting to, calling, or briefing about someone.

Owned by: document_production, call_assist, field_visit_briefing

ParameterTypeRequiredDescription
querystringyesA name, role (e.g. "solicitor") or organisation.

list_capabilities​

Return the catalogue of what the assistant can do for a claim — grouped, with a one-line description and the phrase that triggers each. Use when the handler asks what you can do, how to ask for something, or whether you can help with a kind of task.

Owned by: capabilities_briefing

No parameters.