Package io.agentscope.harness.agent.gateway

Class GatewayBootstrap

java.lang.Object

io.agentscope.harness.agent.gateway.GatewayBootstrap

public final class GatewayBootstrap
extends Object

Multi-agent + channel routing bootstrap. The primary user-facing entry point for building a gateway-managed agent system.

Minimal usage — single agent + ChatUI

 HarnessAgent agent = HarnessAgent.builder()
     .model(model).name("assistant").sysPrompt("You are helpful.")
     .build();

 GatewayBootstrap gw = GatewayBootstrap.builder()
     .agent("main", agent)
     .build();

 ChatUiChannel chat = gw.chatUiChannel();
 Msg reply = chat.send("hello").block();
 

Multi-agent + binding routing

 GatewayBootstrap gw = GatewayBootstrap.builder()
     .agent("sales", salesAgent)
     .agent("support", supportAgent)
     .mainAgent("sales")
     .build();

 ChannelConfig config = ChannelConfig.builder("chatui")
     .dmScope(DmScope.PER_PEER)
     .binding(ChannelBinding.forPeer("direct:vip-user-1", "support"))
     .build();

 ChatUiChannel chat = gw.chatUiChannel(config);
 chat.send("vip-user-1", "help me").block();  // routes to support agent
 chat.send("normal-user", "hi").block();      // routes to sales (default)
 

External channels

 GatewayBootstrap gw = GatewayBootstrap.builder()
     .agent("main", agent)
     .channel(mySlackChannel)
     .build();

 gw.start();   // init + start all channels
 gw.stop();    // stop all channels
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	GatewayBootstrap.Builder

Method Summary

Modifier and Type	Method	Description
Map<String,HarnessAgent>	agents()	The registered agents keyed by id.
static GatewayBootstrap.Builder	builder()	Returns a new builder.
ChannelManager	channelManager()	The channel manager (advanced usage).
ChatUiChannel	chatUiChannel()	Returns a ChatUiChannel with default DmScope.MAIN config, pre-wired to this gateway.
ChatUiChannel	chatUiChannel(ChannelConfig config)	Returns a ChatUiChannel with custom routing config, pre-wired to this gateway.
HarnessGateway	gateway()	The underlying gateway (advanced usage).
SubagentGatewayBridge	gatewayBridge()	Returns a SubagentGatewayBridge that exposes subagents as user-addressable threads within this gateway.
String	mainAgentId()	The main agent id.
GatewayBootstrap	start()	Initializes and starts all pre-registered channels (injecting the gateway into each).
void	stop()	Stops all channels and releases resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static GatewayBootstrap.Builder builder()

Returns a new builder.

gateway

public HarnessGateway gateway()

The underlying gateway (advanced usage).

channelManager

public ChannelManager channelManager()

The channel manager (advanced usage).

agents

public Map<String,HarnessAgent> agents()

The registered agents keyed by id.

mainAgentId

public String mainAgentId()

The main agent id.

gatewayBridge

public SubagentGatewayBridge gatewayBridge()

Returns a SubagentGatewayBridge that exposes subagents as user-addressable threads within this gateway. Pass this to SubagentsMiddleware.setGatewayBridge(io.agentscope.harness.agent.gateway.SubagentGatewayBridge) to enable the expose_to_user parameter on agent_spawn.

chatUiChannel

public ChatUiChannel chatUiChannel()

Returns a ChatUiChannel with default DmScope.MAIN config, pre-wired to this gateway. All conversations share a single session.

chatUiChannel

public ChatUiChannel chatUiChannel(ChannelConfig config)

Returns a ChatUiChannel with custom routing config, pre-wired to this gateway. Use to configure DmScope, bindings, or default agent overrides.

start

public GatewayBootstrap start()

Initializes and starts all pre-registered channels (injecting the gateway into each). Call this after build() when using external channels (Slack, Telegram, etc.).

stop

public void stop()

Stops all channels and releases resources.