IntentToolRegistration
KIT · type · 类型合同
Configuration form; object arguments and a Tool proposal are the registration defaults.
导入
ts
import type { IntentToolRegistration } from '@jangts/agent-core/kits/domains';js
/** @typedef {import('@jangts/agent-core/kits/domains').IntentToolRegistration} IntentToolRegistration */其他公开入口:@jangts/agent-core、@jangts/agent-core/types、@jangts/agent-core/structs、@jangts/agent-core/kits/domains、@jangts/agent-core/kits。
定义
类型: IntentToolRegistration
类型表达式
ts
type IntentToolRegistration = Omit<IntentTool, 'inputSchema' | 'resolve'> &
Partial<Pick<IntentTool, 'inputSchema' | 'resolve'>>;字段结构
| 字段 | 类型 | 必需 | 说明 |
|---|---|---|---|
id | string | 必需 | Unique Tool id, matched against the policy's idPattern when configured. |
description | string | 必需 | Non-blank model-facing description. |
active | ToolCondition<any> | undefined | 可省略 | 只读。Omitted means active. Authorization remains a separate execution boundary. |
asIntent | AsIntent<any> | undefined | 可省略 | 只读。Omitted means this tool is not advertised by withIntent(). |
delegates | readonly string[] | undefined | 可省略 | Allowed delegate ids, retained in declaration order without imposing execution order; non-empty and unique. |
scopePolicy | string | undefined | 可省略 | App-declared scope-mode name; validated against policy.scopeModes when that is set. |
targetPolicy | string | undefined | 可省略 | App-declared target-mode name; validated against policy.targetModes when that is set. |
contextTier | string | undefined | 可省略 | App-declared context tier; validated against policy.contextTiers when that is set. |
planIntent | string | undefined | 可省略 | App-declared planning action; validated against policy.actions when that is set. |
auxiliaryActions | readonly string[] | undefined | 可省略 | Additional actions the intent may use; must be unique. |
preparedHandoff | unknown | 可省略 | App-declared handoff marker; validated against policy.handoffValues when that is set. |
resolve | ((input: any, context: Readonly<{ stageId: string; }>) => any) | undefined | 可省略 | Converts validated arguments into the value handed back to the caller. Runs inside the model call, so it must return synchronously; throwing rejects the selection. |
inputSchema | SchemaAdapter<any> | undefined | 可省略 | 只读。Schema describing the arguments; must be an object schema. |
使用示例
- Domain Tools:Tool 声明与范围关系:同一清单提供可用 Tool、允许 delegate、范围别名、来源和工具关系。
先登记一个接口说明 Tool
入门 · Node.js
ts
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = IntentRegistry.create([
{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: true },
]);
console.log(tools.ids(), tools.allows('explain', 'read'));
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge' },
]);
console.log(scopes.require('sdk').knowledgeTopicIds);js
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = IntentRegistry.create([
{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: true },
]);
console.log(tools.ids(), tools.allows('explain', 'read'));
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge' },
]);
console.log(scopes.require('sdk').knowledgeTopicIds);增加约束和范围关联,查询入口保持一致
配置 · Node.js
ts
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = new IntentRegistry({ idPattern: /^[a-z-]+$/, delegates: ['read', 'reply'] })
.registerAll([{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: '用户希望了解 SDK 接口或用法。' }]).seal();
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge', aliases: ['agent-core'], goalIds: ['explain'], knowledgeTopicIds: ['manual'], toolIds: ['read-source'] },
], { categories: ['knowledge'], requireGoals: true, requireSources: true });
console.log(tools.describe(), scopes.normalize('agent-core'));
console.log(scopes.acceptsTool('agent-core', 'explain'), scopes.topics('sdk'));js
import { IntentRegistry, ScopeRegistry } from '@jangts/agent-core/kits/domains';
const tools = new IntentRegistry({ idPattern: /^[a-z-]+$/, delegates: ['read', 'reply'] })
.registerAll([{ id: 'explain', description: '根据资料解释 SDK', delegates: ['read', 'reply'], asIntent: '用户希望了解 SDK 接口或用法。' }]).seal();
const scopes = ScopeRegistry.create([
{ id: 'sdk', description: 'SDK 说明资料', category: 'knowledge', aliases: ['agent-core'], goalIds: ['explain'], knowledgeTopicIds: ['manual'], toolIds: ['read-source'] },
], { categories: ['knowledge'], requireGoals: true, requireSources: true });
console.log(tools.describe(), scopes.normalize('agent-core'));
console.log(scopes.acceptsTool('agent-core', 'explain'), scopes.topics('sdk'));