GlobTool
Generated by TypeDoc. Do not edit this page directly.
Class: GlobTool
Section titled “Class: GlobTool”Defined in: packages/tools-node/src/files.ts:173
Extends
Section titled “Extends”HarnessTool<GlobInput, {files:string[]; }>
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new GlobTool(): GlobTool;Returns
Section titled “Returns”GlobTool
Inherited from
Section titled “Inherited from”Properties
Section titled “Properties”| Property | Type | Default value | Overrides | Inherited from | Defined in |
|---|---|---|---|---|---|
approvalTimeoutMs? | number | undefined | - | HarnessTool.approvalTimeoutMs | packages/core/src/runtime/types/tools.ts:55 |
description | string | "List files under workDir matching a simple glob pattern such as '**/*.ts'." | HarnessTool.description | - | packages/tools-node/src/files.ts:175 |
label? | string | undefined | - | HarnessTool.label | packages/core/src/runtime/types/tools.ts:48 |
name | string | "glob" | HarnessTool.name | - | packages/tools-node/src/files.ts:174 |
permissions | object[] | undefined | HarnessTool.permissions | - | packages/tools-node/src/files.ts:178 |
requiresApproval? | | boolean | ToolApprovalResolver | undefined | - | HarnessTool.requiresApproval | packages/core/src/runtime/types/tools.ts:54 |
risk | "read" | undefined | HarnessTool.risk | - | packages/tools-node/src/files.ts:177 |
schema | ObjectSchema<{ maxResults: DefaultSchema<unknown, number>; pattern: DefaultSchema<unknown, string>; }> | globSchema | HarnessTool.schema | - | packages/tools-node/src/files.ts:176 |
Accessors
Section titled “Accessors”inputSchema
Section titled “inputSchema”Get Signature
Section titled “Get Signature”get inputSchema(): unknown;Defined in: packages/core/src/runtime/types/tools.ts:61
Returns
Section titled “Returns”unknown
Inherited from
Section titled “Inherited from”Get Signature
Section titled “Get Signature”get type(): string;Defined in: packages/core/src/runtime/types/tools.ts:57
Returns
Section titled “Returns”string
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”execute()
Section titled “execute()”execute(args, session): Promise<AgentToolResult<{ files: string[];}>>;Defined in: packages/tools-node/src/files.ts:180
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
args | ObjectInput |
session | AgentActionSession |
Returns
Section titled “Returns”Promise<AgentToolResult<{
files: string[];
}>>