Package akka.javasdk.annotations

Annotation Interface AgentDescription

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface AgentDescription
Annotation to provide metadata and description for an Agent component.

This annotation is essential for multi-agent systems where agents need to be discovered and selected dynamically. The information provided here is used by the AgentRegistry for agent selection and planning.

Agent Selection: Planning agents can use this metadata to automatically select appropriate agents for specific tasks. The description should clearly explain the agent's capabilities and domain of expertise.

Role-based Organization: The role field allows grouping agents by function (e.g., "worker", "planner", "coordinator") for easier discovery and organization in complex multi-agent systems.

  • Required Element Summary

    Required Elements
    Modifier and Type
    Required Element
    Description
    String
    description
     
    String
    name
     

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    role
     

  • Element Details