HarnessTool

Generated by TypeDoc. Do not edit this page directly.

API Reference

---

Abstract Class: HarnessTool<TInput, TData>

Defined in: packages/core/src/runtime/types/tools.ts:45

Extended by

• BashTool
• ReadFileTool
• WriteFileTool
• EditFileTool
• GlobTool
• GrepTool

Type Parameters

Type Parameter	Default type
TInput	unknown
TData	unknown

Constructors

Constructor

new HarnessTool<TInput, TData>(): HarnessTool<TInput, TData>;

Returns

HarnessTool<TInput, TData>

Properties

Property	Modifier	Type	Defined in
approvalTimeoutMs?	public	number	packages/core/src/runtime/types/tools.ts:55
description	abstract	string	packages/core/src/runtime/types/tools.ts:50
label?	public	string	packages/core/src/runtime/types/tools.ts:48
name	abstract	string	packages/core/src/runtime/types/tools.ts:49
permissions?	public	ToolPermission[]	packages/core/src/runtime/types/tools.ts:53
requiresApproval?	public	| boolean | ToolApprovalResolver	packages/core/src/runtime/types/tools.ts:54
risk?	public	ToolRisk	packages/core/src/runtime/types/tools.ts:52
schema?	public	unknown	packages/core/src/runtime/types/tools.ts:51

Accessors

inputSchema

Get Signature

get inputSchema(): unknown;

Defined in: packages/core/src/runtime/types/tools.ts:61

Returns

unknown

---

type

Get Signature

get type(): string;

Defined in: packages/core/src/runtime/types/tools.ts:57

Returns

string

Methods

execute()

abstract execute(args, session):
  | AgentToolResult<TData>
| Promise<AgentToolResult<TData>>;

Defined in: packages/core/src/runtime/types/tools.ts:65

Parameters

Parameter	Type
args	TInput
session	AgentActionSession

Returns

| AgentToolResult<TData> | Promise<AgentToolResult<TData>>