Frontend tools

Frontend tools let your AI agent execute actions directly inside your app — initiating a transfer, resetting a password, cancelling an order, etc. Tools are defined on your AI agent in the Gleap dashboard (AI agent > Tools > Frontend tool) — name, description, parameters and execution mode all live there. Your app only registers a handler that executes the tool. Learn how to set up Frontend tools in our help center article.

Register a tool handler

Gleap.getInstance().registerAgentTool("send-money", new GleapAgentToolHandler() {
    @Override
    public void execute(JSONObject params, GleapAgentToolResultCallback callback) {
        String amount = params.optString("amount");
        String contact = params.optString("contact");

        // Run your own logic here.

        // Return a string or JSON — the AI waits for this response.
        callback.onResult("The transfer was initiated. The user must confirm it in the banking app.");
    }
});

Or with Kotlin:

Gleap.getInstance().registerAgentTool("send-money") { params, callback ->
    val amount = params.opt("amount")

    // Run your own logic here.

    // Return a string or JSON — the AI waits for this response.
    callback.onResult("The transfer was initiated. The user must confirm it in the banking app.")
}

Handler contract

The handler receives the parameters configured in the dashboard as a JSONObject, filled with the values the AI collected.
Call the callback exactly once with the result — a String or a JSONObject / JSONArray (stringified automatically). The result is sent back to the AI, which uses it to reply.
The callback can be invoked asynchronously from any thread — the AI waits for it.
Exceptions thrown by the handler are caught and reported to the AI automatically.
If no handler is registered for a tool, the AI is informed so it can respond accordingly.

Execution modes

Set per tool in the dashboard:

Auto — the handler runs immediately when the AI calls the tool.
Ask before final execution — the AI adds a confirmation button to its reply; the handler only runs after the user confirms.

Migrating from `setAiTools`

Gleap.getInstance().setAiTools(...) and the GleapAiTool / GleapAiToolParameter classes have been removed. Tools defined via setAiTools could only return a static response to the AI — Frontend tools execute real code and return live results. Define your tools on the AI agent in the dashboard and register their handlers via registerAgentTool(name, handler) instead. The setAiToolExecutedCallback callback remains available.

Get Started

SDKs

Server-side event tracking

Guides

Register a tool handler

Execution modes

Migrating from `setAiTools`

​Register a tool handler

​Execution modes

​Migrating from setAiTools

Register a tool handler

Execution modes

Migrating from `setAiTools`