McpServer.Resource.ReadResult (HTTP MCP Server v0.8.0)

Represents the response from reading a resource.

A read result contains a list of content items that were retrieved from the resource.

Fields

contents - List of Resource.Content structs

Examples

iex> result = McpServer.Resource.ReadResult.new(
...>   contents: [
...>     McpServer.Resource.Content.new(
...>       name: "file.txt",
...>       uri: "file:///file.txt",
...>       text: "Content"
...>     )
...>   ]
...> )
%McpServer.Resource.ReadResult{
  contents: [%McpServer.Resource.Content{...}]
}

Summary

Types

t()

Functions

new(opts)

Creates a new Resource.ReadResult struct.

Types

t()

@type t() :: %McpServer.Resource.ReadResult{
  contents: [McpServer.Resource.Content.t()]
}

Functions

new(opts)

@spec new(keyword()) :: t()

Creates a new Resource.ReadResult struct.

Parameters

opts - Keyword list of read result options:
- :contents (required) - List of Content structs

Examples

iex> McpServer.Resource.ReadResult.new(contents: [])
%McpServer.Resource.ReadResult{contents: []}

iex> content = McpServer.Resource.Content.new(
...>   name: "example.txt",
...>   uri: "file:///example.txt",
...>   text: "Hello"
...> )
iex> McpServer.Resource.ReadResult.new(contents: [content])
%McpServer.Resource.ReadResult{contents: [%McpServer.Resource.Content{...}]}