# `OzMcp.Structs.InitializeResult`
[🔗](https://github.com/oz-elixir/oz_mcp/blob/v0.9.0/lib/oz_mcp/structs/initialize_result.ex#L1)

Helper module used to build `InitializeResult` structure.

_(MCP protocol: 2025-11-25)_

## Short example:

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

Result:

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

## Long example:

```elixir
%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:

```elixir
%{
  :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](https://modelcontextprotocol.io/specification/2025-11-25/schema#initializeresult)

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `protocolVersion` | `protocol_version/2` | string | yes |
| `instructions` | `instructions/2` | string | no |
| `_meta` | `_meta/2` | map | no |
| `extras` | `extras/2` | map | no |
| `capabilities` | `capabilities/2` | `t:OzMcp.Structs.ServerCapabilities.t/0` | yes |
| `serverInfo` | `server_info/2` | `t:OzMcp.Structs.Implementation.t/0` | yes |

# `t`

```elixir
@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()
}
```

# `build`

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

# `capabilities`

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

# `extras`

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

# `instructions`

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

# `protocol_version`

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

# `server_info`

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*
