Package ai.confiqure

Annotation Type Confiqure.Tool

Enclosing class:
Confiqure
@Target(METHOD) @Retention(RUNTIME) public static @interface Confiqure.Tool
Marks a method as a tool the chat agent can invoke during a session.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    name
    Tool name.
    boolean
    serverSide
    true (default): a server-side tool — confiqure dispatches an HTTP call to this controller method (returns data / performs a backend action, no UI).

  • Element Details

    • name

      String name
      Tool name. Defaults to the method name when blank.
      Default:
      ""

    • serverSide

      boolean serverSide
      true (default): a server-side tool — confiqure dispatches an HTTP call to this controller method (returns data / performs a backend action, no UI).

      false: a frontend tool — this method is a contract stub whose handler runs in the host's browser via the embed SDK. The method signature still defines the I/O contract (its @RequestBody DTO is the input, its return type the output), but the body never runs on the backend. Use for anything needing a UI (OAuth, pickers, rendering).

      Default:
      true