API reference
Search
Search tools exposed over the SuperBooks MCP API.
The search domain exposes 1 tool.
Tools
search_global
Scope tier: read
Cross-entity full-text search over transactions, invoices, customers, documents, and inbox items for the current team. Tokenizes the free-text query into prefix terms combined with AND (foo bar matches records containing a word starting with foo AND a word starting with bar) and ranks results by relevance. Use when the user asks an open-ended 'find anything mentioning X' question; for entity-specific search prefer the per-domain tools (documents_search, etc.). Returns an array of \{ id, type, relevance, created_at, data \} rows — data carries entity-specific fields for rendering without an extra fetch.
| Parameter | Type | Required | Description |
|---|---|---|---|
query | string | yes | Free-text query. Words are matched as prefix terms combined with AND, using English-language stemming. |
limit | integer | no | Maximum total results across all entity types (1-100). Defaults to 30. Default: 30. |
per_table_limit | integer | no | Maximum matches per entity type before results are merged and ranked (1-50). Defaults to 10. Default: 10. |
relevance_threshold | number | no | Minimum relevance score (0-1) for a row to be returned. Defaults to 0.01. Default: 0.01. |