Skip to content

tool

FieldValue
Prefixtool
Namespace constantToolNamespace
Subjects constantToolSubjects
Kindbus
Schema recordToolSchemas
Tierframework
Package@makaio/contracts
Defined inpackages/contracts/src/tool/namespace.ts
KeyWireTypeSchema
completedtool.completedeventschemas.ts
errortool.erroreventschemas.ts
executetool.executerpcschemas.ts
listtool.listrpcschemas.ts
registeredtool.registeredeventschemas.ts
registryChangedtool.registryChangedeventschemas.ts
startedtool.startedeventschemas.ts

Tool execution completed successfully.

Subject: tool.completed Type: Event (fire-and-forget) Emitted when: A tool finishes execution successfully.

FieldTypeRequired
durationMsnumberyes
executionIdstringyes
timestampnumberyes
toolNamestringyes
toolsetNamestringyes

Tool execution error.

Subject: tool.error Type: Event (fire-and-forget) Emitted when: A tool encounters an error during execution.

FieldTypeRequired
error{ code: string; message: string; details?: unknown; }yes
executionIdstringyes
timestampnumberyes
toolNamestringyes
toolsetNamestringyes

Execute a tool.

Subject: tool.execute Type: Request (RPC) Purpose: Execute a tool with given input and return the result.

Request:

FieldTypeRequired
adapterIdstring | undefinedno
adapterNamestring | undefinedno
contextOverrides{ cwd?: string | undefined; env?: Record<string, string> | undefined; sessionId?: string | undefined; agentId?: string | undefined; adapterId?: string | undefined; adapterName?: string | undefined; turnId?: string | undefined; turnContext?: Record<string, unknown> | undefined; reasoning?: string | undefined; toolCallId?: string | undefined; constraints?: Record<string, unknown> | undefined; } | undefinedno
inputunknownyes
toolNamestringyes

Response:

FieldTypeRequired
successbooleanyes

List all registered tools.

Subject: tool.list Type: Request (RPC) Purpose: Returns definitions for all registered tools including input schemas.

Request:

FieldTypeRequired
adapterIdstring | undefinedno
adapterNamestring | undefinedno
toolsetNamestring | undefinedno

Response:

FieldTypeRequired
tools{ name: string; description: string; toolsetName: string; annotations?: { readOnly?: boolean | undefined; destructive?: boolean | undefined; idempotent?: boolean | undefined; requiresApproval?: boolean | undefined; } | undefined; inputSchema?: Record<string, unknown> | undefined; }[]yes
toolsets{ name: string; description: string; version: string; toolCount: number; configSchema?: Record<string, unknown> | undefined; }[]yes

Toolset registered event.

Subject: tool.registered Type: Event (fire-and-forget) Emitted when: A toolset is registered with the registry. Emits once per toolset with all tool names.

FieldTypeRequired
toolNamesstring[]yes
toolsetNamestringyes
toolsetVersionstringyes

Tool registry changed event.

Subject: tool.registryChanged Type: Event (fire-and-forget) Emitted when: A toolset is registered or unregistered, or a plugin is loaded/unloaded. Used by consumers (e.g., MCP server) to invalidate stale tool lists.

FieldTypeRequired
reason"toolset-registered" | "toolset-unregistered" | "plugin-loaded" | "plugin-unloaded"yes
revisionnumberyes
toolsetNamestringyes

Tool execution started.

Subject: tool.started Type: Event (fire-and-forget) Emitted when: A tool begins execution.

FieldTypeRequired
executionIdstringyes
timestampnumberyes
toolNamestringyes
toolsetNamestringyes

Auto-generated by yarn docs:bus. Do not edit manually.