docs/servers/elicitation.mdx (3)

283-295: Clarify that defaults are Pydantic-specific; address the dataclass/TypedDict gap.

Line 256 indicates that dataclasses, TypedDicts, and Pydantic models all work for structured responses, but your defaults section only demonstrates Pydantic's Field(default=...). This leaves users uncertain whether defaults are supported for dataclasses (via field(default=...)) or TypedDict.

Since the PR objectives emphasize documenting automatic support through Pydantic, consider either:

1. Explicitly note that defaults via Field(default=...) are Pydantic-specific, or
2. Show equivalent patterns for dataclasses if they're also supported

Add a sentence after line 294 to clarify scope:

Fields with default values are automatically marked as optional (not included in the `required` list), so users can accept the default or provide their own value.
+
+**Note:** Default values via `Field(default=...)` are supported specifically for Pydantic models. If using dataclasses or TypedDicts, use `field(default=...)` or equivalent patterns.

---

296-316: Add a comment explaining Field() vs. simple assignment in Pydantic.

Your code example correctly uses Field(default=..., description=...) but new users may wonder why you're not using simple assignment like priority: Priority = Priority.MEDIUM. Clarify that Field() is used when you need to attach metadata (like description for the form label) along with the default value.

Add an explanatory comment to the model definition:

class TaskDetails(BaseModel):
    title: str = Field(description="Task title")
    description: str = Field(default="", description="Task description")
+  # Field() allows us to attach metadata like 'description' alongside the default value
    priority: Priority = Field(default=Priority.MEDIUM, description="Task priority")

Alternatively, add a note after the code block explaining this distinction.

---

315-317: Add expected behavior and next steps to complete the section.

The section ends without explaining the expected user experience: how clients display these defaults, what happens if a user modifies a default value, or where to go next. Per coding guidelines, sections should end with next steps or related information.

Add context after the code example (after line 316):

When you provide a default value, the client will pre-populate the form field with that value. Users can either accept the default and submit, or modify it to provide their own input. This reduces friction for common scenarios.

**Next:** Learn about gathering information progressively with [Multi-Turn Elicitation](#multi-turn-elicitation).

This gives users clarity on behavior and guides them to the next relevant section.

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro