ToolInvocationPorts

CORE · interface · Type contract

Optional tools the lifecycle resolves from the host context for one invocation.

Import

TypeScript

import type { ToolInvocationPorts } from '@jangts/agent-core/tools';

JavaScript

/** @typedef {import('@jangts/agent-core/tools').ToolInvocationPorts} ToolInvocationPorts */

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

Definition

interface ToolInvocationPorts<Context>

Type parameters

Type parameter	Constraint	Default type
Context	—	—

Field structure

Field	Type	Required	Description
logger	((context: Context) => import("../debug.js").SubFlowLogger | undefined) | undefined	Optional	Read-only. Explicit recorder selected for this invocation only.
diagnostics	((context: Context) => import("../diagnostics.js").DiagnosticContext | undefined) | undefined	Optional	Read-only. Diagnostic scope; omitted disables recording for this tool.
signal	((context: Context) => AbortSignal | undefined) | undefined	Optional	Read-only. Extra cancellation; must not replace the tool execution signal.
journal	((context: Context) => ToolJournal | undefined) | undefined	Optional	Read-only. Journal receiving begin/finish receipts.
checkpoint	((context: Context) => unknown) | undefined	Optional	Read-only. Extracts the domain checkpoint recorded with the receipt.
receipt	((context: Context, checkpoint: unknown) => unknown) | undefined	Optional	Read-only. Builds the domain receipt from a checkpoint after execution.
receiptError	((error: unknown) => unknown) | undefined	Optional	Read-only. Converts an error into the receipt's replacement value.

Examples

• Synchronous execution adapter for host-selected invocations: Record start, completion, and failure uniformly for synchronous invocations the host has already selected, without replacing tool selection or authorization.

Execute a local invocation the App has already selected

Beginner · Node.js

TypeScript

import { executeInvocation } from '@jangts/agent-core/tools';
const state = { status: '' };
executeInvocation({ id: 'read-status', call(_input: {}, context: typeof state) {
  context.status = '服务正常';
} }, {}, state);
console.log(state.status);

JavaScript

import { executeInvocation } from '@jangts/agent-core/tools';
const state = { status: '' };
executeInvocation({ id: 'read-status', call(_input, context) {
        context.status = '服务正常';
    } }, {}, state);
console.log(state.status);

Connect the same request journal and cancellation signal

Configuration · Node.js

TypeScript

import { executeInvocation } from '@jangts/agent-core/tools';
import { ContextJournal } from '@jangts/agent-core/journal';
const state = { status: '', journal: new ContextJournal(), signal: new AbortController().signal };
executeInvocation({ id: 'read-status', call(_input: {}, context: typeof state) { context.status = '服务正常'; } }, {}, state, {
  signal: context => context.signal,
  journal: context => context.journal,
  receipt: context => context.status,
});
console.log(state.journal.snapshot());

JavaScript

import { executeInvocation } from '@jangts/agent-core/tools';
import { ContextJournal } from '@jangts/agent-core/journal';
const state = { status: '', journal: new ContextJournal(), signal: new AbortController().signal };
executeInvocation({ id: 'read-status', call(_input, context) { context.status = '服务正常'; } }, {}, state, {
    signal: context => context.signal,
    journal: context => context.journal,
    receipt: context => context.status,
});
console.log(state.journal.snapshot());

Related policy source

• Boundaries of synchronous invocation, cancellation, and receipts

Related definitions

• ToolJournal