InstrumentOptions
The options a session takes for observing and protecting its operation.
import type { InstrumentOptions } from '@threadplane/ag-ui';Declaration
export interface InstrumentOptions {
readonly a2uiClientCapabilities?: {
readonly supportedCatalogIds: readonly string[];
readonly inlineCatalogs?: readonly PlainValue[];
};
readonly developmentRuntime?: SessionDevelopmentRuntime | SessionDevelopmentRuntimeFactory;
readonly devtools?: SessionDevtools;
readonly telemetry?: SessionTelemetrySink | false;
}Members
a2uiClientCapabilities
A2UI client capabilities to advertise to the agent. Every request's state
carries them under a2ui_client_capabilities. They are not part of the
session's own state and are not published.
readonly a2uiClientCapabilities?: {
readonly supportedCatalogIds: readonly string[];
readonly inlineCatalogs?: readonly PlainValue[];
};developmentRuntime
A development-install collector to keep informed, or a factory that builds one from what this package knows of its own installation. The host owns the collector; the session only calls it, and sends nothing itself.
readonly developmentRuntime?: SessionDevelopmentRuntime | SessionDevelopmentRuntimeFactory;devtools
Development hooks that follow each publication or script a run.
readonly devtools?: SessionDevtools;telemetry
Receives the session's lifecycle moments. Absent or false reports nothing.
readonly telemetry?: SessionTelemetrySink | false;