ToolRuntime

SUPPORT · interface · 类型合同

Catalog bound to one App request.

导入

TypeScript

import type { ToolRuntime } from '@jangts/agent-core/support';

JavaScript

/** @typedef {import('@jangts/agent-core/support').ToolRuntime} ToolRuntime */

其他公开入口：@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/support。

定义

interface ToolRuntime<Tool, App>

泛型参数

类型参数	约束	默认类型
Tool	ResultDefinition	ResultDefinition
App	—	unknown

字段结构

字段	类型	必需	说明
tools	ToolModelView<App>	必需	只读。The catalog's model tools, shared with the catalog instance.
events	readonly ToolExecutionEvent<string>[]	必需	只读。Execution events recorded by this runtime so far, in occurrence order.
invokeSync	{ <const Id extends Tool["id"]>(request: ToolInvocationRequest<Id>): ToolResult<ToolOutput<Tool, Id>>; (request: ToolInvocationRequest): ToolResult<unknown>; }	必需	Synchronous invocation; rejects tools declared as asynchronous.
invoke	{ <const Id extends Tool["id"]>(request: ToolInvocationRequest<Id>): Promise<ToolResult<ToolOutput<Tool, Id>>>; (request: ToolInvocationRequest): Promise<ToolResult<unknown>>; }	必需	Asynchronous invocation; still bounded by the bound execution signal and errors.

成员目录

成员	用途
invokeSync	Synchronous invocation; rejects tools declared as asynchronous.
invoke	Asynchronous invocation; still bounded by the bound execution signal and errors.

成员详情

invokeSync

Synchronous invocation; rejects tools declared as asynchronous.

ToolRuntime.invokeSync<const Id extends Tool["id"]>(request: ToolInvocationRequest<Id>): ToolResult<ToolOutput<Tool, Id>>

Synchronous invocation; rejects tools declared as asynchronous.

类型参数	约束	默认类型
Id	string	—

参数	类型	传递	说明
request	ToolInvocationRequest<Id>	必需	—

request 的字段

字段	类型	必需	说明
logger	SubFlowLogger | undefined	可省略	只读。Explicit recorder for this call, also available to its handler for deliberate use.
toolId	Id	必需	只读。见类型定义及调用场景。
input	unknown	必需	只读。Raw model arguments; parsed by the tool's input schema before authorization.
signal	AbortSignal | undefined	可省略	只读。Per-call cancellation; can only shorten the surrounding execution lifetime.
diagnostics	DiagnosticContext | undefined	可省略	只读。见类型定义及调用场景。

返回： ToolResult<ToolOutput<Tool, Id>>。

返回值结构

字段	类型	必需	说明
value	ToolOutput<Tool, Id>	必需	只读。见类型定义及调用场景。
invocation	Readonly<ToolCallRecord>	必需	只读。见类型定义及调用场景。

ToolRuntime.invokeSync(request: ToolInvocationRequest): ToolResult<unknown>

参数	类型	传递	说明
request	ToolInvocationRequest<string>	必需	—

request 的字段

字段	类型	必需	说明
logger	SubFlowLogger | undefined	可省略	只读。Explicit recorder for this call, also available to its handler for deliberate use.
toolId	string	必需	只读。见类型定义及调用场景。
input	unknown	必需	只读。Raw model arguments; parsed by the tool's input schema before authorization.
signal	AbortSignal | undefined	可省略	只读。Per-call cancellation; can only shorten the surrounding execution lifetime.
diagnostics	DiagnosticContext | undefined	可省略	只读。见类型定义及调用场景。

返回： ToolResult<unknown>。

返回值结构

字段	类型	必需	说明
value	unknown	必需	只读。见类型定义及调用场景。
invocation	Readonly<ToolCallRecord>	必需	只读。见类型定义及调用场景。

invoke

Asynchronous invocation; still bounded by the bound execution signal and errors.

ToolRuntime.invoke<const Id extends Tool["id"]>(request: ToolInvocationRequest<Id>): Promise<ToolResult<ToolOutput<Tool, Id>>>

Asynchronous invocation; still bounded by the bound execution signal and errors.

类型参数	约束	默认类型
Id	string	—

参数	类型	传递	说明
request	ToolInvocationRequest<Id>	必需	—

request 的字段

字段	类型	必需	说明
logger	SubFlowLogger | undefined	可省略	只读。Explicit recorder for this call, also available to its handler for deliberate use.
toolId	Id	必需	只读。见类型定义及调用场景。
input	unknown	必需	只读。Raw model arguments; parsed by the tool's input schema before authorization.
signal	AbortSignal | undefined	可省略	只读。Per-call cancellation; can only shorten the surrounding execution lifetime.
diagnostics	DiagnosticContext | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<ToolResult<ToolOutput<Tool, Id>>>。

等待后的值： ToolResult<ToolOutput<Tool, Id>>。

返回值结构

字段	类型	必需	说明
value	ToolOutput<Tool, Id>	必需	只读。见类型定义及调用场景。
invocation	Readonly<ToolCallRecord>	必需	只读。见类型定义及调用场景。

ToolRuntime.invoke(request: ToolInvocationRequest): Promise<ToolResult<unknown>>

参数	类型	传递	说明
request	ToolInvocationRequest<string>	必需	—

request 的字段

字段	类型	必需	说明
logger	SubFlowLogger | undefined	可省略	只读。Explicit recorder for this call, also available to its handler for deliberate use.
toolId	string	必需	只读。见类型定义及调用场景。
input	unknown	必需	只读。Raw model arguments; parsed by the tool's input schema before authorization.
signal	AbortSignal | undefined	可省略	只读。Per-call cancellation; can only shorten the surrounding execution lifetime.
diagnostics	DiagnosticContext | undefined	可省略	只读。见类型定义及调用场景。

返回： Promise<ToolResult<unknown>>。

等待后的值： ToolResult<unknown>。

返回值结构

字段	类型	必需	说明
value	unknown	必需	只读。见类型定义及调用场景。
invocation	Readonly<ToolCallRecord>	必需	只读。见类型定义及调用场景。

使用示例

• 工具最佳实践：一份定义生成模型 Tool 与执行运行时：把 Schema、授权、执行和输出校验登记一次，按请求绑定 App，避免维护两份工具清单。

定义并使用一项只读工具

入门 · Node.js

TypeScript

import { Support } from '@jangts/agent-core';
const inputSchema = Support.defineSchema({
  jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
  parse(value: unknown) {
    if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length) throw new TypeError('需要空对象');
    return {};
  },
});
const catalog = Support.defineToolCatalog([{ id: 'get_status', kind: 'read', description: '读取服务状态', inputSchema,
  authorize() {},
  execute() { return '服务运行正常'; },
  parseOutput(value: unknown) { if (typeof value !== 'string') throw new TypeError('需要字符串'); return value; },
}]);
const tools = catalog.bind({ app: undefined });
console.log((await tools.invoke({ toolId: 'get_status', input: {} })).value);
console.log(catalog.tools.ids());

JavaScript

import { Support } from '@jangts/agent-core';
const inputSchema = Support.defineSchema({
    jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
    parse(value) {
        if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length)
            throw new TypeError('需要空对象');
        return {};
    },
});
const catalog = Support.defineToolCatalog([{ id: 'get_status', kind: 'read', description: '读取服务状态', inputSchema,
        authorize() { },
        execute() { return '服务运行正常'; },
        parseOutput(value) { if (typeof value !== 'string')
            throw new TypeError('需要字符串'); return value; },
    }]);
const tools = catalog.bind({ app: undefined });
console.log((await tools.invoke({ toolId: 'get_status', input: {} })).value);
console.log(catalog.tools.ids());

保留清单，增加本次权限与服务依赖

配置 · Node.js

TypeScript

import { Support } from '@jangts/agent-core';
import type { OperationContext } from '@jangts/agent-core/types';
type App = { allowed: boolean; readStatus(): Promise<string> };
const inputSchema = Support.defineSchema({
  jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
  parse(value: unknown) {
    if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length) throw new TypeError('需要空对象');
    return {};
  },
});
const catalog = Support.defineToolCatalog<App>([{ id: 'get_status', kind: 'read', description: '读取状态', inputSchema,
  authorize(_input: {}, { app }: OperationContext<App>) { if (!app.allowed) throw new Error('当前请求没有读取权限'); },
  execute(_input: {}, { app }: OperationContext<App>) { return app.readStatus(); },
  parseOutput(value: unknown) { if (typeof value !== 'string') throw new TypeError('需要字符串'); return value; },
}]);
const tools = catalog.bind({ app: { allowed: true, readStatus: async () => '服务运行正常' },
  execution: { signal: AbortSignal.timeout(10000) },
});
console.log((await tools.invoke({ toolId: 'get_status', input: {} })).value);

JavaScript

import { Support } from '@jangts/agent-core';
const inputSchema = Support.defineSchema({
    jsonSchema: { type: 'object', properties: {}, additionalProperties: false },
    parse(value) {
        if (!value || typeof value !== 'object' || Array.isArray(value) || Object.keys(value).length)
            throw new TypeError('需要空对象');
        return {};
    },
});
const catalog = Support.defineToolCatalog([{ id: 'get_status', kind: 'read', description: '读取状态', inputSchema,
        authorize(_input, { app }) { if (!app.allowed)
            throw new Error('当前请求没有读取权限'); },
        execute(_input, { app }) { return app.readStatus(); },
        parseOutput(value) { if (typeof value !== 'string')
            throw new TypeError('需要字符串'); return value; },
    }]);
const tools = catalog.bind({ app: { allowed: true, readStatus: async () => '服务运行正常' },
    execution: { signal: AbortSignal.timeout(10000) },
});
console.log((await tools.invoke({ toolId: 'get_status', input: {} })).value);

相关策略源码

• 授权与工具能力投影来自同源定义

相关定义

• ToolCallRecord
• ToolExecutionEvent
• ToolInvocationRequest
• ToolModelView
• ToolOutput
• ToolResult