-
Notifications
You must be signed in to change notification settings - Fork 187
Expand file tree
/
Copy pathschema.json
More file actions
3441 lines (3441 loc) · 138 KB
/
schema.json
File metadata and controls
3441 lines (3441 loc) · 138 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"$defs": {
"AgentCapabilities": {
"description": "Capabilities supported by the agent.\n\nAdvertised during initialization to inform the client about\navailable features and content types.\n\nSee protocol docs: [Agent Capabilities](https://agentclientprotocol.com/protocol/initialization#agent-capabilities)",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"loadSession": {
"default": false,
"description": "Whether the agent supports `session/load`.",
"type": "boolean"
},
"mcpCapabilities": {
"allOf": [
{
"$ref": "#/$defs/McpCapabilities"
}
],
"default": {
"http": false,
"sse": false
},
"description": "MCP capabilities supported by the agent."
},
"promptCapabilities": {
"allOf": [
{
"$ref": "#/$defs/PromptCapabilities"
}
],
"default": {
"audio": false,
"embeddedContext": false,
"image": false
},
"description": "Prompt capabilities supported by the agent."
},
"sessionCapabilities": {
"allOf": [
{
"$ref": "#/$defs/SessionCapabilities"
}
],
"default": {}
}
},
"type": "object"
},
"AgentNotification": {
"properties": {
"method": {
"type": "string"
},
"params": {
"anyOf": [
{
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/SessionNotification"
}
],
"description": "Handles session update notifications from the agent.\n\nThis is a notification endpoint (no response expected) that receives\nreal-time updates about session progress, including message chunks,\ntool calls, and execution plans.\n\nNote: Clients SHOULD continue accepting tool call updates even after\nsending a `session/cancel` notification, as the agent may send final\nupdates before responding with the cancelled stop reason.\n\nSee protocol docs: [Agent Reports Output](https://agentclientprotocol.com/protocol/prompt-turn#3-agent-reports-output)",
"title": "SessionNotification"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtNotification"
}
],
"description": "Handles extension notifications from the agent.\n\nAllows the Agent to send an arbitrary notification that is not part of the ACP spec.\nExtension notifications provide a way to send one-way messages for custom functionality\nwhile maintaining protocol compatibility.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"title": "ExtNotification"
}
],
"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."
},
{
"type": "null"
}
]
}
},
"required": ["method"],
"type": "object",
"x-docs-ignore": true
},
"AgentRequest": {
"properties": {
"id": {
"$ref": "#/$defs/RequestId"
},
"method": {
"type": "string"
},
"params": {
"anyOf": [
{
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/WriteTextFileRequest"
}
],
"description": "Writes content to a text file in the client's file system.\n\nOnly available if the client advertises the `fs.writeTextFile` capability.\nAllows the agent to create or modify files within the client's environment.\n\nSee protocol docs: [Client](https://agentclientprotocol.com/protocol/overview#client)",
"title": "WriteTextFileRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/ReadTextFileRequest"
}
],
"description": "Reads content from a text file in the client's file system.\n\nOnly available if the client advertises the `fs.readTextFile` capability.\nAllows the agent to access file contents within the client's environment.\n\nSee protocol docs: [Client](https://agentclientprotocol.com/protocol/overview#client)",
"title": "ReadTextFileRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/RequestPermissionRequest"
}
],
"description": "Requests permission from the user for a tool call operation.\n\nCalled by the agent when it needs user authorization before executing\na potentially sensitive operation. The client should present the options\nto the user and return their decision.\n\nIf the client cancels the prompt turn via `session/cancel`, it MUST\nrespond to this request with `RequestPermissionOutcome::Cancelled`.\n\nSee protocol docs: [Requesting Permission](https://agentclientprotocol.com/protocol/tool-calls#requesting-permission)",
"title": "RequestPermissionRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/CreateTerminalRequest"
}
],
"description": "Executes a command in a new terminal\n\nOnly available if the `terminal` Client capability is set to `true`.\n\nReturns a `TerminalId` that can be used with other terminal methods\nto get the current output, wait for exit, and kill the command.\n\nThe `TerminalId` can also be used to embed the terminal in a tool call\nby using the `ToolCallContent::Terminal` variant.\n\nThe Agent is responsible for releasing the terminal by using the `terminal/release`\nmethod.\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
"title": "CreateTerminalRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/TerminalOutputRequest"
}
],
"description": "Gets the terminal output and exit status\n\nReturns the current content in the terminal without waiting for the command to exit.\nIf the command has already exited, the exit status is included.\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
"title": "TerminalOutputRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/ReleaseTerminalRequest"
}
],
"description": "Releases a terminal\n\nThe command is killed if it hasn't exited yet. Use `terminal/wait_for_exit`\nto wait for the command to exit before releasing the terminal.\n\nAfter release, the `TerminalId` can no longer be used with other `terminal/*` methods,\nbut tool calls that already contain it, continue to display its output.\n\nThe `terminal/kill` method can be used to terminate the command without releasing\nthe terminal, allowing the Agent to call `terminal/output` and other methods.\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
"title": "ReleaseTerminalRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/WaitForTerminalExitRequest"
}
],
"description": "Waits for the terminal command to exit and return its exit status\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
"title": "WaitForTerminalExitRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/KillTerminalCommandRequest"
}
],
"description": "Kills the terminal command without releasing the terminal\n\nWhile `terminal/release` will also kill the command, this method will keep\nthe `TerminalId` valid so it can be used with other methods.\n\nThis method can be helpful when implementing command timeouts which terminate\nthe command as soon as elapsed, and then get the final output so it can be sent\nto the model.\n\nNote: `terminal/release` when `TerminalId` is no longer needed.\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
"title": "KillTerminalCommandRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtRequest"
}
],
"description": "Handles extension method requests from the agent.\n\nAllows the Agent to send an arbitrary request that is not part of the ACP spec.\nExtension methods provide a way to add custom functionality while maintaining\nprotocol compatibility.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"title": "ExtMethodRequest"
}
],
"description": "All possible requests that an agent can send to a client.\n\nThis enum is used internally for routing RPC requests. You typically won't need\nto use this directly - instead, use the methods on the [`Client`] trait.\n\nThis enum encompasses all method calls from agent to client."
},
{
"type": "null"
}
]
}
},
"required": ["id", "method"],
"type": "object",
"x-docs-ignore": true
},
"AgentResponse": {
"anyOf": [
{
"properties": {
"id": {
"$ref": "#/$defs/RequestId"
},
"result": {
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/InitializeResponse"
}
],
"title": "InitializeResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/AuthenticateResponse"
}
],
"title": "AuthenticateResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/NewSessionResponse"
}
],
"title": "NewSessionResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/LoadSessionResponse"
}
],
"title": "LoadSessionResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/SetSessionModeResponse"
}
],
"title": "SetSessionModeResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/SetSessionConfigOptionResponse"
}
],
"title": "SetSessionConfigOptionResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/PromptResponse"
}
],
"title": "PromptResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtResponse"
}
],
"title": "ExtMethodResponse"
}
],
"description": "All possible responses that an agent can send to a client.\n\nThis enum is used internally for routing RPC responses. You typically won't need\nto use this directly - the responses are handled automatically by the connection.\n\nThese are responses to the corresponding `ClientRequest` variants."
}
},
"required": ["id", "result"],
"title": "Result",
"type": "object"
},
{
"properties": {
"error": {
"$ref": "#/$defs/Error"
},
"id": {
"$ref": "#/$defs/RequestId"
}
},
"required": ["id", "error"],
"title": "Error",
"type": "object"
}
],
"x-docs-ignore": true
},
"Annotations": {
"description": "Optional annotations for the client. The client can use annotations to inform how objects are used or displayed",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"audience": {
"items": {
"$ref": "#/$defs/Role"
},
"type": ["array", "null"]
},
"lastModified": {
"type": ["string", "null"]
},
"priority": {
"format": "double",
"type": ["number", "null"]
}
},
"type": "object"
},
"AudioContent": {
"description": "Audio provided to or from an LLM.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"data": {
"type": "string"
},
"mimeType": {
"type": "string"
}
},
"required": ["data", "mimeType"],
"type": "object"
},
"AuthMethod": {
"description": "Describes an available authentication method.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"description": {
"description": "Optional description providing more details about this authentication method.",
"type": ["string", "null"]
},
"id": {
"description": "Unique identifier for this authentication method.",
"type": "string"
},
"name": {
"description": "Human-readable name of the authentication method.",
"type": "string"
}
},
"required": ["id", "name"],
"type": "object"
},
"AuthenticateRequest": {
"description": "Request parameters for the authenticate method.\n\nSpecifies which authentication method to use.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"methodId": {
"description": "The ID of the authentication method to use.\nMust be one of the methods advertised in the initialize response.",
"type": "string"
}
},
"required": ["methodId"],
"type": "object",
"x-method": "authenticate",
"x-side": "agent"
},
"AuthenticateResponse": {
"description": "Response to the `authenticate` method.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
}
},
"type": "object",
"x-method": "authenticate",
"x-side": "agent"
},
"AvailableCommand": {
"description": "Information about a command.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"description": {
"description": "Human-readable description of what the command does.",
"type": "string"
},
"input": {
"anyOf": [
{
"$ref": "#/$defs/AvailableCommandInput"
},
{
"type": "null"
}
],
"description": "Input for the command if required"
},
"name": {
"description": "Command name (e.g., `create_plan`, `research_codebase`).",
"type": "string"
}
},
"required": ["name", "description"],
"type": "object"
},
"AvailableCommandInput": {
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/UnstructuredCommandInput"
}
],
"description": "All text that was typed after the command name is provided as input.",
"title": "unstructured"
}
],
"description": "The input specification for a command."
},
"AvailableCommandsUpdate": {
"description": "Available commands are ready or have changed",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"availableCommands": {
"description": "Commands the agent can execute",
"items": {
"$ref": "#/$defs/AvailableCommand"
},
"type": "array"
}
},
"required": ["availableCommands"],
"type": "object"
},
"BlobResourceContents": {
"description": "Binary resource contents.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"blob": {
"type": "string"
},
"mimeType": {
"type": ["string", "null"]
},
"uri": {
"type": "string"
}
},
"required": ["blob", "uri"],
"type": "object"
},
"CancelNotification": {
"description": "Notification to cancel ongoing operations for a session.\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/prompt-turn#cancellation)",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"sessionId": {
"allOf": [
{
"$ref": "#/$defs/SessionId"
}
],
"description": "The ID of the session to cancel operations for."
}
},
"required": ["sessionId"],
"type": "object",
"x-method": "session/cancel",
"x-side": "agent"
},
"ClientCapabilities": {
"description": "Capabilities supported by the client.\n\nAdvertised during initialization to inform the agent about\navailable features and methods.\n\nSee protocol docs: [Client Capabilities](https://agentclientprotocol.com/protocol/initialization#client-capabilities)",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"fs": {
"allOf": [
{
"$ref": "#/$defs/FileSystemCapability"
}
],
"default": {
"readTextFile": false,
"writeTextFile": false
},
"description": "File system capabilities supported by the client.\nDetermines which file operations the agent can request."
},
"terminal": {
"default": false,
"description": "Whether the Client support all `terminal/*` methods.",
"type": "boolean"
}
},
"type": "object"
},
"ClientNotification": {
"properties": {
"method": {
"type": "string"
},
"params": {
"anyOf": [
{
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/CancelNotification"
}
],
"description": "Cancels ongoing operations for a session.\n\nThis is a notification sent by the client to cancel an ongoing prompt turn.\n\nUpon receiving this notification, the Agent SHOULD:\n- Stop all language model requests as soon as possible\n- Abort all tool call invocations in progress\n- Send any pending `session/update` notifications\n- Respond to the original `session/prompt` request with `StopReason::Cancelled`\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/prompt-turn#cancellation)",
"title": "CancelNotification"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtNotification"
}
],
"description": "Handles extension notifications from the client.\n\nExtension notifications provide a way to send one-way messages for custom functionality\nwhile maintaining protocol compatibility.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"title": "ExtNotification"
}
],
"description": "All possible notifications that a client can send to an agent.\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 [`Agent`] trait instead.\n\nNotifications do not expect a response."
},
{
"type": "null"
}
]
}
},
"required": ["method"],
"type": "object",
"x-docs-ignore": true
},
"ClientRequest": {
"properties": {
"id": {
"$ref": "#/$defs/RequestId"
},
"method": {
"type": "string"
},
"params": {
"anyOf": [
{
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/InitializeRequest"
}
],
"description": "Establishes the connection with a client and negotiates protocol capabilities.\n\nThis method is called once at the beginning of the connection to:\n- Negotiate the protocol version to use\n- Exchange capability information between client and agent\n- Determine available authentication methods\n\nThe agent should respond with its supported protocol version and capabilities.\n\nSee protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)",
"title": "InitializeRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/AuthenticateRequest"
}
],
"description": "Authenticates the client using the specified authentication method.\n\nCalled when the agent requires authentication before allowing session creation.\nThe client provides the authentication method ID that was advertised during initialization.\n\nAfter successful authentication, the client can proceed to create sessions with\n`new_session` without receiving an `auth_required` error.\n\nSee protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)",
"title": "AuthenticateRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/NewSessionRequest"
}
],
"description": "Creates a new conversation session with the agent.\n\nSessions represent independent conversation contexts with their own history and state.\n\nThe agent should:\n- Create a new session context\n- Connect to any specified MCP servers\n- Return a unique session ID for future requests\n\nMay return an `auth_required` error if the agent requires authentication.\n\nSee protocol docs: [Session Setup](https://agentclientprotocol.com/protocol/session-setup)",
"title": "NewSessionRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/LoadSessionRequest"
}
],
"description": "Loads an existing session to resume a previous conversation.\n\nThis method is only available if the agent advertises the `loadSession` capability.\n\nThe agent should:\n- Restore the session context and conversation history\n- Connect to the specified MCP servers\n- Stream the entire conversation history back to the client via notifications\n\nSee protocol docs: [Loading Sessions](https://agentclientprotocol.com/protocol/session-setup#loading-sessions)",
"title": "LoadSessionRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/SetSessionModeRequest"
}
],
"description": "Sets the current mode for a session.\n\nAllows switching between different agent modes (e.g., \"ask\", \"architect\", \"code\")\nthat affect system prompts, tool availability, and permission behaviors.\n\nThe mode must be one of the modes advertised in `availableModes` during session\ncreation or loading. Agents may also change modes autonomously and notify the\nclient via `current_mode_update` notifications.\n\nThis method can be called at any time during a session, whether the Agent is\nidle or actively generating a response.\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)",
"title": "SetSessionModeRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/SetSessionConfigOptionRequest"
}
],
"description": "Sets the current value for a session configuration option.",
"title": "SetSessionConfigOptionRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/PromptRequest"
}
],
"description": "Processes a user prompt within a session.\n\nThis method handles the whole lifecycle of a prompt:\n- Receives user messages with optional context (files, images, etc.)\n- Processes the prompt using language models\n- Reports language model content and tool calls to the Clients\n- Requests permission to run tools\n- Executes any requested tool calls\n- Returns when the turn is complete with a stop reason\n\nSee protocol docs: [Prompt Turn](https://agentclientprotocol.com/protocol/prompt-turn)",
"title": "PromptRequest"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtRequest"
}
],
"description": "Handles extension method requests from the client.\n\nExtension methods provide a way to add custom functionality while maintaining\nprotocol compatibility.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"title": "ExtMethodRequest"
}
],
"description": "All possible requests that a client can send to an agent.\n\nThis enum is used internally for routing RPC requests. You typically won't need\nto use this directly - instead, use the methods on the [`Agent`] trait.\n\nThis enum encompasses all method calls from client to agent."
},
{
"type": "null"
}
]
}
},
"required": ["id", "method"],
"type": "object",
"x-docs-ignore": true
},
"ClientResponse": {
"anyOf": [
{
"properties": {
"id": {
"$ref": "#/$defs/RequestId"
},
"result": {
"anyOf": [
{
"allOf": [
{
"$ref": "#/$defs/WriteTextFileResponse"
}
],
"title": "WriteTextFileResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/ReadTextFileResponse"
}
],
"title": "ReadTextFileResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/RequestPermissionResponse"
}
],
"title": "RequestPermissionResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/CreateTerminalResponse"
}
],
"title": "CreateTerminalResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/TerminalOutputResponse"
}
],
"title": "TerminalOutputResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/ReleaseTerminalResponse"
}
],
"title": "ReleaseTerminalResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/WaitForTerminalExitResponse"
}
],
"title": "WaitForTerminalExitResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/KillTerminalCommandResponse"
}
],
"title": "KillTerminalResponse"
},
{
"allOf": [
{
"$ref": "#/$defs/ExtResponse"
}
],
"title": "ExtMethodResponse"
}
],
"description": "All possible responses that a client can send to an agent.\n\nThis enum is used internally for routing RPC responses. You typically won't need\nto use this directly - the responses are handled automatically by the connection.\n\nThese are responses to the corresponding `AgentRequest` variants."
}
},
"required": ["id", "result"],
"title": "Result",
"type": "object"
},
{
"properties": {
"error": {
"$ref": "#/$defs/Error"
},
"id": {
"$ref": "#/$defs/RequestId"
}
},
"required": ["id", "error"],
"title": "Error",
"type": "object"
}
],
"x-docs-ignore": true
},
"ConfigOptionUpdate": {
"description": "Session configuration options have been updated.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"configOptions": {
"description": "The full set of configuration options and their current values.",
"items": {
"$ref": "#/$defs/SessionConfigOption"
},
"type": "array"
}
},
"required": ["configOptions"],
"type": "object"
},
"Content": {
"description": "Standard content block (text, images, resources).",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"content": {
"allOf": [
{
"$ref": "#/$defs/ContentBlock"
}
],
"description": "The actual content block."
}
},
"required": ["content"],
"type": "object"
},
"ContentBlock": {
"description": "Content blocks represent displayable information in the Agent Client Protocol.\n\nThey provide a structured way to handle various types of user-facing content—whether\nit's text from language models, images for analysis, or embedded resources for context.\n\nContent blocks appear in:\n- User prompts sent via `session/prompt`\n- Language model output streamed through `session/update` notifications\n- Progress updates and results from tool calls\n\nThis structure is compatible with the Model Context Protocol (MCP), enabling\nagents to seamlessly forward content from MCP tool outputs without transformation.\n\nSee protocol docs: [Content](https://agentclientprotocol.com/protocol/content)",
"discriminator": {
"propertyName": "type"
},
"oneOf": [
{
"allOf": [
{
"$ref": "#/$defs/TextContent"
}
],
"description": "Text content. May be plain text or formatted with Markdown.\n\nAll agents MUST support text content blocks in prompts.\nClients SHOULD render this text as Markdown.",
"properties": {
"type": {
"const": "text",
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
{
"allOf": [
{
"$ref": "#/$defs/ImageContent"
}
],
"description": "Images for visual context or analysis.\n\nRequires the `image` prompt capability when included in prompts.",
"properties": {
"type": {
"const": "image",
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
{
"allOf": [
{
"$ref": "#/$defs/AudioContent"
}
],
"description": "Audio data for transcription or analysis.\n\nRequires the `audio` prompt capability when included in prompts.",
"properties": {
"type": {
"const": "audio",
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
{
"allOf": [
{
"$ref": "#/$defs/ResourceLink"
}
],
"description": "References to resources that the agent can access.\n\nAll agents MUST support resource links in prompts.",
"properties": {
"type": {
"const": "resource_link",
"type": "string"
}
},
"required": ["type"],
"type": "object"
},
{
"allOf": [
{
"$ref": "#/$defs/EmbeddedResource"
}
],
"description": "Complete resource contents embedded directly in the message.\n\nPreferred for including context as it avoids extra round-trips.\n\nRequires the `embeddedContext` prompt capability when included in prompts.",
"properties": {
"type": {
"const": "resource",
"type": "string"
}
},
"required": ["type"],
"type": "object"
}
]
},
"ContentChunk": {
"description": "A streamed item of content",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"content": {
"allOf": [
{
"$ref": "#/$defs/ContentBlock"
}
],
"description": "A single item of content"
}
},
"required": ["content"],
"type": "object"
},
"CreateTerminalRequest": {
"description": "Request to create a new terminal and execute a command.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"args": {
"description": "Array of command arguments.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "The command to execute.",
"type": "string"
},
"cwd": {
"description": "Working directory for the command (absolute path).",
"type": ["string", "null"]
},
"env": {
"description": "Environment variables for the command.",
"items": {
"$ref": "#/$defs/EnvVariable"
},
"type": "array"
},
"outputByteLimit": {
"description": "Maximum number of output bytes to retain.\n\nWhen the limit is exceeded, the Client truncates from the beginning of the output\nto stay within the limit.\n\nThe Client MUST ensure truncation happens at a character boundary to maintain valid\nstring output, even if this means the retained output is slightly less than the\nspecified limit.",
"format": "uint64",
"minimum": 0,
"type": ["integer", "null"]
},
"sessionId": {
"allOf": [
{
"$ref": "#/$defs/SessionId"
}
],
"description": "The session ID for this request."
}
},
"required": ["sessionId", "command"],
"type": "object",
"x-method": "terminal/create",
"x-side": "client"
},
"CreateTerminalResponse": {
"description": "Response containing the ID of the created terminal.",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]
},
"terminalId": {
"description": "The unique identifier for the created terminal.",
"type": "string"
}
},
"required": ["terminalId"],
"type": "object",
"x-method": "terminal/create",
"x-side": "client"
},
"CurrentModeUpdate": {
"description": "The current mode of the session has changed\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)",
"properties": {
"_meta": {
"additionalProperties": true,
"description": "The _meta property is reserved by ACP to allow clients and agents to attach additional\nmetadata to their interactions. Implementations MUST NOT make assumptions about values at\nthese keys.\n\nSee protocol docs: [Extensibility](https://agentclientprotocol.com/protocol/extensibility)",
"type": ["object", "null"]