Tool reference

Ten read-only tools. You never call these yourself — the assistant does, based on what you ask — but knowing what they accept explains why some questions are answered precisely and others need a follow-up.

Every tool returns a page of results plus a paginatorInfo object holding the total count, and every tool is scoped to your own account by the server.

Shared parameters

All ten accept these:

Parameter	Notes
`page`	Page number, from 1
`page_size`	Results per page, maximum 100
`search`	Case-insensitive keyword search
`sort_by`	Column to sort on, e.g. `created_at`, `name`
`sort_order`	`asc` or `desc`
`filter`	A condition tree for ranges, OR-groups and negations

filter is the escape hatch for questions the flat parameters cannot express — "costs over £500 that weren't fuel", for example. The assistant builds it; you do not need to.

How records link together

This is worth understanding, because it is why one question can produce several lookups.

Records reference each other by uuid:

A boat's uuid is the boat_detail_uuid on trips, tasks, inventory, costs, logs and alerts.
A location's uuid is the location_uuid on inventory.
A category's uuid is the category_uuid on inventory, costs, checklists and tasks.
A trip's uuid is the trip_uuid on costs, checklists and logs.

So "what's overdue on Serenity?" is two calls: list_boats with search: "Serenity" to resolve the name into a uuid, then list_tasks with that uuid and type: "overdue".

list_boats

Your boats. The hub record — most other questions start here.

Parameter	Notes
`search`	Boat name, or catalogue model and version
`type`	Catalogue boat type, e.g. sailboat
`hull_type`, `hull_material`	From the catalogue record
`keel_type`	From the catalogue record
`year_min`, `year_max`	Year built
`flag`	Registration flag or country
`acquisition_type`	How the boat was acquired
`status`	`"true"` or `"false"`

list_trips

Trips, past and current.

Parameter	Notes
`boat_detail_uuid`	Limit to one boat
`start_date`, `end_date`	Trips starting in a date range (`YYYY-MM-DD`)
`active`	Trips currently underway

list_tasks

Maintenance and to-do tasks.

Parameter	Notes
`type`	`upcoming`, `overdue` or `completed`
`boat_detail_uuid`	Limit to one boat
`category_uuid`	Limit to one category
`due_date_start`, `due_date_end`	Due-date range — both required together
`status`, `priority`	Exact values

list_inventory

Spare parts, equipment and consumables.

Parameter	Notes
`boat_detail_uuid`	Limit to one boat
`location_uuid`	Limit to one storage location
`category_uuid`	Limit to one category
`type`	Exact inventory type
`quantity_min`, `quantity_max`	Quantity range — how "what am I low on?" is answered
`start_date`, `end_date`	Matches any tracked date: expiry, usage-due, warranty, acquisition

The date range on inventory is deliberately broad — it matches an item if any of its tracked dates falls inside the window. For the date an item was added instead, the assistant uses filter on created_at.

list_costs

Costs and expenses.

Parameter	Notes
`boat_detail_uuid`	Limit to one boat
`category_uuid`	Limit to one category
`trip_uuid`	Costs linked to one trip
`type`	Exact cost type
`amount_min`, `amount_max`	Amount range
`start_date`, `end_date`	Date range

Totals are computed by summing the amount field across results, so a "what did I spend" question over a large range may take several pages.

list_checklists

Your own checklists — pre-departure, maintenance, and any you have created.

Parameter	Notes
`category_uuid`	Limit to one category
`trip_uuid`	Checklists linked to one trip

This does not cover the public checklist library, only checklists in your account.

list_logs

Logbook entries, covering trips, operations and usage.

Parameter	Notes
`boat_detail_uuid`	Limit to one boat
`trip_uuid`	Logs for one trip
`expense_uuid`	Logs linked to one inventory item
`type`	Exact log type
`start_date`, `end_date`	Date range

list_alerts

Due, overdue, warranty, expiry and low-stock notices. Each alert hangs off another record.

Parameter	Notes
`boat_detail_uuid`	Limit to one boat
`type`	The kind of record it is attached to: `task`, `file`, `expense`, `cost`, `log`, `trip`
`status`	`active`, `disabled`, `raised` or `completed`
`priority`	`1`, `2` or `3`
`due_date_start`, `due_date_end`	Due-date range — both required together

expense here means an inventory item.

list_locations

Storage locations. Resolves a name like "the engine room locker" into the uuid that filters inventory.

Parameter	Notes
`is_sub_location`	`"true"` to list nested sub-locations. Defaults to `"false"`

Only top-level locations are returned by default, which is why a question about a locker inside a cabin can need a second lookup.

Categories available to you — your own plus the built-in shared ones.

Parameter	Notes
`type`	The module: `expense` (inventory), `cost`, `task`, `checklist` or `log`

Categories are per-module, so the same name can exist separately for costs and for tasks. expense is the inventory module — see the naming note.