ToolJournalFinish

CORE · interface · Type contract

Closing record for one tool call, written once with the terminal outcome.

Import

TypeScript

import type { ToolJournalFinish } from '@jangts/agent-core/types';

JavaScript

/** @typedef {import('@jangts/agent-core/types').ToolJournalFinish} ToolJournalFinish */

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

Definition

interface ToolJournalFinish

Field structure

Field	Type	Required	Description
invocationId	string	Required	Invocation opened by beginTool.
status	"error" | "success" | "cancelled"	Required	Terminal status; cancelled is distinct from error.
value	unknown	Required	Produced value on success; failure detail on error; ignored for cancellation.

Examples

• ContextJournal: the in-request projection of receipts: Turn real call receipts into in-request records usable in later context, without starting another persistent logging system.
• 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.

Read the model receipt already recorded by the Runner

Beginner · Node.js

TypeScript

import { ModelRunner } from '@jangts/agent-core';
const runner = new ModelRunner({ provider: { async *stream() { yield '服务运行正常'; } } });
const result = await runner.invoke('查询服务状态');
console.log(result.invocation.invocationId);
console.log(runner.journal.snapshot());

JavaScript

import { ModelRunner } from '@jangts/agent-core';
const runner = new ModelRunner({ provider: { async *stream() { yield '服务运行正常'; } } });
const result = await runner.invoke('查询服务状态');
console.log(result.invocation.invocationId);
console.log(runner.journal.snapshot());

An App adapter records the local tool it actually executes

Configuration · Node.js

TypeScript

import { ContextJournal } from '@jangts/agent-core/journal';
const journal = new ContextJournal();
const invocationId = journal.beginTool({ toolId: 'get_status', input: {} });
// 此处由 App 实际执行本地读取；不是模型提供的回执。
const status = '服务运行正常';
journal.finishTool({ invocationId, status: 'success', value: status });
console.log(journal.snapshot());

JavaScript

import { ContextJournal } from '@jangts/agent-core/journal';
const journal = new ContextJournal();
const invocationId = journal.beginTool({ toolId: 'get_status', input: {} });
// 此处由 App 实际执行本地读取；不是模型提供的回执。
const status = '服务运行正常';
journal.finishTool({ invocationId, status: 'success', value: status });
console.log(journal.snapshot());

Related policy source

• Boundaries of synchronous invocation, cancellation, and receipts