OzMcp.Structs.InitializeResult (OzMcp v0.9.0)

Copy Markdown View Source

Helper module used to build InitializeResult structure.

(MCP protocol: 2025-11-25)

Short example:

%InitializeResult{}
  |> InitializeResult.protocol_version("2025-11-25")
  |> InitializeResult.server_info(
    %Implementation{}
    |> Implementation.name("my-server")
    |> Implementation.version("1.0.0")
  )
  |> InitializeResult.build()

Result:

%{
  capabilities: %{},
  protocolVersion: "2025-11-25",
  serverInfo: %{name: "my-server", version: "1.0.0"}
}

Long example:

%InitializeResult{}
  |> InitializeResult.protocol_version("2025-11-25")
  |> InitializeResult.capabilities(
    %ServerCapabilities{}
    |> ServerCapabilities.tools(true)
  )
  |> InitializeResult.server_info(
    %Implementation{}
    |> Implementation.name("my-server")
    |> Implementation.title("My MCP Server")
    |> Implementation.version("1.0.0")
  )
  |> InitializeResult.instructions("Use the tools responsibly")
  |> InitializeResult.extras(%{"region" => "eu-west-1", "release" => "stable"})
  |> InitializeResult.build()

Result:

%{
  :instructions => "Use the tools responsibly",
  :capabilities => %{tools: %{}},
  :protocolVersion => "2025-11-25",
  :serverInfo => %{
    name: "my-server",
    version: "1.0.0",
    title: "My MCP Server"
  },
  "region" => "eu-west-1",
  "release" => "stable"
}

Specification: InitializeResult

Fields

FieldSetterTypeRequired
protocolVersionprotocol_version/2stringyes
instructionsinstructions/2stringno
_meta_meta/2mapno
extrasextras/2mapno
capabilitiescapabilities/2OzMcp.Structs.ServerCapabilities.t/0yes
serverInfoserver_info/2OzMcp.Structs.Implementation.t/0yes

Summary

Types

t()

@type t() :: %OzMcp.Structs.InitializeResult{
  _meta: map() | nil,
  capabilities: OzMcp.Structs.ServerCapabilities.t(),
  extras: map() | nil,
  instructions: String.t() | nil,
  protocolVersion: String.t(),
  serverInfo: OzMcp.Structs.Implementation.t()
}

Functions

build(struct)

@spec build(t()) :: map()

capabilities(struct, value)

@spec capabilities(t(), OzMcp.Structs.ServerCapabilities.t()) :: t()

extras(struct, value)

@spec extras(t(), map() | nil) :: t()

instructions(struct, value)

@spec instructions(t(), String.t() | nil) :: t()

protocol_version(struct, value)

@spec protocol_version(t(), String.t()) :: t()

server_info(struct, value)

@spec server_info(t(), OzMcp.Structs.Implementation.t()) :: t()