ExMCP.Client.Types (ex_mcp v0.9.2)

View Source

Shared type definitions for ExMCP.Client modules.

This module provides common type definitions used across the client architecture to ensure consistency and type safety.

Summary

Types

client()

A client process reference - can be a PID, registered name, or GenServer reference.

default_timeout()

Default timeout value in milliseconds.

mcp_method()

MCP method name used in requests.

mcp_params()

Parameters map for MCP requests.

mcp_response()

Standard MCP response format - either success with data or error with reason.

request_opts()

Options for MCP requests, typically including timeout and format options.

request_opts_or_timeout()

Request options or timeout value.

tool_arguments()

Arguments map for tool calls.

tool_name()

MCP tool name.

uri()

MCP resource URI - typically a file:// or http:// URI.

Types

client()

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

A client process reference - can be a PID, registered name, or GenServer reference.

default_timeout()

@type default_timeout() :: pos_integer()

Default timeout value in milliseconds.

mcp_method()

@type mcp_method() :: String.t()

MCP method name used in requests.

mcp_params()

@type mcp_params() :: map()

Parameters map for MCP requests.

mcp_response()

@type mcp_response() :: {:ok, any()} | {:error, any()}

Standard MCP response format - either success with data or error with reason.

request_opts()

@type request_opts() :: keyword()

Options for MCP requests, typically including timeout and format options.

request_opts_or_timeout()

@type request_opts_or_timeout() :: keyword() | timeout()

Request options or timeout value.

tool_arguments()

@type tool_arguments() :: map()

Arguments map for tool calls.

tool_name()

@type tool_name() :: String.t()

MCP tool name.

uri()

@type uri() :: String.t()

MCP resource URI - typically a file:// or http:// URI.