API Reference MCP Elixir SDK v#1.1.0

Copy Markdown View Source

Modules

MCP client implementation.

JSON-RPC 2.0 encoding/decoding for MCP messages.

Capabilities declared by an MCP client during initialization.

Server capability for argument auto-completion. Empty struct indicates support.

Client capability for elicitation (form and/or URL modes).

Server capability for logging. Empty struct indicates support.

Server capability for prompts.

Server capability for resources.

Client capability for filesystem roots.

Client capability for sampling. Empty struct indicates support.

Capabilities declared by an MCP server during initialization.

Server capability for tools.

MCP protocol error codes and error struct.

Message types for completion/complete.

Parameters for completion/complete.

Result of completion/complete.

Message types for elicitation/create.

Parameters for elicitation/create.

Result of elicitation/create.

Message types for the MCP initialize handshake.

Parameters for the initialize request.

Result of the initialize request.

Message types for logging operations.

Parameters for notifications/message (log message from server).

Parameters for logging/setLevel.

A JSON-RPC 2.0 notification message.

Parameter types for various MCP notifications.

Parameters for notifications/cancelled.

Parameters for notifications/progress.

Parameters for notifications/resources/updated.

Message types for the ping method.

Parameters for the ping request (empty).

Message types for prompt operations.

Parameters for prompts/get.

Parameters for prompts/list.

A JSON-RPC 2.0 request message.

Message types for resource operations.

Parameters for resources/list.

Result of resources/list.

Parameters for resources/templates/list.

Result of resources/templates/list.

Parameters for resources/read.

Result of resources/read.

Parameters for resources/subscribe.

Parameters for resources/unsubscribe.

A JSON-RPC 2.0 response message.

Message types for roots/list.

Parameters for roots/list (empty).

Message types for sampling/createMessage.

Parameters for sampling/createMessage.

Result of sampling/createMessage.

Message types for tools/list and tools/call.

Parameters for tools/call.

Parameters for tools/list.

MCP method name constants and notification method constants.

Content annotations describing audience, priority, and modification time.

Polymorphic content types used in tool results, prompts, and resources.

Base64-encoded audio content block.

An embedded resource content block (type: "resource").

Base64-encoded image content block.

A link to a resource (type: "resource_link").

Icon for visual identification of tools, resources, prompts, etc.

Identifies an MCP client or server implementation.

A hint for model selection in sampling requests.

Model selection preferences for sampling requests.

An MCP prompt — a template for user interactions.

An argument for an MCP prompt template.

A message within a prompt result.

An MCP resource — data or context available to the LLM.

Contents of a resource, returned by resources/read.

An MCP resource template — a URI template (RFC 6570) for dynamic resources.

A filesystem root that a client exposes to servers.

A message in a sampling request conversation.

An MCP tool definition.

Additional properties describing a tool's behavior.

MCP server implementation.

Behaviour for implementing MCP server feature handlers.

Context passed to handle_call_tool/4 handlers during tool execution.

Behaviour for MCP transports.

Server-Sent Events (SSE) encoding and decoding utilities.

Stdio transport for MCP.

Streamable HTTP client transport for MCP.

Plug endpoint for the MCP Streamable HTTP transport.

A transport adapter that wraps an already-started transport process.

Streamable HTTP server transport for MCP.