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

Register the handler for a dashboard-defined Frontend tool. Use the tool’s runtime name shown in the tool editor.

Gleap.registerAgentTool(
  name: 'send-money',
  handler: (params) async {
    final amount = params['amount'];
    final contact = params['contact'];

    // Run your own logic here.

    // Return a string or JSON — the AI waits for this response.
    return '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 map, filled with the values the AI collected.
• Return a String or a JSON-encodable object (objects are stringified). The result is sent back to the AI, which uses it to reply.
• Async handlers are fully supported — the AI waits for the returned future.
• Thrown errors 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.
• Works on Android, iOS and Web.

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.setAiTools(tools: ...) and the AITool / AIToolParams 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 Gleap.registerAgentTool(name:, handler:) instead. The toolExecution listener remains available.