Hermes.Transport.STDIO (hermes_mcp v0.13.0)

A transport implementation that uses standard input/output.

Notes
For initialization and setup, check our Installation & Setup and the Transport options guides for reference.

Summary

Types

option()

The options for the STDIO transport.

params_t()

t()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

get_schema(atom)

options_schema(data)

options_schema!(data)

Types

option()

@type option() ::
  {:command, Path.t()}
  | {:args, [String.t()] | nil}
  | {:env, map() | nil}
  | {:cwd, Path.t() | nil}
  | {:client, GenServer.server()}
  | GenServer.option()

The options for the STDIO transport.

:command - The command to run, it will be searched in the system's PATH.
:args - The arguments to pass to the command, as a list of strings.
:env - The extra environment variables to set for the command, as a map.
:cwd - The working directory for the command.
:client - The client to send the messages to, respecting the GenServer "Name Registration" section

And any other GenServer init option.

params_t()

@type params_t() :: Enumerable.t(option())

t()

@type t() :: GenServer.server()

Functions

child_spec(init_arg)

Returns a specification to start this module under a supervisor.

See Supervisor.