docs: Clean up missing documentation on various schemas and builder (#1454)

methods

Author: benbrandt

Cargo.toml

@@ -77,7 +77,7 @@ tracing = { version = "0.1", default-features = false, optional = true }
 future_incompatible = { level = "warn", priority = -1 }
 let-underscore = "warn"
 missing_debug_implementations = "warn"
-# missing_docs = "warn"
+missing_docs = "warn"
 nonstandard_style = { level = "warn", priority = -1 }
 rust_2018_idioms = { level = "warn", priority = -1 }
 unused = { level = "warn", priority = -1 }

docs/protocol/v1/draft/schema.mdx

@@ -46,7 +46,7 @@ these keys.
 See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/extensibility)
 
 </ResponseField>
-<ResponseField name="methodId" type={"string"} required>
+<ResponseField name="methodId" type={<a href="#authmethodid">AuthMethodId</a>} required>
   The ID of the authentication method to use.
 Must be one of the methods advertised in the initialize response.
 </ResponseField>
@@ -1017,10 +1017,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="audience" type={<><span><a href="#role">Role[]</a></span><span> | null</span></>} >
+  Intended recipients for this content, such as the user or assistant.
 </ResponseField>
 <ResponseField name="lastModified" type={"string | null"} >
+  Timestamp indicating when the underlying resource was last modified.
 </ResponseField>
 <ResponseField name="priority" type={"number | null"} >
+  Relative importance of this content when clients choose what to surface.
 </ResponseField>
 
 ## <span class="font-mono">AudioContent</span>
@@ -1040,10 +1043,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="data" type={"string"} required>
+  Base64-encoded media payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string"} required>
+  MIME type describing the encoded media payload.
 </ResponseField>
 
 ## <span class="font-mono">AuthMethod</span>
@@ -1072,7 +1078,7 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 <ResponseField name="description" type={"string | null"} >
   Optional description providing more details about this authentication method.
 </ResponseField>
-<ResponseField name="id" type={"string"} required>
+<ResponseField name="id" type={<a href="#authmethodid">AuthMethodId</a>} required>
   Unique identifier for this authentication method.
 </ResponseField>
 <ResponseField name="name" type={"string"} required>
@@ -1109,7 +1115,7 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 <ResponseField name="description" type={"string | null"} >
   Optional description providing more details about this authentication method.
 </ResponseField>
-<ResponseField name="id" type={"string"} required>
+<ResponseField name="id" type={<a href="#authmethodid">AuthMethodId</a>} required>
   Unique identifier for this authentication method.
 </ResponseField>
 <ResponseField name="name" type={"string"} required>
@@ -1148,13 +1154,19 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 <ResponseField name="description" type={"string | null"} >
   Optional description providing more details about this authentication method.
 </ResponseField>
-<ResponseField name="id" type={"string"} required>
+<ResponseField name="id" type={<a href="#authmethodid">AuthMethodId</a>} required>
   Unique identifier for this authentication method.
 </ResponseField>
 <ResponseField name="name" type={"string"} required>
   Human-readable name of the authentication method.
 </ResponseField>
 
+## <span class="font-mono">AuthMethodId</span>
+
+Typed identifier used for auth method values on the wire.
+
+**Type:** `string`
+
 ## <span class="font-mono">AvailableCommand</span>
 
 Information about a command.
@@ -1270,10 +1282,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="blob" type={"string"} required>
+  Base64-encoded bytes for a binary resource payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 ## <span class="font-mono">ClientCapabilities</span>
@@ -1376,8 +1391,10 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="text" type={"string"} required>
+  Text payload carried by this content block.
 </ResponseField>
 <ResponseField name="type" type={"string"} required>
   The discriminator value. Must be `"text"`.
@@ -1402,15 +1419,19 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="data" type={"string"} required>
+  Base64-encoded media payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string"} required>
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="type" type={"string"} required>
   The discriminator value. Must be `"image"`.
 </ResponseField>
 <ResponseField name="uri" type={"string | null"} >
+  URI associated with this resource or media payload.
 </ResponseField>
 
 </Expandable>
@@ -1432,10 +1453,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="data" type={"string"} required>
+  Base64-encoded media payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string"} required>
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="type" type={"string"} required>
   The discriminator value. Must be `"audio"`.
@@ -1460,21 +1484,28 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="description" type={"string | null"} >
+  Optional human-readable details shown with this protocol object.
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="name" type={"string"} required>
+  Human-readable name shown for this protocol object.
 </ResponseField>
 <ResponseField name="size" type={"integer | null"} >
+  Optional size of the linked resource in bytes, if known.
 </ResponseField>
 <ResponseField name="title" type={"string | null"} >
+  Optional display title for end-user UI.
 </ResponseField>
 <ResponseField name="type" type={"string"} required>
   The discriminator value. Must be `"resource_link"`.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 </Expandable>
@@ -1498,8 +1529,10 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="resource" type={<a href="#embeddedresourceresource">EmbeddedResourceResource</a>} required>
+  Embedded resource payload, either text or binary data.
 </ResponseField>
 <ResponseField name="type" type={"string"} required>
   The discriminator value. Must be `"resource"`.
@@ -1630,8 +1663,10 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="resource" type={<a href="#embeddedresourceresource">EmbeddedResourceResource</a>} required>
+  Embedded resource payload, either text or binary data.
 </ResponseField>
 
 ## <span class="font-mono">EmbeddedResourceResource</span>
@@ -1641,7 +1676,7 @@ Resource content that can be embedded in a message.
 **Type:** Union
 
 <ResponseField name="TextResourceContents">
-{""}
+Text resource contents embedded directly in the message.
 
 <Expandable title="Properties">
 
@@ -1654,17 +1689,20 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="text" type={"string"} required>
+  Text payload carried by this content block.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 </Expandable>
 </ResponseField>
 
 <ResponseField name="BlobResourceContents">
-{""}
+Binary resource contents embedded directly in the message.
 
 <Expandable title="Properties">
 
@@ -1677,10 +1715,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="blob" type={"string"} required>
+  Base64-encoded bytes for a binary resource payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 </Expandable>
@@ -1868,12 +1909,16 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="data" type={"string"} required>
+  Base64-encoded media payload.
 </ResponseField>
 <ResponseField name="mimeType" type={"string"} required>
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="uri" type={"string | null"} >
+  URI associated with this resource or media payload.
 </ResponseField>
 
 ## <span class="font-mono">Implementation</span>
@@ -2572,15 +2617,15 @@ The Server MUST reply with the same value in the Response object if included. Th
 **Type:** Union
 
 <ResponseField name="null" type="null">
-  {""}
+  The JSON-RPC `null` request id.
 </ResponseField>
 
 <ResponseField name="Number" type="int64">
-  {""}
+  A numeric JSON-RPC request id.
 </ResponseField>
 
 <ResponseField name="Str" type="string">
-  {""}
+  A string JSON-RPC request id.
 </ResponseField>
 
 ## <span class="font-mono">RequestPermissionOutcome</span>
@@ -2664,18 +2709,25 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="description" type={"string | null"} >
+  Optional human-readable details shown with this protocol object.
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="name" type={"string"} required>
+  Human-readable name shown for this protocol object.
 </ResponseField>
 <ResponseField name="size" type={"integer | null"} >
+  Optional size of the linked resource in bytes, if known.
 </ResponseField>
 <ResponseField name="title" type={"string | null"} >
+  Optional display title for end-user UI.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 ## <span class="font-mono">Role</span>
@@ -2684,8 +2736,12 @@ The sender or recipient of messages and data in a conversation.
 
 **Type:** Union
 
-<ResponseField name="assistant | user" type="enum">
-  **Values:** `"assistant"`, `"user"`
+<ResponseField name="assistant" type="string">
+  The assistant side of a conversation.
+</ResponseField>
+
+<ResponseField name="user" type="string">
+  The user side of a conversation.
 </ResponseField>
 
 <ResponseField name="other" type="string">
@@ -3817,8 +3873,10 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="annotations" type={<><span><a href="#annotations">Annotations</a></span><span> | null</span></>} >
+  Optional annotations that help clients decide how to display or route this content.
 </ResponseField>
 <ResponseField name="text" type={"string"} required>
+  Text payload carried by this content block.
 </ResponseField>
 
 ## <span class="font-mono">TextResourceContents</span>
@@ -3838,10 +3896,13 @@ See protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/v2/e
 
 </ResponseField>
 <ResponseField name="mimeType" type={"string | null"} >
+  MIME type describing the encoded media payload.
 </ResponseField>
 <ResponseField name="text" type={"string"} required>
+  Text payload carried by this content block.
 </ResponseField>
 <ResponseField name="uri" type={"string"} required>
+  URI associated with this resource or media payload.
 </ResponseField>
 
 ## <span class="font-mono">ToolCallContent</span>

docs/protocol/v1/schema.mdx

@@ -1,3 +1,5 @@
+//! Generates ACP JSON Schema and schema documentation artifacts.
+
 use agent_client_protocol_schema::ProtocolVersion;
 #[cfg(feature = "unstable_protocol_v2")]
 use agent_client_protocol_schema::v2::{