Skip to content

Commit b2c8368

Browse files
committed
Hide AgentNotification from docs
1 parent 7c0bbd2 commit b2c8368

3 files changed

Lines changed: 3 additions & 40 deletions

File tree

docs/protocol/schema.mdx

Lines changed: 0 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -941,45 +941,6 @@ See protocol docs: [Agent Capabilities](https://agentclientprotocol.com/protocol
941941

942942
</ResponseField>
943943

944-
## <span class="font-mono">AgentNotification</span>
945-
946-
All possible notifications that an agent can send to a client.
947-
948-
This enum is used internally for routing RPC notifications. You typically won't need
949-
to use this directly - use the notification methods on the `Client` trait instead.
950-
951-
Notifications do not expect a response.
952-
953-
**Type:** Union
954-
955-
<ResponseField name="SessionNotification">
956-
{""}
957-
958-
<Expandable title="Properties">
959-
960-
<ResponseField name="_meta" type={"object"}>
961-
Extension point for implementations
962-
</ResponseField>
963-
<ResponseField
964-
name="sessionId"
965-
type={<a href="#sessionid">SessionId</a>}
966-
required
967-
>
968-
The ID of the session this update pertains to.
969-
</ResponseField>
970-
<ResponseField
971-
name="update"
972-
type={<a href="#sessionupdate">SessionUpdate</a>}
973-
required
974-
>
975-
The actual update content.
976-
</ResponseField>
977-
978-
</Expandable>
979-
</ResponseField>
980-
981-
<ResponseField name="Variant">{""}</ResponseField>
982-
983944
## <span class="font-mono">Annotations</span>
984945

985946
Optional annotations for the client. The client can use annotations to inform how objects are used or displayed

rust/client.rs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -746,6 +746,7 @@ pub enum ClientResponse {
746746
#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
747747
#[serde(untagged)]
748748
#[allow(clippy::large_enum_variant)]
749+
#[schemars(extend("x-docs-ignore" = true))]
749750
pub enum AgentNotification {
750751
SessionNotification(SessionNotification),
751752
ExtNotification(ExtMethod),

schema/schema.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,8 @@
4141
"title": "ExtNotification"
4242
}
4343
],
44-
"description": "All possible notifications that an agent can send to a client.\n\nThis enum is used internally for routing RPC notifications. You typically won't need\nto use this directly - use the notification methods on the [`Client`] trait instead.\n\nNotifications do not expect a response."
44+
"description": "All possible notifications that an agent can send to a client.\n\nThis enum is used internally for routing RPC notifications. You typically won't need\nto use this directly - use the notification methods on the [`Client`] trait instead.\n\nNotifications do not expect a response.",
45+
"x-docs-ignore": true
4546
},
4647
"AgentRequest": {
4748
"anyOf": [

0 commit comments

Comments
 (0)