ToolCatalogEntry

SUPPORT · type · 类型合同

Public declaration surface of one tool, without registry internals.

导入

TypeScript

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

JavaScript

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

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

定义

类型： ToolCatalogEntry<App, Tool>

类型表达式

type ToolCatalogEntry<App, Tool extends ToolDefinition<unknown, unknown, App>> = Tool extends ToolDefinition<unknown, unknown, App>
    ? Pick<Tool, keyof ToolDefinition<unknown, unknown, App>>
    : never;

泛型参数

类型参数	约束	默认类型
App	—	—
Tool	ToolDefinition<unknown, unknown, App>	—

字段结构

字段	类型	必需	说明
id	string	必需	只读。Stable id; also the name the model calls.
description	string	必需	只读。Model-visible explanation of when to call the tool.
resolve	((input: unknown, context: Readonly<{ stageId: string; }>) => ToolProposal) | undefined	可省略	只读。见类型定义及调用场景。
inputSchema	SchemaAdapter<unknown>	必需	只读。Schema applied to raw model arguments before authorize and execute.
active	ToolCondition<App> | undefined	可省略	只读。Omitted means active. Authorization remains a separate execution boundary.
asIntent	AsIntent<App> | undefined	可省略	只读。Omitted means this tool is not advertised by withIntent().
kind	string	必需	只读。Declared grouping used by registries and documentation; not an authorization boundary.
authorize	(input: unknown, context: OperationContext<App>) => MaybePromise<void>	必需	Host permission check. Runs before execution and may be asynchronous.
execute	(input: unknown, context: OperationContext<App> & NodeReportingContext) => unknown	必需	Executes the already-authorized input; must not repeat authorization decisions.
debugSteps	((result: unknown, context: import("../debug.js").NodeReportingContext) => void) | undefined	可省略	Optional result hook; writes through context.createSubFlowLogger() are recorded immediately.
parseOutput	(value: unknown) => unknown	必需	Validates untrusted output (for example a cached replay) before it is returned.

成员目录

成员	用途
authorize	Host permission check. Runs before execution and may be asynchronous.
execute	Executes the already-authorized input; must not repeat authorization decisions.
parseOutput	Validates untrusted output (for example a cached replay) before it is returned.

成员详情

authorize

Host permission check. Runs before execution and may be asynchronous.

ToolCatalogEntry.authorize(input: unknown, context: OperationContext<App>): MaybePromise<void>

Host permission check. Runs before execution and may be asynchronous.

参数	类型	传递	说明
input	unknown	必需	—
context	OperationContext<App>	必需	—

context 的字段

字段	类型	必需	说明
app	unknown extends App ? App : Readonly<App>	必需	只读。见类型定义及调用场景。
logger	SubFlowLog | undefined	可省略	只读。Explicit optional recorder for this operation; never inferred from diagnostics.
signal	AbortSignal	必需	只读。Non-optional cancellation signal; never undefined once execution has started.
diagnostics	DiagnosticContext | undefined	可省略	只读。Diagnostic scope of the enclosing call, when recording is enabled.

返回： MaybePromise<void>。

等待后的值： void。

execute

Executes the already-authorized input; must not repeat authorization decisions.

ToolCatalogEntry.execute(input: unknown, context: OperationContext<App> & NodeReportingContext): unknown

Executes the already-authorized input; must not repeat authorization decisions.

参数	类型	传递	说明
input	unknown	必需	—
context	OperationContext<App> & NodeReportingContext	必需	—

context 的字段

字段	类型	必需	说明
app	unknown extends App ? App : Readonly<App>	必需	只读。见类型定义及调用场景。
logger	SubFlowLog | undefined	可省略	只读。Explicit optional recorder for this operation; never inferred from diagnostics.
signal	AbortSignal	必需	只读。Non-optional cancellation signal; never undefined once execution has started.
diagnostics	DiagnosticContext | undefined	可省略	只读。Diagnostic scope of the enclosing call, when recording is enabled.
report	(update: import("./execution/workflow.js").WorkflowNodeReport) => void	必需	Reports progress for the active node; Core supplies the execution identity.
createSubFlowLogger	() => SubFlowLogger	必需	Bound to this context and owned by runtime; repeated calls in one visit return the same instance.

返回： unknown。

parseOutput

Validates untrusted output (for example a cached replay) before it is returned.

ToolCatalogEntry.parseOutput(value: unknown): unknown

Validates untrusted output (for example a cached replay) before it is returned.

参数	类型	传递	说明
value	unknown	必需	—

返回： unknown。

使用示例

• 工具最佳实践：一份定义生成模型 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);

相关策略源码

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

相关定义

• IntentOptions
• MaybePromise
• NodeReportingContext
• OperationContext
• SchemaAdapter
• ToolDefinition