ToolDisplay
ToolDisplay =
object
Defined in: types/plugin-types/index.ts:62
The user-facing channel of a tool result: structured output destined for the
user and — unlike data — never placed into the model’s context. type
names the kind of data (e.g. “issue-list”): the key an instance’s formatter
rules are looked up by, so a plugin should export the kinds it emits as a
type mapping each kind to its item shape. items are its entries. Kept deliberately generic here so it serves any plugin (a CLI
post-processor today, an endpoint/MCP plugin later), not just CLI results.
The core strips it before the result reaches the model (see the core’s
toModelOutput) and renders it separately for the user.
Properties
Section titled “Properties”items:
unknown[]
Defined in: types/plugin-types/index.ts:62
type:
string
Defined in: types/plugin-types/index.ts:62