IntentPolicy

KIT · interface · Type contract

Registration rules for one intent registry.

Import

TypeScript

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

JavaScript

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

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

interface IntentPolicy<Definition>

Type parameters

Type parameter	Constraint	Default type
Definition	IntentToolRegistration	—

Field structure

Field	Type	Required	Description
idPattern	RegExp | undefined	Optional	Read-only. Pattern every Tool id must match.
scopeModes	readonly string[] | undefined	Optional	Read-only. Allowed scopePolicy values; undefined accepts any value.
targetModes	readonly string[] | undefined	Optional	Read-only. Allowed targetPolicy values; undefined accepts any value.
contextTiers	readonly string[] | undefined	Optional	Read-only. Allowed contextTier values; undefined accepts any value.
actions	readonly string[] | undefined	Optional	Read-only. Allowed planIntent values; undefined accepts any value.
delegates	readonly string[] | undefined	Optional	Read-only. Allowed delegate ids; undefined accepts any non-empty delegate.
handoffValues	readonly unknown[] | undefined	Optional	Read-only. Allowed preparedHandoff values; undefined accepts any value.
assertDefinition	((definition: Definition) => void) | undefined	Optional	Read-only. Extra App assertion, called after the built-in checks; must return void synchronously.
tags	readonly string[] | undefined	Optional	Read-only. Diagnostic tags attached to registration rejections.
errors	{ readonly sealed?: BreakReason; readonly invalid?: BreakReason; readonly duplicate?: (goal: string) => Error | string; } | undefined	Optional	Read-only. See the type definition and usage context.

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

• BreakReason
• IntentToolRegistration