Raxol.AgentClientProtocol.Schema.AvailableCommand (Raxol Agent Client Protocol v0.1.0)

Copy Markdown View Source

A single command the agent can execute, as advertised via AvailableCommandsUpdate.

Ported from the MIT f1729/agent_client_protocol (c) 2025 f1729; see NOTICE.md.

Summary

Types

t()

Functions

from_json(map)

Total: never raises. Missing/non-string name/description is the only failure mode (required fields).

new(name, description)
to_json(c)

Types

t()

@type t() :: %Raxol.AgentClientProtocol.Schema.AvailableCommand{
  _meta: map(),
  description: String.t(),
  input: Raxol.AgentClientProtocol.Schema.AvailableCommandInput.t() | nil,
  name: String.t()
}

Functions

from_json(map)

@spec from_json(term()) :: {:ok, t()} | {:error, term()}

Total: never raises. Missing/non-string name/description is the only failure mode (required fields).

new(name, description)

@spec new(String.t(), String.t()) :: t()

to_json(c)

@spec to_json(t()) :: map()