Tools reference

The complete library of actions the assistant can perform, grouped by category, with their inputs, behaviour, and limits.

Users do not call tools directly. They ask a question, and the assistant picks the right tool. This reference exists so administrators and consultants understand exactly what each tool does, what it requires, and where its limits lie.

Documents

The core of day-to-day work: reading, creating, changing, and finalising records.

Tool	What it does	Key inputs	Rules & limits
get_document Read	Retrieves the full detail of one record, including all its line items.	Document type, record name	Returns every field. Requires read permission. Always returns all child rows, so large records can be verbose.
list_documents Read	Lists and filters records. The primary way to find and browse.	Document type, filters, fields, limit (default 20, max 1000), order	Permission filters apply automatically. For more than 1000 rows, use a report or database query instead.
create_document Write	Creates a new record, with the option to submit it immediately.	Document type, field values, submit flag, validate-only flag	Submittable records are created as drafts unless submit is requested. Missing required fields or duplicate unique values fail. Requires create permission.
update_document Write	Changes fields on an existing record, including line items.	Document type (always the parent), record name, fields to change	Submitted records cannot be edited directly; use an approval action. Read-only and calculated fields cannot be set. Line items can be patched, replaced, or removed.
delete_document Privileged	Deletes a record, with permission and dependency checks.	Document type, record name, force flag	Linked records block deletion unless forced. Submitted records must be cancelled first. Some system records cannot be deleted. Requires delete permission.
submit_document Write	Finalises a draft so it becomes an official record.	Document type, record name	Only works on submittable document types. Runs all validations on submit. Already-submitted records fail.

Search & discovery

Tool	What it does	Key inputs	Notes
search_documents	Searches across the main record types when the user does not know where the information lives.	Query text, limit	Covers the main record types (customers, suppliers, items, contacts, and similar). Returns names and types; follow up with a read to get detail.
search_doctype	Searches within one specific record type.	Document type, query, limit	Searches the fields configured for that record type.
search_link	Finds valid options for a linked field, like an autocomplete.	Target type, query, filters	Returns the value to use plus a readable label and context.
search (semantic)	Searches by meaning rather than exact words, using natural language.	Natural-language query	Available when semantic search is enabled for the site.
fetch	Retrieves the full content of a record found through semantic search.	Record identifier	Used as the follow-up to a semantic search.

Schema & structure

These let the assistant understand how your records are built, so it asks for the right fields.

Tool	What it does
get_doctype_info	Returns the full structure of a document type: its fields, types, required flags, linked fields, and permissions.
List document types	Lists all the record types the user can access.
Field details	Returns detailed field information including types and options.
Permission details	Returns who can access a given record type.
Workflow details	Returns the approval process and document states configured for a record type.

Reports

The recommended path for any business analysis. Covered in full in section 14.

Tool	What it does
report_list	Discovers the available reports, optionally filtered by area.
report_requirements	Explains which filters a report needs and which values are valid, before it runs.
generate_report	Runs a report and returns the data, totals, and calculations.

Approvals & workflow

Tool	What it does	Notes
run_workflow	Moves a document through an approval step: approve, reject, submit, or cancel.	The action name is exact and case-sensitive. Each step is permission-controlled by role and state.
Pending approvals	Lists documents awaiting a workflow action.	The assistant can answer "What is waiting for my approval?"
Workflow status	Reports the current approval state of a document.	n/a

Analysis

For questions that standard reports cannot answer. Covered in full in section 15.

Tool	What it does
analyze_business_data	Runs statistical analysis on a record type: profiling, statistics, trends, data quality, and correlations.
run_database_query Privileged	Runs a read-only query for advanced analysis. Restricted to administrators.
run_python_code Privileged	Runs analysis code in a secure sandbox to fetch and process data in one step.

Files

Tool	What it does
extract_file_content	Reads text and data out of uploaded files: PDFs, images (through document recognition), spreadsheets, and documents.

Dashboards

Tool	What it does
create_dashboard_chart	Creates a single chart from a record type with an aggregation.
create_dashboard	Creates a dashboard that links existing charts together.
list_user_dashboards	Lists the dashboards a user can see.

Docs