API Reference hermes_mcp v#0.12.0

Modules

High-level DSL for defining MCP (Model Context Protocol) clients.

Represents an operation to be performed by the MCP client.

Fluent API for building MCP protocol errors.

Handles parsing and validation of MCP (Model Context Protocol) messages using the Peri library.

Represents successful responses in the MCP protocol.

Build MCP servers that extend language model capabilities.

Defines the behaviour for MCP prompts.

Defines the behaviour for MCP resources.

Defines the behaviour for MCP tools.

Raised when required MCP server configuration is missing or invalid.

The Hermes Frame.

Behaviour for registry adapters in MCP servers.

Fluent interface for building MCP component responses.

SSE (Server-Sent Events) transport implementation for MCP servers.

A Plug implementation for the SSE (Server-Sent Events) transport.

STDIO transport implementation for MCP servers.

StreamableHTTP transport implementation for MCP servers.

A Plug implementation for the Streamable HTTP transport.

Defines the behavior that all transport implementations must follow.

A transport implementation that uses Server-Sent Events (SSE) for receiving messages and HTTP POST requests for sending messages back to the server.

A transport implementation that uses standard input/output.

A transport implementation that uses Streamable HTTP as specified in MCP 2025-03-26.

A transport implementation that uses WebSockets for bidirectional communication with the MCP server.

Mix Tasks

Mix task to test the SSE transport implementation, interactively sending commands.

Mix task to test the STDIO transport implementation, interactively sending commands.

Mix task to test the Streamable HTTP transport implementation, interactively sending commands.

Mix task to test the WebSocket transport implementation, interactively sending commands.