Skip to content

Function: suggest()

ts
function suggest(tool, reason): ActionSuggestion;

Defined in: packages/core/src/presenter/suggest.ts:39

Create an action suggestion for HATEOAS-style agent guidance.

Fluent alternative to { tool: '...', reason: '...' } config objects. Reads like suggest(what, why) — zero ceremony.

Parameters

ParameterTypeDescription
toolstringTool name to suggest (e.g. 'billing.pay')
reasonstringHuman-readable reason for the suggestion

Returns

ActionSuggestion

An ActionSuggestion object

Example

typescript
suggest('projects.archive', 'Archive this inactive project')
// → { tool: 'projects.archive', reason: 'Archive this inactive project' }