-
Notifications
You must be signed in to change notification settings - Fork 229
Expand file tree
/
Copy pathschema.json
More file actions
1777 lines (1777 loc) · 59.8 KB
/
schema.json
File metadata and controls
1777 lines (1777 loc) · 59.8 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": {
"loadSession": {
"default": false,
"description": "Whether the agent supports `session/load`.",
"type": "boolean"
},
"promptCapabilities": {
"$ref": "#/$defs/PromptCapabilities",
"default": {
"audio": false,
"embeddedContext": false,
"image": false
},
"description": "Prompt capabilities supported by the agent."
}
},
"type": "object"
},
"AgentNotification": {
"anyOf": [
{
"$ref": "#/$defs/SessionNotification",
"title": "SessionNotification"
}
],
"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.",
"x-docs-ignore": true
},
"AgentRequest": {
"anyOf": [
{
"$ref": "#/$defs/WriteTextFileRequest",
"title": "WriteTextFileRequest"
},
{
"$ref": "#/$defs/ReadTextFileRequest",
"title": "ReadTextFileRequest"
},
{
"$ref": "#/$defs/RequestPermissionRequest",
"title": "RequestPermissionRequest"
},
{
"$ref": "#/$defs/CreateTerminalRequest",
"title": "CreateTerminalRequest"
},
{
"$ref": "#/$defs/TerminalOutputRequest",
"title": "TerminalOutputRequest"
},
{
"$ref": "#/$defs/ReleaseTerminalRequest",
"title": "ReleaseTerminalRequest"
},
{
"$ref": "#/$defs/WaitForTerminalExitRequest",
"title": "WaitForTerminalExitRequest"
},
{
"$ref": "#/$defs/KillTerminalRequest",
"title": "KillTerminalRequest"
}
],
"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.",
"x-docs-ignore": true
},
"AgentResponse": {
"anyOf": [
{
"$ref": "#/$defs/InitializeResponse",
"title": "InitializeResponse"
},
{
"title": "AuthenticateResponse",
"type": "null"
},
{
"$ref": "#/$defs/NewSessionResponse",
"title": "NewSessionResponse"
},
{
"title": "LoadSessionResponse",
"type": "null"
},
{
"$ref": "#/$defs/PromptResponse",
"title": "PromptResponse"
}
],
"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.",
"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": {
"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": {
"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": {
"description": {
"description": "Optional description providing more details about this authentication method.",
"type": ["string", "null"]
},
"id": {
"$ref": "#/$defs/AuthMethodId",
"description": "Unique identifier for this authentication method."
},
"name": {
"description": "Human-readable name of the authentication method.",
"type": "string"
}
},
"required": ["id", "name"],
"type": "object"
},
"AuthMethodId": {
"description": "Unique identifier for an authentication method.",
"type": "string"
},
"AuthenticateRequest": {
"description": "Request parameters for the authenticate method.\n\nSpecifies which authentication method to use.",
"properties": {
"methodId": {
"$ref": "#/$defs/AuthMethodId",
"description": "The ID of the authentication method to use.\nMust be one of the methods advertised in the initialize response."
}
},
"required": ["methodId"],
"type": "object",
"x-method": "authenticate",
"x-side": "agent"
},
"AvailableCommand": {
"description": "Information about a command.",
"properties": {
"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": [
{
"description": "All text that was typed after the command name is provided as input.",
"properties": {
"hint": {
"description": "A brief description of the expected input",
"type": "string"
}
},
"required": ["hint"],
"title": "UnstructuredCommandInput",
"type": "object"
}
]
},
"BlobResourceContents": {
"description": "Binary resource contents.",
"properties": {
"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": {
"sessionId": {
"$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": {
"fs": {
"$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": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.",
"type": "boolean"
}
},
"type": "object"
},
"ClientNotification": {
"anyOf": [
{
"$ref": "#/$defs/CancelNotification",
"title": "CancelNotification"
}
],
"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.",
"x-docs-ignore": true
},
"ClientRequest": {
"anyOf": [
{
"$ref": "#/$defs/InitializeRequest",
"title": "InitializeRequest"
},
{
"$ref": "#/$defs/AuthenticateRequest",
"title": "AuthenticateRequest"
},
{
"$ref": "#/$defs/NewSessionRequest",
"title": "NewSessionRequest"
},
{
"$ref": "#/$defs/LoadSessionRequest",
"title": "LoadSessionRequest"
},
{
"$ref": "#/$defs/PromptRequest",
"title": "PromptRequest"
}
],
"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.",
"x-docs-ignore": true
},
"ClientResponse": {
"anyOf": [
{
"title": "WriteTextFileResponse",
"type": "null"
},
{
"$ref": "#/$defs/ReadTextFileResponse",
"title": "ReadTextFileResponse"
},
{
"$ref": "#/$defs/RequestPermissionResponse",
"title": "RequestPermissionResponse"
},
{
"$ref": "#/$defs/CreateTerminalResponse",
"title": "CreateTerminalResponse"
},
{
"$ref": "#/$defs/TerminalOutputResponse",
"title": "TerminalOutputResponse"
},
{
"title": "ReleaseTerminalResponse",
"type": "null"
},
{
"$ref": "#/$defs/WaitForTerminalExitResponse",
"title": "WaitForTerminalExitResponse"
},
{
"title": "KillTerminalResponse",
"type": "null"
}
],
"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.",
"x-docs-ignore": true
},
"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)",
"oneOf": [
{
"description": "Plain text content\n\nAll agents MUST support text content blocks in prompts.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"text": {
"type": "string"
},
"type": {
"const": "text",
"type": "string"
}
},
"required": ["type", "text"],
"type": "object"
},
{
"description": "Images for visual context or analysis.\n\nRequires the `image` prompt capability when included in prompts.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"data": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"type": {
"const": "image",
"type": "string"
},
"uri": {
"type": ["string", "null"]
}
},
"required": ["type", "data", "mimeType"],
"type": "object"
},
{
"description": "Audio data for transcription or analysis.\n\nRequires the `audio` prompt capability when included in prompts.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"data": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"type": {
"const": "audio",
"type": "string"
}
},
"required": ["type", "data", "mimeType"],
"type": "object"
},
{
"description": "References to resources that the agent can access.\n\nAll agents MUST support resource links in prompts.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"description": {
"type": ["string", "null"]
},
"mimeType": {
"type": ["string", "null"]
},
"name": {
"type": "string"
},
"size": {
"format": "int64",
"type": ["integer", "null"]
},
"title": {
"type": ["string", "null"]
},
"type": {
"const": "resource_link",
"type": "string"
},
"uri": {
"type": "string"
}
},
"required": ["type", "name", "uri"],
"type": "object"
},
{
"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": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"resource": {
"$ref": "#/$defs/EmbeddedResourceResource"
},
"type": {
"const": "resource",
"type": "string"
}
},
"required": ["type", "resource"],
"type": "object"
}
]
},
"CreateTerminalRequest": {
"properties": {
"args": {
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"type": "string"
},
"cwd": {
"type": ["string", "null"]
},
"env": {
"items": {
"$ref": "#/$defs/EnvVariable"
},
"type": "array"
},
"outputByteLimit": {
"format": "uint64",
"minimum": 0,
"type": ["integer", "null"]
},
"sessionId": {
"$ref": "#/$defs/SessionId"
}
},
"required": ["sessionId", "command"],
"type": "object",
"x-docs-ignore": true
},
"CreateTerminalResponse": {
"properties": {
"terminalId": {
"type": "string"
}
},
"required": ["terminalId"],
"type": "object",
"x-docs-ignore": true
},
"EmbeddedResource": {
"description": "The contents of a resource, embedded into a prompt or tool call result.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"resource": {
"$ref": "#/$defs/EmbeddedResourceResource"
}
},
"required": ["resource"],
"type": "object"
},
"EmbeddedResourceResource": {
"anyOf": [
{
"$ref": "#/$defs/TextResourceContents",
"title": "TextResourceContents"
},
{
"$ref": "#/$defs/BlobResourceContents",
"title": "BlobResourceContents"
}
],
"description": "Resource content that can be embedded in a message."
},
"EnvVariable": {
"description": "An environment variable to set when launching an MCP server.",
"properties": {
"name": {
"description": "The name of the environment variable.",
"type": "string"
},
"value": {
"description": "The value to set for the environment variable.",
"type": "string"
}
},
"required": ["name", "value"],
"type": "object"
},
"FileSystemCapability": {
"description": "File system capabilities that a client may support.\n\nSee protocol docs: [FileSystem](https://agentclientprotocol.com/protocol/initialization#filesystem)",
"properties": {
"readTextFile": {
"default": false,
"description": "Whether the Client supports `fs/read_text_file` requests.",
"type": "boolean"
},
"writeTextFile": {
"default": false,
"description": "Whether the Client supports `fs/write_text_file` requests.",
"type": "boolean"
}
},
"type": "object"
},
"ImageContent": {
"description": "An image provided to or from an LLM.",
"properties": {
"annotations": {
"anyOf": [
{
"$ref": "#/$defs/Annotations"
},
{
"type": "null"
}
]
},
"data": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"uri": {
"type": ["string", "null"]
}
},
"required": ["data", "mimeType"],
"type": "object"
},
"InitializeRequest": {
"description": "Request parameters for the initialize method.\n\nSent by the client to establish connection and negotiate capabilities.\n\nSee protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)",
"properties": {
"clientCapabilities": {
"$ref": "#/$defs/ClientCapabilities",
"default": {
"fs": {
"readTextFile": false,
"writeTextFile": false
},
"terminal": false
},
"description": "Capabilities supported by the client."
},
"protocolVersion": {
"$ref": "#/$defs/ProtocolVersion",
"description": "The latest protocol version supported by the client."
}
},
"required": ["protocolVersion"],
"type": "object",
"x-method": "initialize",
"x-side": "agent"
},
"InitializeResponse": {
"description": "Response from the initialize method.\n\nContains the negotiated protocol version and agent capabilities.\n\nSee protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)",
"properties": {
"agentCapabilities": {
"$ref": "#/$defs/AgentCapabilities",
"default": {
"loadSession": false,
"promptCapabilities": {
"audio": false,
"embeddedContext": false,
"image": false
}
},
"description": "Capabilities supported by the agent."
},
"authMethods": {
"default": [],
"description": "Authentication methods supported by the agent.",
"items": {
"$ref": "#/$defs/AuthMethod"
},
"type": "array"
},
"protocolVersion": {
"$ref": "#/$defs/ProtocolVersion",
"description": "The protocol version the client specified if supported by the agent,\nor the latest protocol version supported by the agent.\n\nThe client should disconnect, if it doesn't support this version."
}
},
"required": ["protocolVersion"],
"type": "object",
"x-method": "initialize",
"x-side": "agent"
},
"KillTerminalRequest": {
"properties": {
"sessionId": {
"$ref": "#/$defs/SessionId"
},
"terminalId": {
"type": "string"
}
},
"required": ["sessionId", "terminalId"],
"type": "object",
"x-docs-ignore": true
},
"LoadSessionRequest": {
"description": "Request parameters for loading an existing session.\n\nOnly available if the agent supports the `loadSession` capability.\n\nSee protocol docs: [Loading Sessions](https://agentclientprotocol.com/protocol/session-setup#loading-sessions)",
"properties": {
"cwd": {
"description": "The working directory for this session.",
"type": "string"
},
"mcpServers": {
"description": "List of MCP servers to connect to for this session.",
"items": {
"$ref": "#/$defs/McpServer"
},
"type": "array"
},
"sessionId": {
"$ref": "#/$defs/SessionId",
"description": "The ID of the session to load."
}
},
"required": ["mcpServers", "cwd", "sessionId"],
"type": "object",
"x-method": "session/load",
"x-side": "agent"
},
"McpServer": {
"description": "Configuration for connecting to an MCP (Model Context Protocol) server.\n\nMCP servers provide tools and context that the agent can use when\nprocessing prompts.\n\nSee protocol docs: [MCP Servers](https://agentclientprotocol.com/protocol/session-setup#mcp-servers)",
"properties": {
"args": {
"description": "Command-line arguments to pass to the MCP server.",
"items": {
"type": "string"
},
"type": "array"
},
"command": {
"description": "Path to the MCP server executable.",
"type": "string"
},
"env": {
"description": "Environment variables to set when launching the MCP server.",
"items": {
"$ref": "#/$defs/EnvVariable"
},
"type": "array"
},
"name": {
"description": "Human-readable name identifying this MCP server.",
"type": "string"
}
},
"required": ["name", "command", "args", "env"],
"type": "object"
},
"NewSessionRequest": {
"description": "Request parameters for creating a new session.\n\nSee protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)",
"properties": {
"cwd": {
"description": "The working directory for this session. Must be an absolute path.",
"type": "string"
},
"mcpServers": {
"description": "List of MCP (Model Context Protocol) servers the agent should connect to.",
"items": {
"$ref": "#/$defs/McpServer"
},
"type": "array"
}
},
"required": ["cwd", "mcpServers"],
"type": "object",
"x-method": "session/new",
"x-side": "agent"
},
"NewSessionResponse": {
"description": "Response from creating a new session.\n\nSee protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)",
"properties": {
"sessionId": {
"$ref": "#/$defs/SessionId",
"description": "Unique identifier for the created session.\n\nUsed in all subsequent requests for this conversation."
}
},
"required": ["sessionId"],
"type": "object",
"x-method": "session/new",
"x-side": "agent"
},
"PermissionOption": {
"description": "An option presented to the user when requesting permission.",
"properties": {
"kind": {
"$ref": "#/$defs/PermissionOptionKind",
"description": "Hint about the nature of this permission option."
},
"name": {
"description": "Human-readable label to display to the user.",
"type": "string"
},
"optionId": {
"$ref": "#/$defs/PermissionOptionId",
"description": "Unique identifier for this permission option."
}
},
"required": ["optionId", "name", "kind"],
"type": "object"
},
"PermissionOptionId": {
"description": "Unique identifier for a permission option.",
"type": "string"
},
"PermissionOptionKind": {
"description": "The type of permission option being presented to the user.\n\nHelps clients choose appropriate icons and UI treatment.",
"oneOf": [
{
"const": "allow_once",
"description": "Allow this operation only this time.",
"type": "string"
},
{
"const": "allow_always",
"description": "Allow this operation and remember the choice.",
"type": "string"
},
{
"const": "reject_once",
"description": "Reject this operation only this time.",
"type": "string"
},
{
"const": "reject_always",
"description": "Reject this operation and remember the choice.",
"type": "string"
}
]
},
"Plan": {
"description": "An execution plan for accomplishing complex tasks.\n\nPlans consist of multiple entries representing individual tasks or goals.\nAgents report plans to clients to provide visibility into their execution strategy.\nPlans can evolve during execution as the agent discovers new requirements or completes tasks.\n\nSee protocol docs: [Agent Plan](https://agentclientprotocol.com/protocol/agent-plan)",
"properties": {
"entries": {
"description": "The list of tasks to be accomplished.\n\nWhen updating a plan, the agent must send a complete list of all entries\nwith their current status. The client replaces the entire plan with each update.",
"items": {
"$ref": "#/$defs/PlanEntry"
},
"type": "array"
}
},
"required": ["entries"],
"type": "object"
},
"PlanEntry": {
"description": "A single entry in the execution plan.\n\nRepresents a task or goal that the assistant intends to accomplish\nas part of fulfilling the user's request.\nSee protocol docs: [Plan Entries](https://agentclientprotocol.com/protocol/agent-plan#plan-entries)",
"properties": {
"content": {
"description": "Human-readable description of what this task aims to accomplish.",
"type": "string"
},
"priority": {
"$ref": "#/$defs/PlanEntryPriority",
"description": "The relative importance of this task.\nUsed to indicate which tasks are most critical to the overall goal."
},
"status": {
"$ref": "#/$defs/PlanEntryStatus",
"description": "Current execution status of this task."
}
},
"required": ["content", "priority", "status"],
"type": "object"
},
"PlanEntryPriority": {
"description": "Priority levels for plan entries.\n\nUsed to indicate the relative importance or urgency of different\ntasks in the execution plan.\nSee protocol docs: [Plan Entries](https://agentclientprotocol.com/protocol/agent-plan#plan-entries)",
"oneOf": [
{
"const": "high",
"description": "High priority task - critical to the overall goal.",
"type": "string"
},
{
"const": "medium",
"description": "Medium priority task - important but not critical.",
"type": "string"
},
{
"const": "low",
"description": "Low priority task - nice to have but not essential.",
"type": "string"
}
]
},
"PlanEntryStatus": {
"description": "Status of a plan entry in the execution flow.\n\nTracks the lifecycle of each task from planning through completion.\nSee protocol docs: [Plan Entries](https://agentclientprotocol.com/protocol/agent-plan#plan-entries)",
"oneOf": [
{
"const": "pending",
"description": "The task has not started yet.",
"type": "string"
},
{
"const": "in_progress",
"description": "The task is currently being worked on.",
"type": "string"
},
{
"const": "completed",
"description": "The task has been successfully completed.",
"type": "string"
}
]
},
"PromptCapabilities": {
"description": "Prompt capabilities supported by the agent in `session/prompt` requests.\n\nBaseline agent functionality requires support for [`ContentBlock::Text`]\nand [`ContentBlock::ResourceLink`] in prompt requests.\n\nOther variants must be explicitly opted in to.\nCapabilities for different types of content in prompt requests.\n\nIndicates which content types beyond the baseline (text and resource links)\nthe agent can process.\n\nSee protocol docs: [Prompt Capabilities](https://agentclientprotocol.com/protocol/initialization#prompt-capabilities)",
"properties": {
"audio": {
"default": false,
"description": "Agent supports [`ContentBlock::Audio`].",
"type": "boolean"
},
"embeddedContext": {
"default": false,
"description": "Agent supports embedded context in `session/prompt` requests.\n\nWhen enabled, the Client is allowed to include [`ContentBlock::Resource`]\nin prompt requests for pieces of context that are referenced in the message.",
"type": "boolean"
},
"image": {
"default": false,
"description": "Agent supports [`ContentBlock::Image`].",
"type": "boolean"
}
},
"type": "object"
},
"PromptRequest": {
"description": "Request parameters for sending a user prompt to the agent.\n\nContains the user's message and any additional context.\n\nSee protocol docs: [User Message](https://agentclientprotocol.com/protocol/prompt-turn#1-user-message)",
"properties": {
"prompt": {
"description": "The blocks of content that compose the user's message.\n\nAs a baseline, the Agent MUST support [`ContentBlock::Text`] and [`ContentBlock::ResourceLink`],\nwhile other variants are optionally enabled via [`PromptCapabilities`].\n\nThe Client MUST adapt its interface according to [`PromptCapabilities`].\n\nThe client MAY include referenced pieces of context as either\n[`ContentBlock::Resource`] or [`ContentBlock::ResourceLink`].\n\nWhen available, [`ContentBlock::Resource`] is preferred\nas it avoids extra round-trips and allows the message to include\npieces of context from sources the agent may not have access to.",
"items": {
"$ref": "#/$defs/ContentBlock"
},
"type": "array"
},
"sessionId": {
"$ref": "#/$defs/SessionId",
"description": "The ID of the session to send this user message to"
}
},
"required": ["sessionId", "prompt"],
"type": "object",
"x-method": "session/prompt",
"x-side": "agent"
},
"PromptResponse": {
"description": "Response from processing a user prompt.\n\nSee protocol docs: [Check for Completion](https://agentclientprotocol.com/protocol/prompt-turn#4-check-for-completion)",
"properties": {
"stopReason": {
"$ref": "#/$defs/StopReason",
"description": "Indicates why the agent stopped processing the turn."
}
},
"required": ["stopReason"],
"type": "object",
"x-method": "session/prompt",
"x-side": "agent"
},
"ProtocolVersion": {
"description": "Protocol version identifier.\n\nThis version is only bumped for breaking changes.\nNon-breaking changes should be introduced via capabilities.",
"format": "uint16",
"maximum": 65535,
"minimum": 0,
"type": "integer"
},
"ReadTextFileRequest": {
"description": "Request to read content from a text file.\n\nOnly available if the client supports the `fs.readTextFile` capability.",
"properties": {
"limit": {
"description": "Optional maximum number of lines to read.",
"format": "uint32",
"minimum": 0,
"type": ["integer", "null"]
},
"line": {
"description": "Optional line number to start reading from (1-based).",
"format": "uint32",
"minimum": 0,
"type": ["integer", "null"]
},
"path": {
"description": "Absolute path to the file to read.",
"type": "string"
},
"sessionId": {
"$ref": "#/$defs/SessionId",
"description": "The session ID for this request."
}
},
"required": ["sessionId", "path"],
"type": "object",
"x-method": "fs/read_text_file",
"x-side": "client"
},
"ReadTextFileResponse": {
"description": "Response containing the contents of a text file.",
"properties": {
"content": {
"type": "string"
}
},
"required": ["content"],
"type": "object"
},
"ReleaseTerminalRequest": {
"properties": {