← back to ecosystem
foundation version 2.0.0 package jido_action

Jido Action

Composable, validated command pattern for Elixir with built-in AI tool integration

docs hex issues github ★10
Open source on GitHub →
quickstart.exs mix deps 
defp deps do
  [
    {:jido_action, "~> 2.0.0"}
  ]
end

AT A GLANCE

Structured action definition with compile-time validation and rich metadata
Dual schema validation — NimbleOptions and Zoi with type coercion
AI tool integration — automatic conversion to OpenAI function calling format
Robust execution engine with retries, timeouts, and process monitoring

ECOSYSTEM RELATIONSHIPS

Depends On
none

FULL OVERVIEW

Overview

Jido Action is the foundational action framework for the Jido ecosystem — a composable, validated command pattern for Elixir applications with built-in AI tool integration. It provides a standardized way to define discrete units of functionality that can be validated at compile and runtime, composed into complex workflows, and automatically converted into LLM-compatible tool definitions for AI agent integration.

Purpose

Jido Action serves as the Base Agentic Command Pattern & Tools SDK for the Jido ecosystem. It defines the universal interface through which all agent capabilities are expressed — every action an agent can take is a Jido.Action. The package provides the contract (schema validation, lifecycle hooks, error handling) and the execution machinery (sync/async execution, retries, timeouts, compensation) that the rest of the ecosystem builds upon.

Major Components

Jido.Action — Core Behavior

The foundational behaviour module that all actions implement via use Jido.Action. Provides compile-time configuration validation, runtime parameter and output schema validation, lifecycle hooks, metadata, and automatic JSON serialization. Every action implements a single run/2 callback.

Jido.Exec — Execution Engine

Modular execution engine supporting synchronous and asynchronous execution, automatic retries with exponential backoff, timeout handling, parameter/output validation, telemetry integration, error compensation, action chaining, closures, and instance-scoped supervision.

Jido.Instruction — Workflow Composition

Wraps actions with params, context, and runtime options to create discrete work orders. Supports multiple creation formats, normalization, and action allowlist validation.

Jido.Plan — DAG Execution Planning

Directed Acyclic Graph-based execution planning for complex workflows with dependency declarations, parallel execution phases, and cycle detection.

Jido.Action.Tool — AI Tool Conversion

Converts any Jido Action into a standardized tool map compatible with LLM function calling (OpenAI format) with automatic JSON Schema generation.

Pre-built Tools

25+ tools organized by domain: Basic utilities, Arithmetic, File operations, HTTP requests (Req), GitHub Issues (Tentacat), Weather (NWS API), Workflow primitives, Lua evaluation, and more.