Skip to content

Novadesko Documentation

Guide Demo

English

Tools reference

The 34 tools of the Novadesko MCP server: read, prepare, send and confirm, with their parameters and the required plan feature.

Updated on 23/10/2026 Edit this page Open in the full documentation

This list is generated from Novadesko's tool registry. Schemas are strict: an unknown parameter, a wrong type or a value outside the list is refused. A feature not included in the company's plan returns a refusal that states the minimum plan and its price.

Read (read)

Tool	Parameters (* required)	Required feature	Purpose
`get_company`	none	none	Profile of the connected company, plan, active add-ons and granted scopes. Call it first.
`search_parties`	`kind*` customer \| supplier `q` string `page` integer	Customer management if kind = customer	Searches customers or suppliers.
`get_party`	`kind` customer \| supplier `id` integer	Customer management if kind = customer	Full customer or supplier record: details, checks (VAT, article 30 bis, Peppol), latest documents.
`search_documents`	`type` receipt \| invoice \| proforma \| order \| credit_note \| estimate \| purchase `q` string `paid` boolean `page` integer `from` string `to` string	none	Searches documents (quotes, purchase orders, invoices, receipts, credit notes, purchases).
`get_document`	`document_id*` integer	none	Document detail: lines, amounts, status, Peppol, accounting sync, links.
`list_products`	`q` string `page` integer	none	Products and services from the catalog.
`get_revenue`	`from` string `to` string `compare` previous_year \| previous_period \| none `group_by` month \| none	none	Revenue over a period (invoices + unconverted receipts, minus credit notes), comparison and monthly breakdown.
`get_top`	`from` string `to` string `kind` customers \| products `limit` integer	none	Top customers or products over a period.
`get_unpaid_invoices`	none	none	Unpaid invoices: balance due, days late, reminders already sent.
`get_reminders`	`document_id` integer	Payment reminders	Reminder settings and history (email and SMS).
`get_sms_credits`	none	none	Remaining SMS credits.
`get_peppol_status`	none	none	Peppol status: identifier, activation request, received and sent documents, validations, errors. Read only.
`get_accounting_sync_status`	`from` string	none	Documents synced, pending or failed with WinAuditor, WinBooks Connect, Horus and the other accounting integrations.
`get_bank_sync_status`	none	none	BankSync: accounts, last sync, unmatched transactions. Read only.
`get_import_mailbox`	none	none	Automatic import mailbox: address, received emails, imported or failed documents.
`get_document_settings`	none	none	Document settings: terms, legal notices, headers and footers, logo.
`get_business_insights`	`topic*` accounting \| vat \| bank \| purchases \| transactions \| monthly_averages \| fixed_charges \| projections \| payment_plans \| credits \| leases \| vehicles \| social_contributions \| tax_estimation \| stock \| nace	depends on topic (table below)	Management analyses computed by Novadesko (same figures as Nova AI), by topic.
`list_pending_actions`	none	none	Previews waiting for confirmation in this session.
`search`	`query*` string	none	Cross search (customers, suppliers, documents). Returns IDs to read with fetch. (MCP only)
`fetch`	`id*` string	none	Reads a search result (customer:ID, supplier:ID or document:ID). (MCP only)

Prepare (write)

Tool	Parameters (* required)	Required feature	Purpose
`prepare_party_create`	`kind*` customer \| supplier `company` string `first_name` string `last_name` string `email` string `phone` string `address` string `postal_code` string `city` string `country_code` string `vat_number` string `iban` string `is_individual` boolean	Customer management if kind = customer	Preview of a new customer or supplier (VIES, article 30 bis and Peppol checks). Saves nothing.
`prepare_party_update`	`kind` customer \| supplier `id` integer `changes*` object	Customer management if kind = customer	Preview of a change to a customer or supplier record. Saves nothing.
`prepare_document_create`	`type` estimate \| order \| invoice \| receipt \| credit_note \| proforma `customer_id` integer `date` string `due_date` string `object` string `notes` string `parent_document_id` integer `lines*` array<object>	by type: Invoicing, Purchase orders (order), Receipts (receipt)	PDF preview of a new quote, purchase order, invoice, receipt, pro forma or credit note. The legal number is assigned on confirmation.
`prepare_document_update`	`document_id*` integer `date` string `due_date` string `object` string `notes` string `lines` array<object>	none	PDF preview of a change to an editable document (not locked, not sent over Peppol). lines replaces all lines.
`prepare_document_convert`	`document_id` integer `to_type` order \| invoice \| credit_note	by to_type	Conversion preview: quote to order or invoice; order, receipt or pro forma to invoice; invoice to credit note.
`prepare_document_import`	`data` object `file_name` string `file_base64*` string `accept_inconsistencies` boolean	none	Import preview of a purchase invoice read by the AI, with the file in base64 (attachment kept). Totals and VAT are checked, no OCR credit used. (MCP only)
`prepare_settings_update`	`terms_html` string `legal_notice_html` string `footer` array<object> `header` array<object>	none	Preview (PDF for the terms) of an update to terms, legal notices, headers and footers.
`prepare_payment`	`document_id` integer `amount` number `date` string `payment_type*` string `notes` string	none	Preview of a payment recorded on an invoice, receipt or purchase: amount, date, payment method (e.g. banktransfert, cash, bankcard).
`prepare_peppol_request`	`request*` activate \| disable \| delete	Peppol activation	Preview of a Peppol request handled by the Novadesko team: activate, disable or delete. Never sends a document over Peppol.
`prepare_support_ticket`	`subject` string `message` string	none	Preview of a Novadesko support ticket, created in the user's name after confirmation.

Line object in lines: kind (product | text), product_id, name, description, quantity, unit_price_ht, vat_rate, discount_pct, html. Prices exclude VAT, vat_rate in percent. Type text: simple HTML block filtered by an allow list.

Send (send)

Tool	Parameters (* required)	Required feature	Purpose
`prepare_email`	`kind` customer \| supplier `party_id` integer `to` string `subject` string `body_html` string	none	Preview of an email to a customer or supplier, only to an address from their record.
`prepare_reminder`	`document_id` integer `channel` email \| sms \| both `subject` string `message` string `sms_message` string	Payment reminders (+ SMS sending if channel = sms or both)	Preview of an unpaid invoice reminder by email, SMS or both (SMS credits checked).

Execution

Tool	Parameters (* required)	Required feature	Purpose
`confirm_action`	`confirmation_token*` string	none	Runs a prepared action, only after the user explicitly approved the preview. Single-use token. (MCP only)
`cancel_action`	`confirmation_token*` string	none	Cancels a pending preview. (MCP only)

get_business_insights topics

topic	Content	Required feature
`accounting`	provisional profit and loss, balance sheet, cash	Detailed reports
`vat`	VAT due or recoverable, periods	VAT management
`bank`	bank cash and BankSync links	none
`purchases`	purchases, suppliers and expense categories	none
`transactions`	month's receipts by payment method	none
`monthly_averages`	average revenue and expenses over 12 months	none
`fixed_charges`	recurring fixed costs	none
`projections`	financial projections and break-even point	none
`payment_plans`	payment plans	Payment plans
`credits`	current loans	Loans
`leases`	leases and rents	Leases
`vehicles`	vehicles and vehicle cost	Logbook
`social_contributions`	social contributions	Social contributions
`tax_estimation`	tax estimate	Tax estimate
`stock`	actual stock	Stock management
`nace`	CBE activities (NACE codes)	none

Document types

estimate, order, invoice, receipt, credit_note, proforma, purchase (purchases, read only).

See also