ExAthena.Tool.Spec (ExAthena v0.7.1)

Copy Markdown View Source

Canonical, unified representation of a tool — whether backed by a behaviour-implementing module or a dynamically-discovered MCP tool.

Kinds

  • :module — wraps a module that implements ExAthena.Tool. All fields are populated from the module's callbacks at construction time.
  • :mcp — wraps a tool discovered from an MCP server. The tool name is namespaced as "<server>_<tool>". MCP tools are never assumed parallel-safe.

Construction

spec = ExAthena.Tool.Spec.from_module(MyApp.ReadTool)
spec = ExAthena.Tool.Spec.from_mcp(tool_map, "myserver")

Dispatch

ExAthena.Tool.Spec.execute(spec, args, ctx)

Summary

Types

kind()
t()

Functions

execute(spec, args, ctx)

Execute the tool with args and ctx.

from_mcp(tool_map, server_name)

Build a spec from an MCP tool map and server name.

from_module(mod)

Build a spec from a module implementing ExAthena.Tool.

parallel_safe?(spec)

Return the cached parallel_safe? flag.

Types

kind()

@type kind() :: :module | :mcp

t()

@type t() :: %ExAthena.Tool.Spec{
  description: String.t(),
  kind: kind(),
  mcp_server: String.t() | nil,
  mcp_tool_name: String.t() | nil,
  module: module() | nil,
  name: String.t(),
  parallel_safe?: boolean(),
  schema: map()
}

Functions

execute(spec, args, ctx)

@spec execute(t(), map(), ExAthena.ToolContext.t()) ::
  {:ok, term()} | {:error, term()} | {:halt, term()}

Execute the tool with args and ctx.

Dispatches to module.execute/2 for :module specs, and to ExAthena.Mcp.Tool.execute/3 for :mcp specs.

from_mcp(tool_map, server_name)

@spec from_mcp(map(), String.t()) :: t()

Build a spec from an MCP tool map and server name.

tool_map is a map with string keys "name", "description", and "inputSchema" as returned by tools/list. The resulting spec's :name is "<server>_<tool>".

from_module(mod)

@spec from_module(module()) :: t()

Build a spec from a module implementing ExAthena.Tool.

parallel_safe?(spec)

@spec parallel_safe?(t()) :: boolean()

Return the cached parallel_safe? flag.