IntentToolRegistration

KIT · type · Type contract

Configuration form; object arguments and a Tool proposal are the registration defaults.

Import

TypeScript

import type { IntentToolRegistration } from '@jangts/agent-core/kits/domains';

JavaScript

/** @typedef {import('@jangts/agent-core/kits/domains').IntentToolRegistration} IntentToolRegistration */

Other public entry points:@jangts/agent-core, @jangts/agent-core/types, @jangts/agent-core/structs, @jangts/agent-core/kits/domains, @jangts/agent-core/kits.

Definition

Type: IntentToolRegistration

Type expression

type IntentToolRegistration = Omit<IntentTool, 'inputSchema' | 'resolve'> &
  Partial<Pick<IntentTool, 'inputSchema' | 'resolve'>>;

Field structure

Field	Type	Required	Description
id	string	Required	Unique Tool id, matched against the policy's idPattern when configured.
description	string	Required	Non-blank model-facing description.
active	ToolCondition<any> | undefined	Optional	Read-only. Omitted means active. Authorization remains a separate execution boundary.
asIntent	AsIntent<any> | undefined	Optional	Read-only. Omitted means this tool is not advertised by withIntent().
delegates	readonly string[] | undefined	Optional	Allowed delegate ids, retained in declaration order without imposing execution order; non-empty and unique.
scopePolicy	string | undefined	Optional	App-declared scope-mode name; validated against policy.scopeModes when that is set.
targetPolicy	string | undefined	Optional	App-declared target-mode name; validated against policy.targetModes when that is set.
contextTier	string | undefined	Optional	App-declared context tier; validated against policy.contextTiers when that is set.
planIntent	string | undefined	Optional	App-declared planning action; validated against policy.actions when that is set.
auxiliaryActions	readonly string[] | undefined	Optional	Additional actions the intent may use; must be unique.
preparedHandoff	unknown	Optional	App-declared handoff marker; validated against policy.handoffValues when that is set.
resolve	((input: any, context: Readonly<{ stageId: string; }>) => any) | undefined	Optional	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	Optional	Read-only. Schema describing the arguments; must be an object schema.

Examples

• Domain Tools: tool declarations and scope relationships: One list provides the available tools, allowed delegates, scope aliases, sources, and tool relationships.

Register one tool that explains an interface

Beginner · Node.js

TypeScript

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);

JavaScript

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);

Add constraints and scope relationships while keeping the same query entry

Configuration · Node.js

TypeScript

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'));

JavaScript

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'));

Related policy source

• Tool validation and sealing
• Scope relationships and aliases

Related definitions

• IntentOptions
• IntentTool
• SchemaAdapter