ScopeDefinition

KIT · interface · Type contract

One declarable scope. Ids and aliases share one namespace and must be unique.

Import

TypeScript

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

JavaScript

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

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 ScopeDefinition

Field structure

Field	Type	Required	Description
id	string	Required	Unique scope id, matched against the policy's idPattern when configured.
description	string	Required	Non-blank description.
category	string	Required	Scope category; validated against policy.categories when that is set.
goalIds	readonly string[] | undefined	Optional	Goals this scope serves; required when the policy sets requireGoals.
queryScopeIds	readonly string[] | undefined	Optional	Referenced query scopes, resolved by the App.
knowledgeTopicIds	readonly string[] | undefined	Optional	Referenced knowledge topics, resolved by the App.
toolIds	readonly string[] | undefined	Optional	Referenced tool ids; required when the policy sets requireTools.
aliases	readonly string[] | undefined	Optional	Alternate names accepted by lookup; must not collide with ids or other aliases.
contextTier	string | undefined	Optional	App-declared context tier, passed through for the App's own policy.
evidence	readonly EvidenceRequirement[] | undefined	Optional	Evidence requirements that must be satisfied before this scope may answer.

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

• EvidenceRequirement