# `Jido.AI.Actions.Planning.Plan`
[🔗](https://github.com/agentjido/jido_ai/blob/v2.4.0/lib/jido_ai/actions/planning/plan.ex#L1)

A Jido.Action for generating structured plans from goals.

This action uses ReqLLM with a specialized system prompt for planning,
generating step-by-step plans that consider constraints and available resources.

## Parameters

* `model` (optional) - Model alias (e.g., `:planning`) or direct spec
* `goal` (required) - The goal to achieve
* `constraints` (optional) - List of constraints/limitations
* `resources` (optional) - List of available resources
* `max_steps` (optional) - Maximum number of steps in the plan (default: `10`)
* `max_tokens` (optional) - Maximum tokens to generate (default: `4096`)
* `temperature` (optional) - Sampling temperature (default: `0.7`)
* `timeout` (optional) - Request timeout in milliseconds

## Examples

    # Basic planning
    {:ok, result} = Jido.Exec.run(Jido.AI.Actions.Planning.Plan, %{
      goal: "Build a personal blog website"
    })

    # With constraints and resources
    {:ok, result} = Jido.Exec.run(Jido.AI.Actions.Planning.Plan, %{
      goal: "Launch a SaaS product",
      constraints: ["Budget under $10k", "Must launch in 3 months"],
      resources: ["2 developers", "Existing customer base"],
      max_steps: 15
    })

# `__action_metadata__`

Returns the Action metadata. Alias for to_json/0.

# `category`

Returns the category of the Action.

# `description`

Returns the description of the Action.

# `name`

Returns the name of the Action.

# `on_after_run`

Lifecycle hook called after Action execution.

# `on_after_validate_output`

Lifecycle hook called after output validation.

# `on_after_validate_params`

Lifecycle hook called after parameter validation.

# `on_before_validate_output`

Lifecycle hook called before output validation.

# `on_before_validate_params`

Lifecycle hook called before parameter validation.

# `on_error`

Lifecycle hook called when an error occurs.

# `output_schema`

Returns the output schema of the Action.

# `run`

Executes the plan action.

## Returns

* `{:ok, result}` - Successful response with `plan`, `steps`, `goal`, and `usage` keys
* `{:error, reason}` - Error from ReqLLM or validation

## Result Format

    %{
      plan: "The full plan text",
      steps: ["Step 1", "Step 2", ...],
      goal: "The original goal",
      model: "anthropic:claude-sonnet-4-20250514",
      usage: %{...}
    }

# `schema`

Returns the input schema of the Action.

# `tags`

Returns the tags associated with the Action.

# `to_json`

Returns the Action metadata as a JSON-serializable map.

# `to_tool`

Converts the Action to an LLM-compatible tool format.

# `validate_output`

```elixir
@spec validate_output(map()) :: {:ok, map()} | {:error, String.t()}
```

Validates the output result for the Action.

## Examples

    iex> defmodule ExampleAction do
    ...>   use Jido.Action,
    ...>     name: "example_action",
    ...>     output_schema: [
    ...>       result: [type: :string, required: true]
    ...>     ]
    ...> end
    ...> ExampleAction.validate_output(%{result: "test", extra: "ignored"})
    {:ok, %{result: "test", extra: "ignored"}}

    iex> ExampleAction.validate_output(%{extra: "ignored"})
    {:error, "Invalid output for Action: Required key :result not found"}

# `validate_params`

```elixir
@spec validate_params(map()) :: {:ok, map()} | {:error, String.t()}
```

Validates the input parameters for the Action.

## Examples

    iex> defmodule ExampleAction do
    ...>   use Jido.Action,
    ...>     name: "example_action",
    ...>     schema: [
    ...>       input: [type: :string, required: true]
    ...>     ]
    ...> end
    ...> ExampleAction.validate_params(%{input: "test"})
    {:ok, %{input: "test"}}

    iex> ExampleAction.validate_params(%{})
    {:error, "Invalid parameters for Action: Required key :input not found"}

# `vsn`

Returns the version of the Action.

---

*Consult [api-reference.md](api-reference.md) for complete listing*