Package akka.javasdk.testkit

Class TestModelProvider.AutonomousAgentTools

Object

akka.javasdk.testkit.TestModelProvider.AutonomousAgentTools

Enclosing class:

TestModelProvider

public static final class TestModelProvider.AutonomousAgentTools
extends Object

Factory methods for TestModelProvider.ToolInvocationRequest instances that correspond to the internal tools exposed by the autonomous agent runtime to the LLM.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	TestModelProvider.AutonomousAgentTools.ParticipantRef	Participant reference for scripted conversations, with type and reference name.
static final record	TestModelProvider.AutonomousAgentTools.ScriptStep	A step in a scripted conversation, specifying speaker and guidance.
static final record	TestModelProvider.AutonomousAgentTools.TeamMemberSpec	Specifies a team member type and count for a create_team tool invocation.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BROADCAST	Tool name for broadcasting a message to a conversation.
static final String	CANCEL_UNCLAIMED_TASKS_FROM_BACKLOG	Tool name for cancelling unclaimed tasks from backlog (lead side).
static final String	CLAIM_TASK	Tool name for claiming a task (member side).
static final String	COMPLETE_TASK	Tool name for completing a task.
static final String	CREATE_TEAM	Tool name for creating a team.
static final String	DIRECT	Tool name for directing a participant in a conversation (directed mode).
static final String	DISBAND_TEAM	Tool name for disbanding a team.
static final String	END_CONVERSATION	Tool name for ending a moderated conversation (directed mode).
static final String	FAIL_TASK	Tool name for failing a task.
static final String	GET_BACKLOG_STATUS	Tool name for getting backlog status (member side).
static final String	GET_MANAGED_BACKLOG_STATUS	Tool name for getting managed backlog status (lead side).
static final String	GET_TASK	Tool name for looking up a task by ID.
static final String	GET_TEAM_STATUS	Tool name for getting team status.
static final String	PROVIDE_PROMPT	Tool name for providing a prompt during a scripted conversation step.
static final String	RELEASE_TASK	Tool name for releasing a task (member side).
static final String	SEND_MESSAGE	Tool name for sending a message to another agent.
static final String	START_CONVERSATION	Tool name for starting a moderated conversation.
static final String	SUBMIT_TURN	Tool name for submitting a turn response.
static final String	TRANSFER_TASK	Tool name for transferring a task (member side).

Method Summary

Modifier and Type	Method	Description
static TestModelProvider.ToolInvocationRequest	broadcast(String message)	Creates a TestModelProvider.ToolInvocationRequest for the broadcast tool.
static TestModelProvider.ToolInvocationRequest	cancelUnclaimedTasksFromBacklog()	Creates a TestModelProvider.ToolInvocationRequest for the cancel_unclaimed_tasks_from_backlog tool.
static TestModelProvider.ToolInvocationRequest	cancelUnclaimedTasksFromBacklog(String backlogId)	Creates a TestModelProvider.ToolInvocationRequest for the cancel_unclaimed_tasks_from_backlog tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	claimTask(String taskId)	Creates a TestModelProvider.ToolInvocationRequest for the claim_task tool.
static TestModelProvider.ToolInvocationRequest	claimTask(String backlogId, String taskId)	Creates a TestModelProvider.ToolInvocationRequest for the claim_task tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	completeTask(Object result)	Creates a TestModelProvider.ToolInvocationRequest for the complete_task tool, serializing the given result object to JSON.
static TestModelProvider.ToolInvocationRequest	completeTaskJson(String resultJson)	Creates a TestModelProvider.ToolInvocationRequest for the complete_task tool, with the given raw result JSON string.
static TestModelProvider.ToolInvocationRequest	createTaskForBacklog(akka.javasdk.agent.task.Task<?> task, String instructions)	Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool.
static TestModelProvider.ToolInvocationRequest	createTaskForBacklog(akka.javasdk.agent.task.Task<?> task, String backlogId, String instructions)	Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	createTaskForBacklog(akka.javasdk.agent.task.TaskTemplate<?> task, String backlogId, Map<String,String> templateParams)	Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool with a specific backlog ID, filling template parameters for a TaskTemplate.
static TestModelProvider.ToolInvocationRequest	createTaskForBacklog(akka.javasdk.agent.task.TaskTemplate<?> task, Map<String,String> templateParams)	Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool, filling template parameters for a TaskTemplate.
static String	createTaskForBacklogToolName(akka.javasdk.agent.task.TaskDefinition<?> task)	Returns the tool name for a create_<taskType>_task_for_backlog tool, derived from the task definition name.
static TestModelProvider.ToolInvocationRequest	createTeam(TestModelProvider.AutonomousAgentTools.TeamMemberSpec... members)	Creates a TestModelProvider.ToolInvocationRequest for the create_team tool.
static TestModelProvider.ToolInvocationRequest	delegateTo(akka.javasdk.agent.task.Task<?> task, Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass, String instructions)	Creates a TestModelProvider.ToolInvocationRequest for a delegate_<task>_to_<agent> tool, deriving the tool name from the task definition and the target agent's component ID.
static TestModelProvider.ToolInvocationRequest	delegateTo(akka.javasdk.agent.task.TaskTemplate<?> task, Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass, Map<String,String> templateParams)	Creates a TestModelProvider.ToolInvocationRequest for a delegate_<task>_to_<agent> tool, filling template parameters for a TaskTemplate.
static TestModelProvider.ToolInvocationRequest	delegateTo(Class<? extends akka.javasdk.agent.Agent> agentClass, String argsJson)	Creates a TestModelProvider.ToolInvocationRequest for a delegate_to_<agent> tool, used when an autonomous agent delegates to a request-based agent.
static String	delegateToToolName(akka.javasdk.agent.task.TaskDefinition<?> task, Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass)	Returns the tool name for a delegate_<task>_to_<agent> tool, derived from the task definition and target agent's component ID.
static String	delegateToToolName(Class<? extends akka.javasdk.agent.Agent> agentClass)	Returns the tool name for a delegate_to_<agent> tool for request-based agent delegation, derived from the target agent's component ID.
static TestModelProvider.ToolInvocationRequest	direct(String participantRef, String message)	Creates a TestModelProvider.ToolInvocationRequest for the direct tool (directed mode only).
static TestModelProvider.ToolInvocationRequest	disbandTeam()	Creates a TestModelProvider.ToolInvocationRequest for the disband_team tool.
static TestModelProvider.ToolInvocationRequest	disbandTeam(String teamId)	Creates a TestModelProvider.ToolInvocationRequest for the disband_team tool with a specific team ID.
static TestModelProvider.ToolInvocationRequest	endConversation()	Creates a TestModelProvider.ToolInvocationRequest for the end_conversation tool (directed mode only).
static List<String>	extractContacts(TestModelProvider.InputMessage message)	Extracts messaging contact addresses from input messages.
static TestModelProvider.ToolInvocationRequest	failTask(String reason)	Creates a TestModelProvider.ToolInvocationRequest for the fail_task tool.
static TestModelProvider.ToolInvocationRequest	getBacklogStatus()	Creates a TestModelProvider.ToolInvocationRequest for the get_backlog_status tool.
static TestModelProvider.ToolInvocationRequest	getBacklogStatus(String backlogId)	Creates a TestModelProvider.ToolInvocationRequest for the get_backlog_status tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	getManagedBacklogStatus()	Creates a TestModelProvider.ToolInvocationRequest for the get_managed_backlog_status tool.
static TestModelProvider.ToolInvocationRequest	getManagedBacklogStatus(String backlogId)	Creates a TestModelProvider.ToolInvocationRequest for the get_managed_backlog_status tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	getTask(String taskId)	Creates a TestModelProvider.ToolInvocationRequest for the get_task tool.
static TestModelProvider.ToolInvocationRequest	getTeamStatus()	Creates a TestModelProvider.ToolInvocationRequest for the get_team_status tool.
static TestModelProvider.ToolInvocationRequest	getTeamStatus(String teamId)	Creates a TestModelProvider.ToolInvocationRequest for the get_team_status tool with a specific team ID.
static TestModelProvider.ToolInvocationRequest	handoffTo(Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass, String context)	Creates a TestModelProvider.ToolInvocationRequest for a handoff_to_<agent> tool, deriving the tool name from the target agent's component ID.
static String	handoffToToolName(Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass)	Returns the tool name for a handoff_to_<agent> tool, derived from the target agent's component ID.
static TestModelProvider.ToolInvocationRequest	providePrompt(String prompt)	Creates a TestModelProvider.ToolInvocationRequest for the provide_prompt tool (scripted mode).
static TestModelProvider.ToolInvocationRequest	releaseTask(String taskId)	Creates a TestModelProvider.ToolInvocationRequest for the release_task tool.
static TestModelProvider.ToolInvocationRequest	releaseTask(String backlogId, String taskId)	Creates a TestModelProvider.ToolInvocationRequest for the release_task tool with a specific backlog ID.
static TestModelProvider.ToolInvocationRequest	sendMessage(String to, String message)	Creates a TestModelProvider.ToolInvocationRequest for the send_message tool.
static TestModelProvider.ToolInvocationRequest	startDirectedConversation(String topic, int maxRounds, List<TestModelProvider.AutonomousAgentTools.ParticipantRef> participants)	Creates a TestModelProvider.ToolInvocationRequest for the start_conversation tool with a directed pattern.
static TestModelProvider.ToolInvocationRequest	startScriptedConversation(String topic, List<TestModelProvider.AutonomousAgentTools.ParticipantRef> participants, List<TestModelProvider.AutonomousAgentTools.ScriptStep> script)	Creates a TestModelProvider.ToolInvocationRequest for the start_conversation tool with a scripted pattern.
static TestModelProvider.ToolInvocationRequest	submitTurn(String response)	Creates a TestModelProvider.ToolInvocationRequest for the submit_turn tool.
static TestModelProvider.ToolInvocationRequest	transferTask(String taskId, String agentId)	Creates a TestModelProvider.ToolInvocationRequest for the transfer_task tool.
static TestModelProvider.ToolInvocationRequest	transferTask(String backlogId, String taskId, String agentId)	Creates a TestModelProvider.ToolInvocationRequest for the transfer_task tool with a specific backlog ID.

Methods inherited from class java.lang.Object

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

Field Details

COMPLETE_TASK

public static final String COMPLETE_TASK

Tool name for completing a task.

See Also:

• Constant Field Values

FAIL_TASK

public static final String FAIL_TASK

Tool name for failing a task.

See Also:

• Constant Field Values

GET_TASK

public static final String GET_TASK

Tool name for looking up a task by ID.

See Also:

• Constant Field Values

CREATE_TEAM

public static final String CREATE_TEAM

Tool name for creating a team.

See Also:

• Constant Field Values

GET_TEAM_STATUS

public static final String GET_TEAM_STATUS

Tool name for getting team status.

See Also:

• Constant Field Values

DISBAND_TEAM

public static final String DISBAND_TEAM

Tool name for disbanding a team.

See Also:

• Constant Field Values

GET_MANAGED_BACKLOG_STATUS

public static final String GET_MANAGED_BACKLOG_STATUS

Tool name for getting managed backlog status (lead side).

See Also:

• Constant Field Values

CANCEL_UNCLAIMED_TASKS_FROM_BACKLOG

public static final String CANCEL_UNCLAIMED_TASKS_FROM_BACKLOG

Tool name for cancelling unclaimed tasks from backlog (lead side).

See Also:

• Constant Field Values

GET_BACKLOG_STATUS

public static final String GET_BACKLOG_STATUS

Tool name for getting backlog status (member side).

See Also:

• Constant Field Values

CLAIM_TASK

public static final String CLAIM_TASK

Tool name for claiming a task (member side).

See Also:

• Constant Field Values

RELEASE_TASK

public static final String RELEASE_TASK

Tool name for releasing a task (member side).

See Also:

• Constant Field Values

TRANSFER_TASK

public static final String TRANSFER_TASK

Tool name for transferring a task (member side).

See Also:

• Constant Field Values

SEND_MESSAGE

public static final String SEND_MESSAGE

Tool name for sending a message to another agent.

See Also:

• Constant Field Values

START_CONVERSATION

public static final String START_CONVERSATION

Tool name for starting a moderated conversation.

See Also:

• Constant Field Values

PROVIDE_PROMPT

public static final String PROVIDE_PROMPT

Tool name for providing a prompt during a scripted conversation step.

See Also:

• Constant Field Values

DIRECT

public static final String DIRECT

Tool name for directing a participant in a conversation (directed mode).

See Also:

• Constant Field Values

BROADCAST

public static final String BROADCAST

Tool name for broadcasting a message to a conversation.

See Also:

• Constant Field Values

END_CONVERSATION

public static final String END_CONVERSATION

Tool name for ending a moderated conversation (directed mode).

See Also:

• Constant Field Values

SUBMIT_TURN

public static final String SUBMIT_TURN

Tool name for submitting a turn response. Used by participants when they have the floor, and by the moderator for their own turns in scripted conversations.

See Also:

• Constant Field Values

Method Details

completeTaskJson

public static TestModelProvider.ToolInvocationRequest completeTaskJson(String resultJson)

Creates a TestModelProvider.ToolInvocationRequest for the complete_task tool, with the given raw result JSON string. The JSON must conform to the task's result type schema. Use completeTask(Object) for type-safe serialization of result objects.

completeTask

public static TestModelProvider.ToolInvocationRequest completeTask(Object result)

Creates a TestModelProvider.ToolInvocationRequest for the complete_task tool, serializing the given result object to JSON. For non-object result types (String, Integer, Number, Boolean, and collections/arrays), wraps the value in a {"result": ...} JSON object matching the runtime's expected format. For object types (records, POJOs), the object's own properties become the tool arguments directly (passthrough).

failTask

public static TestModelProvider.ToolInvocationRequest failTask(String reason)

Creates a TestModelProvider.ToolInvocationRequest for the fail_task tool.

Parameters:

reason - the failure reason

getTask

public static TestModelProvider.ToolInvocationRequest getTask(String taskId)

Creates a TestModelProvider.ToolInvocationRequest for the get_task tool.

Parameters:

taskId - the ID of the task to look up

handoffToToolName

public static String handoffToToolName(Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass)

Returns the tool name for a handoff_to_<agent> tool, derived from the target agent's component ID.

handoffTo

public static TestModelProvider.ToolInvocationRequest handoffTo(Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass,
 String context)

Creates a TestModelProvider.ToolInvocationRequest for a handoff_to_<agent> tool, deriving the tool name from the target agent's component ID.

Parameters:

agentClass - the autonomous agent class to hand off to (must carry @Component or @Component)

context - context passed to the receiving agent

delegateToToolName

public static String delegateToToolName(akka.javasdk.agent.task.TaskDefinition<?> task,
 Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass)

Returns the tool name for a delegate_<task>_to_<agent> tool, derived from the task definition and target agent's component ID.

delegateTo

public static TestModelProvider.ToolInvocationRequest delegateTo(akka.javasdk.agent.task.Task<?> task,
 Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass,
 String instructions)

Creates a TestModelProvider.ToolInvocationRequest for a delegate_<task>_to_<agent> tool, deriving the tool name from the task definition and the target agent's component ID.

Parameters:

task - the task being delegated

agentClass - the agent class to delegate to (must carry @Component or @Component)

instructions - instructions passed to the delegated agent

delegateTo

public static TestModelProvider.ToolInvocationRequest delegateTo(akka.javasdk.agent.task.TaskTemplate<?> task,
 Class<? extends akka.javasdk.agent.autonomous.AutonomousAgent> agentClass,
 Map<String,String> templateParams)

Creates a TestModelProvider.ToolInvocationRequest for a delegate_<task>_to_<agent> tool, filling template parameters for a TaskTemplate.

Parameters:

task - the task template being delegated

agentClass - the agent class to delegate to (must carry @Component or @Component)

templateParams - values for the template parameters

delegateToToolName

public static String delegateToToolName(Class<? extends akka.javasdk.agent.Agent> agentClass)

Returns the tool name for a delegate_to_<agent> tool for request-based agent delegation, derived from the target agent's component ID.

delegateTo

public static TestModelProvider.ToolInvocationRequest delegateTo(Class<? extends akka.javasdk.agent.Agent> agentClass,
 String argsJson)

Creates a TestModelProvider.ToolInvocationRequest for a delegate_to_<agent> tool, used when an autonomous agent delegates to a request-based agent. The runtime resolves the target method from the agent's definition (request-based agents have a single effect method).

Parameters:

agentClass - the request-based agent class (must carry @Component or @Component)

argsJson - the JSON arguments to pass (must match the method's parameter type)

createTeam

public static TestModelProvider.ToolInvocationRequest createTeam(TestModelProvider.AutonomousAgentTools.TeamMemberSpec... members)

Creates a TestModelProvider.ToolInvocationRequest for the create_team tool.

Parameters:

members - the team member specifications (type derived from component ID, with count)

getTeamStatus

public static TestModelProvider.ToolInvocationRequest getTeamStatus()

Creates a TestModelProvider.ToolInvocationRequest for the get_team_status tool. The team_id is optional when there is only one active team.

getTeamStatus

public static TestModelProvider.ToolInvocationRequest getTeamStatus(String teamId)

Creates a TestModelProvider.ToolInvocationRequest for the get_team_status tool with a specific team ID. Required when multiple teams are active.

disbandTeam

public static TestModelProvider.ToolInvocationRequest disbandTeam()

Creates a TestModelProvider.ToolInvocationRequest for the disband_team tool. The team_id is optional when there is only one active team.

disbandTeam

public static TestModelProvider.ToolInvocationRequest disbandTeam(String teamId)

Creates a TestModelProvider.ToolInvocationRequest for the disband_team tool with a specific team ID. Required when multiple teams are active.

createTaskForBacklogToolName

public static String createTaskForBacklogToolName(akka.javasdk.agent.task.TaskDefinition<?> task)

Returns the tool name for a create_<taskType>_task_for_backlog tool, derived from the task definition name.

createTaskForBacklog

public static TestModelProvider.ToolInvocationRequest createTaskForBacklog(akka.javasdk.agent.task.Task<?> task,
 String instructions)

Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool. The backlog_id is auto-resolved when there is only one backlog.

For TaskTemplate definitions, use the overload that accepts a Map of template parameter values instead.

Parameters:

task - the task definition to create

instructions - instructions for the task

createTaskForBacklog

public static TestModelProvider.ToolInvocationRequest createTaskForBacklog(akka.javasdk.agent.task.TaskTemplate<?> task,
 Map<String,String> templateParams)

Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool, filling template parameters for a TaskTemplate. The backlog_id is auto-resolved when there is only one backlog.

Parameters:

task - the task template to create

templateParams - values for the template parameters (e.g. "feature", "requirements")

createTaskForBacklog

public static TestModelProvider.ToolInvocationRequest createTaskForBacklog(akka.javasdk.agent.task.Task<?> task,
 String backlogId,
 String instructions)

Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool with a specific backlog ID. Required when multiple backlogs exist.

Parameters:

task - the task definition to create

backlogId - the backlog ID

instructions - instructions for the task

createTaskForBacklog

public static TestModelProvider.ToolInvocationRequest createTaskForBacklog(akka.javasdk.agent.task.TaskTemplate<?> task,
 String backlogId,
 Map<String,String> templateParams)

Creates a TestModelProvider.ToolInvocationRequest for a create_<taskType>_task_for_backlog tool with a specific backlog ID, filling template parameters for a TaskTemplate.

Parameters:

task - the task template to create

backlogId - the backlog ID

templateParams - values for the template parameters

getManagedBacklogStatus

public static TestModelProvider.ToolInvocationRequest getManagedBacklogStatus()

Creates a TestModelProvider.ToolInvocationRequest for the get_managed_backlog_status tool. The backlog_id is auto-resolved when there is only one backlog.

getManagedBacklogStatus

public static TestModelProvider.ToolInvocationRequest getManagedBacklogStatus(String backlogId)

Creates a TestModelProvider.ToolInvocationRequest for the get_managed_backlog_status tool with a specific backlog ID. Required when multiple backlogs exist.

cancelUnclaimedTasksFromBacklog

public static TestModelProvider.ToolInvocationRequest cancelUnclaimedTasksFromBacklog()

Creates a TestModelProvider.ToolInvocationRequest for the cancel_unclaimed_tasks_from_backlog tool. The backlog_id is auto-resolved when there is only one backlog.

cancelUnclaimedTasksFromBacklog

public static TestModelProvider.ToolInvocationRequest cancelUnclaimedTasksFromBacklog(String backlogId)

Creates a TestModelProvider.ToolInvocationRequest for the cancel_unclaimed_tasks_from_backlog tool with a specific backlog ID. Required when multiple backlogs exist.

getBacklogStatus

public static TestModelProvider.ToolInvocationRequest getBacklogStatus()

Creates a TestModelProvider.ToolInvocationRequest for the get_backlog_status tool. The backlog_id is auto-resolved when there is only one backlog.

getBacklogStatus

public static TestModelProvider.ToolInvocationRequest getBacklogStatus(String backlogId)

Creates a TestModelProvider.ToolInvocationRequest for the get_backlog_status tool with a specific backlog ID. Required when multiple backlogs exist.

claimTask

public static TestModelProvider.ToolInvocationRequest claimTask(String taskId)

Creates a TestModelProvider.ToolInvocationRequest for the claim_task tool.

Parameters:

taskId - the ID of the task to claim

claimTask

public static TestModelProvider.ToolInvocationRequest claimTask(String backlogId,
 String taskId)

Creates a TestModelProvider.ToolInvocationRequest for the claim_task tool with a specific backlog ID. Required when multiple backlogs exist.

Parameters:

backlogId - the backlog ID

taskId - the ID of the task to claim

releaseTask

public static TestModelProvider.ToolInvocationRequest releaseTask(String taskId)

Creates a TestModelProvider.ToolInvocationRequest for the release_task tool.

Parameters:

taskId - the ID of the task to release

releaseTask

public static TestModelProvider.ToolInvocationRequest releaseTask(String backlogId,
 String taskId)

Creates a TestModelProvider.ToolInvocationRequest for the release_task tool with a specific backlog ID. Required when multiple backlogs exist.

Parameters:

backlogId - the backlog ID

taskId - the ID of the task to release

transferTask

public static TestModelProvider.ToolInvocationRequest transferTask(String taskId,
 String agentId)

Creates a TestModelProvider.ToolInvocationRequest for the transfer_task tool.

Parameters:

taskId - the ID of the task to transfer

agentId - the ID of the agent to transfer the task to

transferTask

public static TestModelProvider.ToolInvocationRequest transferTask(String backlogId,
 String taskId,
 String agentId)

Creates a TestModelProvider.ToolInvocationRequest for the transfer_task tool with a specific backlog ID. Required when multiple backlogs exist.

Parameters:

backlogId - the backlog ID

taskId - the ID of the task to transfer

agentId - the ID of the agent to transfer the task to

sendMessage

public static TestModelProvider.ToolInvocationRequest sendMessage(String to,
 String message)

Creates a TestModelProvider.ToolInvocationRequest for the send_message tool. The to address can be obtained from the runtime-injected messaging contacts using extractContacts(InputMessage).

Parameters:

to - the agent address from the contacts list (e.g. "developer/team-id-developer-1")

message - the message to send

extractContacts

public static List<String> extractContacts(TestModelProvider.InputMessage message)

Extracts messaging contact addresses from input messages. The runtime injects contacts in user messages with the format "Messaging contacts: agent-type/instance-id, ...". This utility parses those messages and returns the contact addresses.

Usage example in a test:

 leadModel.fixedResponse(msg -> {
   if (msg instanceof TestModelProvider.UserMessage um) {
     var contacts = extractContacts(um);
     if (!contacts.isEmpty()) {
       return new AiResponse(sendMessage(contacts.get(0), "Hello!"));
     }
   }
   return new AiResponse("Acknowledged.");
 });
 

Parameters:

message - the input message to extract contacts from

Returns:

list of contact addresses, empty if no contacts found

startScriptedConversation

public static TestModelProvider.ToolInvocationRequest startScriptedConversation(String topic,
 List<TestModelProvider.AutonomousAgentTools.ParticipantRef> participants,
 List<TestModelProvider.AutonomousAgentTools.ScriptStep> script)

Creates a TestModelProvider.ToolInvocationRequest for the start_conversation tool with a scripted pattern. The moderator defines participants and a turn script upfront.

Parameters:

topic - the conversation topic

participants - the participant references (type and reference name)

script - the ordered turn sequence

startDirectedConversation

public static TestModelProvider.ToolInvocationRequest startDirectedConversation(String topic,
 int maxRounds,
 List<TestModelProvider.AutonomousAgentTools.ParticipantRef> participants)

Creates a TestModelProvider.ToolInvocationRequest for the start_conversation tool with a directed pattern. The moderator controls each turn dynamically.

Parameters:

topic - the conversation topic

maxRounds - safety limit on conversation rounds

participants - the participant references (type and reference name)

providePrompt

public static TestModelProvider.ToolInvocationRequest providePrompt(String prompt)

Creates a TestModelProvider.ToolInvocationRequest for the provide_prompt tool (scripted mode). Provides a contextual prompt for the current participant step.

Parameters:

prompt - the prompt to give to the participant

direct

public static TestModelProvider.ToolInvocationRequest direct(String participantRef,
 String message)

Creates a TestModelProvider.ToolInvocationRequest for the direct tool (directed mode only). Grants the floor to a named participant with a direction message.

Parameters:

participantRef - the reference name of the participant to direct

message - the direction message for the participant

broadcast

public static TestModelProvider.ToolInvocationRequest broadcast(String message)

Creates a TestModelProvider.ToolInvocationRequest for the broadcast tool. Posts a message to the conversation without granting the floor.

Parameters:

message - the message to broadcast

endConversation

public static TestModelProvider.ToolInvocationRequest endConversation()

Creates a TestModelProvider.ToolInvocationRequest for the end_conversation tool (directed mode only). Ends the conversation and receives the full transcript.

submitTurn

public static TestModelProvider.ToolInvocationRequest submitTurn(String response)

Creates a TestModelProvider.ToolInvocationRequest for the submit_turn tool. Used by participants to submit their response, and by the moderator for their own turns in scripted conversations.

Parameters:

response - the response message