Interface StudioAgentSessionExperimental

interface StudioAgentSession {
    compositionTools: readonly string[];
    draft: undefined | StudioAgentDraftBinding;
    messages: readonly StudioAiChatMessage[];
    toolDiscovery: undefined | StudioToolDiscoveryReport;
    tools: readonly StudioAiToolDefinition[];
    toolWatchStatus: undefined | McpNotificationStreamStatus;
    attachDraft(draft: StudioAgentDraftBinding): void;
    capabilities(): Promise<StudioAiCapabilitiesResponse>;
    chat(text: string, options?: StudioAgentChatOptions): Promise<StudioAgentTurn>;
    close(): void;
    reconnect(): void;
    refreshTools(): Promise<StudioToolDiscoveryReport>;
    reset(): void;
    resolveProvider(): Promise<undefined | StudioAiCapability>;
}

Properties

compositionTools draft messages toolDiscovery tools toolWatchStatus

Methods

attachDraft capabilities chat close reconnect refreshTools reset resolveProvider

Properties

Readonly ExperimentalcompositionTools

compositionTools: readonly string[]

The composition tool names discovery selected, or [] before it has run.

Readonly Experimentaldraft

draft: undefined | StudioAgentDraftBinding

The draft honua_studio_* tools mutate, with the latest generation the session has seen.

Readonly Experimentalmessages

messages: readonly StudioAiChatMessage[]

Conversation history so far, oldest first.

Readonly ExperimentaltoolDiscovery

toolDiscovery: undefined | StudioToolDiscoveryReport

The last completed discovery pass, or undefined before the first one.

Readonly Experimentaltools

tools: readonly StudioAiToolDefinition[]

The tool definitions advertised to the proxy, in the { name, description, inputSchema } HTTP shape — runtime-kit tools, plus every server-discovered composition tool this session's policy approved. Before the first chat() (or refreshTools) this is the runtime-kit set alone, since discovery is asynchronous and lazy.

Readonly ExperimentaltoolWatchStatus

toolWatchStatus: undefined | McpNotificationStreamStatus

Lifecycle status of the tools/list_changed subscription, or undefined when watchToolListChanged is off or the subscription has not started.

Methods

attachDraft

capabilities

chat

close

  • close(): void
  • Experimental

    Releases the session's long-lived resources — today, the opt-in tools/list_changed subscription, whose in-flight GET is aborted rather than left to the host's connection pool. Idempotent. A closed session can still chat(); it simply stops watching for catalog changes.

    Returns void

reconnect

  • reconnect(): void
  • Experimental

    Drops the negotiated MCP session and invalidates the tool catalog, so the next turn re-handshakes and re-discovers. A reconnected principal may have a different catalog; nothing derived from the old one survives.

    Returns void

refreshTools

reset

resolveProvider

Settings

Member Visibility

On This Page

Properties
Methods