Function: toonSuccess()
ts
function toonSuccess(data, options?): ToolResponse;Defined in: packages/core/src/core/response.ts:226
Create a success response with TOON-encoded payload.
Encodes structured data using TOON (Token-Oriented Object Notation) for ~40-50% token reduction compared to JSON.stringify(). Ideal for list/tabular responses (arrays of uniform objects).
Parameters
| Parameter | Type | Description |
|---|---|---|
data | unknown | Any JSON-serializable value (objects, arrays, primitives) |
options? | EncodeOptions | Optional TOON encode options (default: pipe delimiter) |
Returns
A ToolResponse with TOON-encoded text
Example
typescript
// Array response — saves ~40% tokens vs JSON
const users = await db.users.findMany();
return toonSuccess(users);
// Output: "id|name|email\n1|Alice|alice@co.io\n2|Bob|bob@co.io"
// With custom delimiter
return toonSuccess(data, { delimiter: ',' });
// Single object (still valid, but savings are smaller)
return toonSuccess({ id: 1, name: 'Alice' });See
success for standard JSON responses