API Reference

---

API Reference / Tool

Interface: Tool

Defined in: src/agent/Tool.ts:17

A single tool exposed to MCP clients and agent runtimes.

scope is the Policy scope required to call it; risk decides whether the call also needs the live-trading gate.

Properties

name

name: string

Defined in: src/agent/Tool.ts:18

---

description

description: string

Defined in: src/agent/Tool.ts:19

---

scope

scope: AgentScope

Defined in: src/agent/Tool.ts:20

---

risk

risk: ToolRisk

Defined in: src/agent/Tool.ts:21

---

inputSchema

inputSchema: JsonSchema

Defined in: src/agent/Tool.ts:22

---

outputSchema?

optional outputSchema?: JsonSchema

Defined in: src/agent/Tool.ts:23

---

version

version: string

Defined in: src/agent/Tool.ts:24

---

examples?

optional examples?: ToolExample[]

Defined in: src/agent/Tool.ts:25

Methods

handler()

handler(args): Promise<unknown>

Defined in: src/agent/Tool.ts:26

Parameters

args

Record<string, unknown>

Returns

Promise<unknown>