McpServer.Prompt.Argument (HTTP MCP Server v0.6.0)

Represents an argument definition for a prompt.

Arguments define the parameters that can be passed to a prompt template. They include metadata about whether the argument is required and a description to help users understand what value to provide.

Fields

name - Argument identifier
description - Human-readable description
required - Whether the argument is mandatory

Examples

iex> arg = McpServer.Prompt.Argument.new(
...>   name: "language",
...>   description: "Programming language",
...>   required: true
...> )
%McpServer.Prompt.Argument{
  name: "language",
  description: "Programming language",
  required: true
}

Summary

Types

t()

Functions

new(opts)

Creates a new Prompt.Argument struct.

Types

t()

@type t() :: %McpServer.Prompt.Argument{
  description: String.t(),
  name: String.t(),
  required: boolean()
}

Functions

new(opts)

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

Creates a new Prompt.Argument struct.

Parameters

opts - Keyword list of argument options:
- :name (required) - Argument identifier
- :description (required) - Human-readable description
- :required - Whether the argument is mandatory (default: false)

Examples

iex> McpServer.Prompt.Argument.new(
...>   name: "user_name",
...>   description: "The user's name"
...> )
%McpServer.Prompt.Argument{
  name: "user_name",
  description: "The user's name",
  required: false
}

iex> McpServer.Prompt.Argument.new(
...>   name: "code",
...>   description: "Code to review",
...>   required: true
...> )
%McpServer.Prompt.Argument{
  name: "code",
  description: "Code to review",
  required: true
}