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

Helper module used to build `PromptArgument` structure.

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

## Short example:

```elixir
%PromptArgument{}
  |> PromptArgument.name("city")
  |> PromptArgument.description("The city name")
  |> PromptArgument.required(true)
  |> PromptArgument.build()
```

Result:

```elixir
%{name: "city", description: "The city name", required: true}
```

Specification: [PromptArgument](https://modelcontextprotocol.io/specification/2025-11-25/schema#promptargument)

## Fields

| Field | Setter | Type | Required |
|---|---|---|---|
| `name` | `name/2` | string | yes |
| `title` | `title/2` | string | no |
| `description` | `description/2` | string | no |
| `required` | `required/2` | boolean | no |

# `t`

```elixir
@type t() :: %OzMcp.Structs.PromptArgument{
  description: String.t() | nil,
  name: String.t(),
  required: boolean() | nil,
  title: String.t() | nil
}
```

# `build`

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

# `description`

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

# `name`

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

# `required`

```elixir
@spec required(t(), boolean() | nil) :: t()
```

# `title`

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

---

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