agent-client-protocol 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/LICENSE +190 -0
- data/README.md +126 -0
- data/lib/agent_client_protocol/codec.rb +111 -0
- data/lib/agent_client_protocol/constants.rb +78 -0
- data/lib/agent_client_protocol/decoder.rb +134 -0
- data/lib/agent_client_protocol/error.rb +104 -0
- data/lib/agent_client_protocol/methods.rb +19 -0
- data/lib/agent_client_protocol/protocol_version.rb +56 -0
- data/lib/agent_client_protocol/rpc.rb +160 -0
- data/lib/agent_client_protocol/schema_registry.rb +112 -0
- data/lib/agent_client_protocol/type_registry.rb +99 -0
- data/lib/agent_client_protocol/types/base.rb +314 -0
- data/lib/agent_client_protocol/types.rb +8 -0
- data/lib/agent_client_protocol/validator.rb +300 -0
- data/lib/agent_client_protocol/version.rb +5 -0
- data/lib/agent_client_protocol.rb +41 -0
- data/schema/meta.json +24 -0
- data/schema/meta.unstable.json +31 -0
- data/schema/schema.json +3430 -0
- data/schema/schema.unstable.json +4125 -0
- metadata +64 -0
|
@@ -0,0 +1,4125 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$defs": {
|
|
3
|
+
"AgentCapabilities": {
|
|
4
|
+
"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)",
|
|
5
|
+
"properties": {
|
|
6
|
+
"_meta": {
|
|
7
|
+
"additionalProperties": true,
|
|
8
|
+
"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)",
|
|
9
|
+
"type": ["object", "null"]
|
|
10
|
+
},
|
|
11
|
+
"loadSession": {
|
|
12
|
+
"default": false,
|
|
13
|
+
"description": "Whether the agent supports `session/load`.",
|
|
14
|
+
"type": "boolean"
|
|
15
|
+
},
|
|
16
|
+
"mcpCapabilities": {
|
|
17
|
+
"allOf": [
|
|
18
|
+
{
|
|
19
|
+
"$ref": "#/$defs/McpCapabilities"
|
|
20
|
+
}
|
|
21
|
+
],
|
|
22
|
+
"default": {
|
|
23
|
+
"http": false,
|
|
24
|
+
"sse": false
|
|
25
|
+
},
|
|
26
|
+
"description": "MCP capabilities supported by the agent."
|
|
27
|
+
},
|
|
28
|
+
"promptCapabilities": {
|
|
29
|
+
"allOf": [
|
|
30
|
+
{
|
|
31
|
+
"$ref": "#/$defs/PromptCapabilities"
|
|
32
|
+
}
|
|
33
|
+
],
|
|
34
|
+
"default": {
|
|
35
|
+
"audio": false,
|
|
36
|
+
"embeddedContext": false,
|
|
37
|
+
"image": false
|
|
38
|
+
},
|
|
39
|
+
"description": "Prompt capabilities supported by the agent."
|
|
40
|
+
},
|
|
41
|
+
"sessionCapabilities": {
|
|
42
|
+
"allOf": [
|
|
43
|
+
{
|
|
44
|
+
"$ref": "#/$defs/SessionCapabilities"
|
|
45
|
+
}
|
|
46
|
+
],
|
|
47
|
+
"default": {}
|
|
48
|
+
}
|
|
49
|
+
},
|
|
50
|
+
"type": "object"
|
|
51
|
+
},
|
|
52
|
+
"AgentNotification": {
|
|
53
|
+
"properties": {
|
|
54
|
+
"method": {
|
|
55
|
+
"type": "string"
|
|
56
|
+
},
|
|
57
|
+
"params": {
|
|
58
|
+
"anyOf": [
|
|
59
|
+
{
|
|
60
|
+
"anyOf": [
|
|
61
|
+
{
|
|
62
|
+
"allOf": [
|
|
63
|
+
{
|
|
64
|
+
"$ref": "#/$defs/SessionNotification"
|
|
65
|
+
}
|
|
66
|
+
],
|
|
67
|
+
"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)",
|
|
68
|
+
"title": "SessionNotification"
|
|
69
|
+
},
|
|
70
|
+
{
|
|
71
|
+
"allOf": [
|
|
72
|
+
{
|
|
73
|
+
"$ref": "#/$defs/ExtNotification"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"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)",
|
|
77
|
+
"title": "ExtNotification"
|
|
78
|
+
}
|
|
79
|
+
],
|
|
80
|
+
"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."
|
|
81
|
+
},
|
|
82
|
+
{
|
|
83
|
+
"type": "null"
|
|
84
|
+
}
|
|
85
|
+
]
|
|
86
|
+
}
|
|
87
|
+
},
|
|
88
|
+
"required": ["method"],
|
|
89
|
+
"type": "object",
|
|
90
|
+
"x-docs-ignore": true
|
|
91
|
+
},
|
|
92
|
+
"AgentRequest": {
|
|
93
|
+
"properties": {
|
|
94
|
+
"id": {
|
|
95
|
+
"$ref": "#/$defs/RequestId"
|
|
96
|
+
},
|
|
97
|
+
"method": {
|
|
98
|
+
"type": "string"
|
|
99
|
+
},
|
|
100
|
+
"params": {
|
|
101
|
+
"anyOf": [
|
|
102
|
+
{
|
|
103
|
+
"anyOf": [
|
|
104
|
+
{
|
|
105
|
+
"allOf": [
|
|
106
|
+
{
|
|
107
|
+
"$ref": "#/$defs/WriteTextFileRequest"
|
|
108
|
+
}
|
|
109
|
+
],
|
|
110
|
+
"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)",
|
|
111
|
+
"title": "WriteTextFileRequest"
|
|
112
|
+
},
|
|
113
|
+
{
|
|
114
|
+
"allOf": [
|
|
115
|
+
{
|
|
116
|
+
"$ref": "#/$defs/ReadTextFileRequest"
|
|
117
|
+
}
|
|
118
|
+
],
|
|
119
|
+
"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)",
|
|
120
|
+
"title": "ReadTextFileRequest"
|
|
121
|
+
},
|
|
122
|
+
{
|
|
123
|
+
"allOf": [
|
|
124
|
+
{
|
|
125
|
+
"$ref": "#/$defs/RequestPermissionRequest"
|
|
126
|
+
}
|
|
127
|
+
],
|
|
128
|
+
"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)",
|
|
129
|
+
"title": "RequestPermissionRequest"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"allOf": [
|
|
133
|
+
{
|
|
134
|
+
"$ref": "#/$defs/CreateTerminalRequest"
|
|
135
|
+
}
|
|
136
|
+
],
|
|
137
|
+
"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)",
|
|
138
|
+
"title": "CreateTerminalRequest"
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
"allOf": [
|
|
142
|
+
{
|
|
143
|
+
"$ref": "#/$defs/TerminalOutputRequest"
|
|
144
|
+
}
|
|
145
|
+
],
|
|
146
|
+
"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)",
|
|
147
|
+
"title": "TerminalOutputRequest"
|
|
148
|
+
},
|
|
149
|
+
{
|
|
150
|
+
"allOf": [
|
|
151
|
+
{
|
|
152
|
+
"$ref": "#/$defs/ReleaseTerminalRequest"
|
|
153
|
+
}
|
|
154
|
+
],
|
|
155
|
+
"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)",
|
|
156
|
+
"title": "ReleaseTerminalRequest"
|
|
157
|
+
},
|
|
158
|
+
{
|
|
159
|
+
"allOf": [
|
|
160
|
+
{
|
|
161
|
+
"$ref": "#/$defs/WaitForTerminalExitRequest"
|
|
162
|
+
}
|
|
163
|
+
],
|
|
164
|
+
"description": "Waits for the terminal command to exit and return its exit status\n\nSee protocol docs: [Terminals](https://agentclientprotocol.com/protocol/terminals)",
|
|
165
|
+
"title": "WaitForTerminalExitRequest"
|
|
166
|
+
},
|
|
167
|
+
{
|
|
168
|
+
"allOf": [
|
|
169
|
+
{
|
|
170
|
+
"$ref": "#/$defs/KillTerminalCommandRequest"
|
|
171
|
+
}
|
|
172
|
+
],
|
|
173
|
+
"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)",
|
|
174
|
+
"title": "KillTerminalCommandRequest"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"allOf": [
|
|
178
|
+
{
|
|
179
|
+
"$ref": "#/$defs/ExtRequest"
|
|
180
|
+
}
|
|
181
|
+
],
|
|
182
|
+
"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)",
|
|
183
|
+
"title": "ExtMethodRequest"
|
|
184
|
+
}
|
|
185
|
+
],
|
|
186
|
+
"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."
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"type": "null"
|
|
190
|
+
}
|
|
191
|
+
]
|
|
192
|
+
}
|
|
193
|
+
},
|
|
194
|
+
"required": ["id", "method"],
|
|
195
|
+
"type": "object",
|
|
196
|
+
"x-docs-ignore": true
|
|
197
|
+
},
|
|
198
|
+
"AgentResponse": {
|
|
199
|
+
"anyOf": [
|
|
200
|
+
{
|
|
201
|
+
"properties": {
|
|
202
|
+
"id": {
|
|
203
|
+
"$ref": "#/$defs/RequestId"
|
|
204
|
+
},
|
|
205
|
+
"result": {
|
|
206
|
+
"anyOf": [
|
|
207
|
+
{
|
|
208
|
+
"allOf": [
|
|
209
|
+
{
|
|
210
|
+
"$ref": "#/$defs/InitializeResponse"
|
|
211
|
+
}
|
|
212
|
+
],
|
|
213
|
+
"title": "InitializeResponse"
|
|
214
|
+
},
|
|
215
|
+
{
|
|
216
|
+
"allOf": [
|
|
217
|
+
{
|
|
218
|
+
"$ref": "#/$defs/AuthenticateResponse"
|
|
219
|
+
}
|
|
220
|
+
],
|
|
221
|
+
"title": "AuthenticateResponse"
|
|
222
|
+
},
|
|
223
|
+
{
|
|
224
|
+
"allOf": [
|
|
225
|
+
{
|
|
226
|
+
"$ref": "#/$defs/NewSessionResponse"
|
|
227
|
+
}
|
|
228
|
+
],
|
|
229
|
+
"title": "NewSessionResponse"
|
|
230
|
+
},
|
|
231
|
+
{
|
|
232
|
+
"allOf": [
|
|
233
|
+
{
|
|
234
|
+
"$ref": "#/$defs/LoadSessionResponse"
|
|
235
|
+
}
|
|
236
|
+
],
|
|
237
|
+
"title": "LoadSessionResponse"
|
|
238
|
+
},
|
|
239
|
+
{
|
|
240
|
+
"allOf": [
|
|
241
|
+
{
|
|
242
|
+
"$ref": "#/$defs/ListSessionsResponse"
|
|
243
|
+
}
|
|
244
|
+
],
|
|
245
|
+
"title": "ListSessionsResponse"
|
|
246
|
+
},
|
|
247
|
+
{
|
|
248
|
+
"allOf": [
|
|
249
|
+
{
|
|
250
|
+
"$ref": "#/$defs/ForkSessionResponse"
|
|
251
|
+
}
|
|
252
|
+
],
|
|
253
|
+
"title": "ForkSessionResponse"
|
|
254
|
+
},
|
|
255
|
+
{
|
|
256
|
+
"allOf": [
|
|
257
|
+
{
|
|
258
|
+
"$ref": "#/$defs/ResumeSessionResponse"
|
|
259
|
+
}
|
|
260
|
+
],
|
|
261
|
+
"title": "ResumeSessionResponse"
|
|
262
|
+
},
|
|
263
|
+
{
|
|
264
|
+
"allOf": [
|
|
265
|
+
{
|
|
266
|
+
"$ref": "#/$defs/SetSessionModeResponse"
|
|
267
|
+
}
|
|
268
|
+
],
|
|
269
|
+
"title": "SetSessionModeResponse"
|
|
270
|
+
},
|
|
271
|
+
{
|
|
272
|
+
"allOf": [
|
|
273
|
+
{
|
|
274
|
+
"$ref": "#/$defs/SetSessionConfigOptionResponse"
|
|
275
|
+
}
|
|
276
|
+
],
|
|
277
|
+
"title": "SetSessionConfigOptionResponse"
|
|
278
|
+
},
|
|
279
|
+
{
|
|
280
|
+
"allOf": [
|
|
281
|
+
{
|
|
282
|
+
"$ref": "#/$defs/PromptResponse"
|
|
283
|
+
}
|
|
284
|
+
],
|
|
285
|
+
"title": "PromptResponse"
|
|
286
|
+
},
|
|
287
|
+
{
|
|
288
|
+
"allOf": [
|
|
289
|
+
{
|
|
290
|
+
"$ref": "#/$defs/SetSessionModelResponse"
|
|
291
|
+
}
|
|
292
|
+
],
|
|
293
|
+
"title": "SetSessionModelResponse"
|
|
294
|
+
},
|
|
295
|
+
{
|
|
296
|
+
"allOf": [
|
|
297
|
+
{
|
|
298
|
+
"$ref": "#/$defs/ExtResponse"
|
|
299
|
+
}
|
|
300
|
+
],
|
|
301
|
+
"title": "ExtMethodResponse"
|
|
302
|
+
}
|
|
303
|
+
],
|
|
304
|
+
"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."
|
|
305
|
+
}
|
|
306
|
+
},
|
|
307
|
+
"required": ["id", "result"],
|
|
308
|
+
"title": "Result",
|
|
309
|
+
"type": "object"
|
|
310
|
+
},
|
|
311
|
+
{
|
|
312
|
+
"properties": {
|
|
313
|
+
"error": {
|
|
314
|
+
"$ref": "#/$defs/Error"
|
|
315
|
+
},
|
|
316
|
+
"id": {
|
|
317
|
+
"$ref": "#/$defs/RequestId"
|
|
318
|
+
}
|
|
319
|
+
},
|
|
320
|
+
"required": ["id", "error"],
|
|
321
|
+
"title": "Error",
|
|
322
|
+
"type": "object"
|
|
323
|
+
}
|
|
324
|
+
],
|
|
325
|
+
"x-docs-ignore": true
|
|
326
|
+
},
|
|
327
|
+
"Annotations": {
|
|
328
|
+
"description": "Optional annotations for the client. The client can use annotations to inform how objects are used or displayed",
|
|
329
|
+
"properties": {
|
|
330
|
+
"_meta": {
|
|
331
|
+
"additionalProperties": true,
|
|
332
|
+
"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)",
|
|
333
|
+
"type": ["object", "null"]
|
|
334
|
+
},
|
|
335
|
+
"audience": {
|
|
336
|
+
"items": {
|
|
337
|
+
"$ref": "#/$defs/Role"
|
|
338
|
+
},
|
|
339
|
+
"type": ["array", "null"]
|
|
340
|
+
},
|
|
341
|
+
"lastModified": {
|
|
342
|
+
"type": ["string", "null"]
|
|
343
|
+
},
|
|
344
|
+
"priority": {
|
|
345
|
+
"format": "double",
|
|
346
|
+
"type": ["number", "null"]
|
|
347
|
+
}
|
|
348
|
+
},
|
|
349
|
+
"type": "object"
|
|
350
|
+
},
|
|
351
|
+
"AudioContent": {
|
|
352
|
+
"description": "Audio provided to or from an LLM.",
|
|
353
|
+
"properties": {
|
|
354
|
+
"_meta": {
|
|
355
|
+
"additionalProperties": true,
|
|
356
|
+
"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)",
|
|
357
|
+
"type": ["object", "null"]
|
|
358
|
+
},
|
|
359
|
+
"annotations": {
|
|
360
|
+
"anyOf": [
|
|
361
|
+
{
|
|
362
|
+
"$ref": "#/$defs/Annotations"
|
|
363
|
+
},
|
|
364
|
+
{
|
|
365
|
+
"type": "null"
|
|
366
|
+
}
|
|
367
|
+
]
|
|
368
|
+
},
|
|
369
|
+
"data": {
|
|
370
|
+
"type": "string"
|
|
371
|
+
},
|
|
372
|
+
"mimeType": {
|
|
373
|
+
"type": "string"
|
|
374
|
+
}
|
|
375
|
+
},
|
|
376
|
+
"required": ["data", "mimeType"],
|
|
377
|
+
"type": "object"
|
|
378
|
+
},
|
|
379
|
+
"AuthMethod": {
|
|
380
|
+
"description": "Describes an available authentication method.",
|
|
381
|
+
"properties": {
|
|
382
|
+
"_meta": {
|
|
383
|
+
"additionalProperties": true,
|
|
384
|
+
"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)",
|
|
385
|
+
"type": ["object", "null"]
|
|
386
|
+
},
|
|
387
|
+
"description": {
|
|
388
|
+
"description": "Optional description providing more details about this authentication method.",
|
|
389
|
+
"type": ["string", "null"]
|
|
390
|
+
},
|
|
391
|
+
"id": {
|
|
392
|
+
"description": "Unique identifier for this authentication method.",
|
|
393
|
+
"type": "string"
|
|
394
|
+
},
|
|
395
|
+
"name": {
|
|
396
|
+
"description": "Human-readable name of the authentication method.",
|
|
397
|
+
"type": "string"
|
|
398
|
+
}
|
|
399
|
+
},
|
|
400
|
+
"required": ["id", "name"],
|
|
401
|
+
"type": "object"
|
|
402
|
+
},
|
|
403
|
+
"AuthenticateRequest": {
|
|
404
|
+
"description": "Request parameters for the authenticate method.\n\nSpecifies which authentication method to use.",
|
|
405
|
+
"properties": {
|
|
406
|
+
"_meta": {
|
|
407
|
+
"additionalProperties": true,
|
|
408
|
+
"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)",
|
|
409
|
+
"type": ["object", "null"]
|
|
410
|
+
},
|
|
411
|
+
"methodId": {
|
|
412
|
+
"description": "The ID of the authentication method to use.\nMust be one of the methods advertised in the initialize response.",
|
|
413
|
+
"type": "string"
|
|
414
|
+
}
|
|
415
|
+
},
|
|
416
|
+
"required": ["methodId"],
|
|
417
|
+
"type": "object",
|
|
418
|
+
"x-method": "authenticate",
|
|
419
|
+
"x-side": "agent"
|
|
420
|
+
},
|
|
421
|
+
"AuthenticateResponse": {
|
|
422
|
+
"description": "Response to the `authenticate` method.",
|
|
423
|
+
"properties": {
|
|
424
|
+
"_meta": {
|
|
425
|
+
"additionalProperties": true,
|
|
426
|
+
"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)",
|
|
427
|
+
"type": ["object", "null"]
|
|
428
|
+
}
|
|
429
|
+
},
|
|
430
|
+
"type": "object",
|
|
431
|
+
"x-method": "authenticate",
|
|
432
|
+
"x-side": "agent"
|
|
433
|
+
},
|
|
434
|
+
"AvailableCommand": {
|
|
435
|
+
"description": "Information about a command.",
|
|
436
|
+
"properties": {
|
|
437
|
+
"_meta": {
|
|
438
|
+
"additionalProperties": true,
|
|
439
|
+
"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)",
|
|
440
|
+
"type": ["object", "null"]
|
|
441
|
+
},
|
|
442
|
+
"description": {
|
|
443
|
+
"description": "Human-readable description of what the command does.",
|
|
444
|
+
"type": "string"
|
|
445
|
+
},
|
|
446
|
+
"input": {
|
|
447
|
+
"anyOf": [
|
|
448
|
+
{
|
|
449
|
+
"$ref": "#/$defs/AvailableCommandInput"
|
|
450
|
+
},
|
|
451
|
+
{
|
|
452
|
+
"type": "null"
|
|
453
|
+
}
|
|
454
|
+
],
|
|
455
|
+
"description": "Input for the command if required"
|
|
456
|
+
},
|
|
457
|
+
"name": {
|
|
458
|
+
"description": "Command name (e.g., `create_plan`, `research_codebase`).",
|
|
459
|
+
"type": "string"
|
|
460
|
+
}
|
|
461
|
+
},
|
|
462
|
+
"required": ["name", "description"],
|
|
463
|
+
"type": "object"
|
|
464
|
+
},
|
|
465
|
+
"AvailableCommandInput": {
|
|
466
|
+
"anyOf": [
|
|
467
|
+
{
|
|
468
|
+
"allOf": [
|
|
469
|
+
{
|
|
470
|
+
"$ref": "#/$defs/UnstructuredCommandInput"
|
|
471
|
+
}
|
|
472
|
+
],
|
|
473
|
+
"description": "All text that was typed after the command name is provided as input.",
|
|
474
|
+
"title": "unstructured"
|
|
475
|
+
}
|
|
476
|
+
],
|
|
477
|
+
"description": "The input specification for a command."
|
|
478
|
+
},
|
|
479
|
+
"AvailableCommandsUpdate": {
|
|
480
|
+
"description": "Available commands are ready or have changed",
|
|
481
|
+
"properties": {
|
|
482
|
+
"_meta": {
|
|
483
|
+
"additionalProperties": true,
|
|
484
|
+
"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)",
|
|
485
|
+
"type": ["object", "null"]
|
|
486
|
+
},
|
|
487
|
+
"availableCommands": {
|
|
488
|
+
"description": "Commands the agent can execute",
|
|
489
|
+
"items": {
|
|
490
|
+
"$ref": "#/$defs/AvailableCommand"
|
|
491
|
+
},
|
|
492
|
+
"type": "array"
|
|
493
|
+
}
|
|
494
|
+
},
|
|
495
|
+
"required": ["availableCommands"],
|
|
496
|
+
"type": "object"
|
|
497
|
+
},
|
|
498
|
+
"BlobResourceContents": {
|
|
499
|
+
"description": "Binary resource contents.",
|
|
500
|
+
"properties": {
|
|
501
|
+
"_meta": {
|
|
502
|
+
"additionalProperties": true,
|
|
503
|
+
"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)",
|
|
504
|
+
"type": ["object", "null"]
|
|
505
|
+
},
|
|
506
|
+
"blob": {
|
|
507
|
+
"type": "string"
|
|
508
|
+
},
|
|
509
|
+
"mimeType": {
|
|
510
|
+
"type": ["string", "null"]
|
|
511
|
+
},
|
|
512
|
+
"uri": {
|
|
513
|
+
"type": "string"
|
|
514
|
+
}
|
|
515
|
+
},
|
|
516
|
+
"required": ["blob", "uri"],
|
|
517
|
+
"type": "object"
|
|
518
|
+
},
|
|
519
|
+
"CancelNotification": {
|
|
520
|
+
"description": "Notification to cancel ongoing operations for a session.\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/prompt-turn#cancellation)",
|
|
521
|
+
"properties": {
|
|
522
|
+
"_meta": {
|
|
523
|
+
"additionalProperties": true,
|
|
524
|
+
"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)",
|
|
525
|
+
"type": ["object", "null"]
|
|
526
|
+
},
|
|
527
|
+
"sessionId": {
|
|
528
|
+
"allOf": [
|
|
529
|
+
{
|
|
530
|
+
"$ref": "#/$defs/SessionId"
|
|
531
|
+
}
|
|
532
|
+
],
|
|
533
|
+
"description": "The ID of the session to cancel operations for."
|
|
534
|
+
}
|
|
535
|
+
},
|
|
536
|
+
"required": ["sessionId"],
|
|
537
|
+
"type": "object",
|
|
538
|
+
"x-method": "session/cancel",
|
|
539
|
+
"x-side": "agent"
|
|
540
|
+
},
|
|
541
|
+
"CancelRequestNotification": {
|
|
542
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nNotification to cancel an ongoing request.\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/cancellation)",
|
|
543
|
+
"properties": {
|
|
544
|
+
"_meta": {
|
|
545
|
+
"additionalProperties": true,
|
|
546
|
+
"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)",
|
|
547
|
+
"type": ["object", "null"]
|
|
548
|
+
},
|
|
549
|
+
"requestId": {
|
|
550
|
+
"allOf": [
|
|
551
|
+
{
|
|
552
|
+
"$ref": "#/$defs/RequestId"
|
|
553
|
+
}
|
|
554
|
+
],
|
|
555
|
+
"description": "The ID of the request to cancel."
|
|
556
|
+
}
|
|
557
|
+
},
|
|
558
|
+
"required": ["requestId"],
|
|
559
|
+
"type": "object",
|
|
560
|
+
"x-method": "$/cancel_request",
|
|
561
|
+
"x-side": "protocol"
|
|
562
|
+
},
|
|
563
|
+
"ClientCapabilities": {
|
|
564
|
+
"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)",
|
|
565
|
+
"properties": {
|
|
566
|
+
"_meta": {
|
|
567
|
+
"additionalProperties": true,
|
|
568
|
+
"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)",
|
|
569
|
+
"type": ["object", "null"]
|
|
570
|
+
},
|
|
571
|
+
"fs": {
|
|
572
|
+
"allOf": [
|
|
573
|
+
{
|
|
574
|
+
"$ref": "#/$defs/FileSystemCapability"
|
|
575
|
+
}
|
|
576
|
+
],
|
|
577
|
+
"default": {
|
|
578
|
+
"readTextFile": false,
|
|
579
|
+
"writeTextFile": false
|
|
580
|
+
},
|
|
581
|
+
"description": "File system capabilities supported by the client.\nDetermines which file operations the agent can request."
|
|
582
|
+
},
|
|
583
|
+
"terminal": {
|
|
584
|
+
"default": false,
|
|
585
|
+
"description": "Whether the Client support all `terminal/*` methods.",
|
|
586
|
+
"type": "boolean"
|
|
587
|
+
}
|
|
588
|
+
},
|
|
589
|
+
"type": "object"
|
|
590
|
+
},
|
|
591
|
+
"ClientNotification": {
|
|
592
|
+
"properties": {
|
|
593
|
+
"method": {
|
|
594
|
+
"type": "string"
|
|
595
|
+
},
|
|
596
|
+
"params": {
|
|
597
|
+
"anyOf": [
|
|
598
|
+
{
|
|
599
|
+
"anyOf": [
|
|
600
|
+
{
|
|
601
|
+
"allOf": [
|
|
602
|
+
{
|
|
603
|
+
"$ref": "#/$defs/CancelNotification"
|
|
604
|
+
}
|
|
605
|
+
],
|
|
606
|
+
"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)",
|
|
607
|
+
"title": "CancelNotification"
|
|
608
|
+
},
|
|
609
|
+
{
|
|
610
|
+
"allOf": [
|
|
611
|
+
{
|
|
612
|
+
"$ref": "#/$defs/ExtNotification"
|
|
613
|
+
}
|
|
614
|
+
],
|
|
615
|
+
"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)",
|
|
616
|
+
"title": "ExtNotification"
|
|
617
|
+
}
|
|
618
|
+
],
|
|
619
|
+
"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."
|
|
620
|
+
},
|
|
621
|
+
{
|
|
622
|
+
"type": "null"
|
|
623
|
+
}
|
|
624
|
+
]
|
|
625
|
+
}
|
|
626
|
+
},
|
|
627
|
+
"required": ["method"],
|
|
628
|
+
"type": "object",
|
|
629
|
+
"x-docs-ignore": true
|
|
630
|
+
},
|
|
631
|
+
"ClientRequest": {
|
|
632
|
+
"properties": {
|
|
633
|
+
"id": {
|
|
634
|
+
"$ref": "#/$defs/RequestId"
|
|
635
|
+
},
|
|
636
|
+
"method": {
|
|
637
|
+
"type": "string"
|
|
638
|
+
},
|
|
639
|
+
"params": {
|
|
640
|
+
"anyOf": [
|
|
641
|
+
{
|
|
642
|
+
"anyOf": [
|
|
643
|
+
{
|
|
644
|
+
"allOf": [
|
|
645
|
+
{
|
|
646
|
+
"$ref": "#/$defs/InitializeRequest"
|
|
647
|
+
}
|
|
648
|
+
],
|
|
649
|
+
"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)",
|
|
650
|
+
"title": "InitializeRequest"
|
|
651
|
+
},
|
|
652
|
+
{
|
|
653
|
+
"allOf": [
|
|
654
|
+
{
|
|
655
|
+
"$ref": "#/$defs/AuthenticateRequest"
|
|
656
|
+
}
|
|
657
|
+
],
|
|
658
|
+
"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)",
|
|
659
|
+
"title": "AuthenticateRequest"
|
|
660
|
+
},
|
|
661
|
+
{
|
|
662
|
+
"allOf": [
|
|
663
|
+
{
|
|
664
|
+
"$ref": "#/$defs/NewSessionRequest"
|
|
665
|
+
}
|
|
666
|
+
],
|
|
667
|
+
"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)",
|
|
668
|
+
"title": "NewSessionRequest"
|
|
669
|
+
},
|
|
670
|
+
{
|
|
671
|
+
"allOf": [
|
|
672
|
+
{
|
|
673
|
+
"$ref": "#/$defs/LoadSessionRequest"
|
|
674
|
+
}
|
|
675
|
+
],
|
|
676
|
+
"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)",
|
|
677
|
+
"title": "LoadSessionRequest"
|
|
678
|
+
},
|
|
679
|
+
{
|
|
680
|
+
"allOf": [
|
|
681
|
+
{
|
|
682
|
+
"$ref": "#/$defs/ListSessionsRequest"
|
|
683
|
+
}
|
|
684
|
+
],
|
|
685
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nLists existing sessions known to the agent.\n\nThis method is only available if the agent advertises the `listSessions` capability.\n\nThe agent should return metadata about sessions with optional filtering and pagination support.",
|
|
686
|
+
"title": "ListSessionsRequest"
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
"allOf": [
|
|
690
|
+
{
|
|
691
|
+
"$ref": "#/$defs/ForkSessionRequest"
|
|
692
|
+
}
|
|
693
|
+
],
|
|
694
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nForks an existing session to create a new independent session.\n\nThis method is only available if the agent advertises the `session.fork` capability.\n\nThe agent should create a new session with the same conversation context as the\noriginal, allowing operations like generating summaries without affecting the\noriginal session's history.",
|
|
695
|
+
"title": "ForkSessionRequest"
|
|
696
|
+
},
|
|
697
|
+
{
|
|
698
|
+
"allOf": [
|
|
699
|
+
{
|
|
700
|
+
"$ref": "#/$defs/ResumeSessionRequest"
|
|
701
|
+
}
|
|
702
|
+
],
|
|
703
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nResumes an existing session without returning previous messages.\n\nThis method is only available if the agent advertises the `session.resume` capability.\n\nThe agent should resume the session context, allowing the conversation to continue\nwithout replaying the message history (unlike `session/load`).",
|
|
704
|
+
"title": "ResumeSessionRequest"
|
|
705
|
+
},
|
|
706
|
+
{
|
|
707
|
+
"allOf": [
|
|
708
|
+
{
|
|
709
|
+
"$ref": "#/$defs/SetSessionModeRequest"
|
|
710
|
+
}
|
|
711
|
+
],
|
|
712
|
+
"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)",
|
|
713
|
+
"title": "SetSessionModeRequest"
|
|
714
|
+
},
|
|
715
|
+
{
|
|
716
|
+
"allOf": [
|
|
717
|
+
{
|
|
718
|
+
"$ref": "#/$defs/SetSessionConfigOptionRequest"
|
|
719
|
+
}
|
|
720
|
+
],
|
|
721
|
+
"description": "Sets the current value for a session configuration option.",
|
|
722
|
+
"title": "SetSessionConfigOptionRequest"
|
|
723
|
+
},
|
|
724
|
+
{
|
|
725
|
+
"allOf": [
|
|
726
|
+
{
|
|
727
|
+
"$ref": "#/$defs/PromptRequest"
|
|
728
|
+
}
|
|
729
|
+
],
|
|
730
|
+
"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)",
|
|
731
|
+
"title": "PromptRequest"
|
|
732
|
+
},
|
|
733
|
+
{
|
|
734
|
+
"allOf": [
|
|
735
|
+
{
|
|
736
|
+
"$ref": "#/$defs/SetSessionModelRequest"
|
|
737
|
+
}
|
|
738
|
+
],
|
|
739
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nSelect a model for a given session.",
|
|
740
|
+
"title": "SetSessionModelRequest"
|
|
741
|
+
},
|
|
742
|
+
{
|
|
743
|
+
"allOf": [
|
|
744
|
+
{
|
|
745
|
+
"$ref": "#/$defs/ExtRequest"
|
|
746
|
+
}
|
|
747
|
+
],
|
|
748
|
+
"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)",
|
|
749
|
+
"title": "ExtMethodRequest"
|
|
750
|
+
}
|
|
751
|
+
],
|
|
752
|
+
"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."
|
|
753
|
+
},
|
|
754
|
+
{
|
|
755
|
+
"type": "null"
|
|
756
|
+
}
|
|
757
|
+
]
|
|
758
|
+
}
|
|
759
|
+
},
|
|
760
|
+
"required": ["id", "method"],
|
|
761
|
+
"type": "object",
|
|
762
|
+
"x-docs-ignore": true
|
|
763
|
+
},
|
|
764
|
+
"ClientResponse": {
|
|
765
|
+
"anyOf": [
|
|
766
|
+
{
|
|
767
|
+
"properties": {
|
|
768
|
+
"id": {
|
|
769
|
+
"$ref": "#/$defs/RequestId"
|
|
770
|
+
},
|
|
771
|
+
"result": {
|
|
772
|
+
"anyOf": [
|
|
773
|
+
{
|
|
774
|
+
"allOf": [
|
|
775
|
+
{
|
|
776
|
+
"$ref": "#/$defs/WriteTextFileResponse"
|
|
777
|
+
}
|
|
778
|
+
],
|
|
779
|
+
"title": "WriteTextFileResponse"
|
|
780
|
+
},
|
|
781
|
+
{
|
|
782
|
+
"allOf": [
|
|
783
|
+
{
|
|
784
|
+
"$ref": "#/$defs/ReadTextFileResponse"
|
|
785
|
+
}
|
|
786
|
+
],
|
|
787
|
+
"title": "ReadTextFileResponse"
|
|
788
|
+
},
|
|
789
|
+
{
|
|
790
|
+
"allOf": [
|
|
791
|
+
{
|
|
792
|
+
"$ref": "#/$defs/RequestPermissionResponse"
|
|
793
|
+
}
|
|
794
|
+
],
|
|
795
|
+
"title": "RequestPermissionResponse"
|
|
796
|
+
},
|
|
797
|
+
{
|
|
798
|
+
"allOf": [
|
|
799
|
+
{
|
|
800
|
+
"$ref": "#/$defs/CreateTerminalResponse"
|
|
801
|
+
}
|
|
802
|
+
],
|
|
803
|
+
"title": "CreateTerminalResponse"
|
|
804
|
+
},
|
|
805
|
+
{
|
|
806
|
+
"allOf": [
|
|
807
|
+
{
|
|
808
|
+
"$ref": "#/$defs/TerminalOutputResponse"
|
|
809
|
+
}
|
|
810
|
+
],
|
|
811
|
+
"title": "TerminalOutputResponse"
|
|
812
|
+
},
|
|
813
|
+
{
|
|
814
|
+
"allOf": [
|
|
815
|
+
{
|
|
816
|
+
"$ref": "#/$defs/ReleaseTerminalResponse"
|
|
817
|
+
}
|
|
818
|
+
],
|
|
819
|
+
"title": "ReleaseTerminalResponse"
|
|
820
|
+
},
|
|
821
|
+
{
|
|
822
|
+
"allOf": [
|
|
823
|
+
{
|
|
824
|
+
"$ref": "#/$defs/WaitForTerminalExitResponse"
|
|
825
|
+
}
|
|
826
|
+
],
|
|
827
|
+
"title": "WaitForTerminalExitResponse"
|
|
828
|
+
},
|
|
829
|
+
{
|
|
830
|
+
"allOf": [
|
|
831
|
+
{
|
|
832
|
+
"$ref": "#/$defs/KillTerminalCommandResponse"
|
|
833
|
+
}
|
|
834
|
+
],
|
|
835
|
+
"title": "KillTerminalResponse"
|
|
836
|
+
},
|
|
837
|
+
{
|
|
838
|
+
"allOf": [
|
|
839
|
+
{
|
|
840
|
+
"$ref": "#/$defs/ExtResponse"
|
|
841
|
+
}
|
|
842
|
+
],
|
|
843
|
+
"title": "ExtMethodResponse"
|
|
844
|
+
}
|
|
845
|
+
],
|
|
846
|
+
"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."
|
|
847
|
+
}
|
|
848
|
+
},
|
|
849
|
+
"required": ["id", "result"],
|
|
850
|
+
"title": "Result",
|
|
851
|
+
"type": "object"
|
|
852
|
+
},
|
|
853
|
+
{
|
|
854
|
+
"properties": {
|
|
855
|
+
"error": {
|
|
856
|
+
"$ref": "#/$defs/Error"
|
|
857
|
+
},
|
|
858
|
+
"id": {
|
|
859
|
+
"$ref": "#/$defs/RequestId"
|
|
860
|
+
}
|
|
861
|
+
},
|
|
862
|
+
"required": ["id", "error"],
|
|
863
|
+
"title": "Error",
|
|
864
|
+
"type": "object"
|
|
865
|
+
}
|
|
866
|
+
],
|
|
867
|
+
"x-docs-ignore": true
|
|
868
|
+
},
|
|
869
|
+
"ConfigOptionUpdate": {
|
|
870
|
+
"description": "Session configuration options have been updated.",
|
|
871
|
+
"properties": {
|
|
872
|
+
"_meta": {
|
|
873
|
+
"additionalProperties": true,
|
|
874
|
+
"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)",
|
|
875
|
+
"type": ["object", "null"]
|
|
876
|
+
},
|
|
877
|
+
"configOptions": {
|
|
878
|
+
"description": "The full set of configuration options and their current values.",
|
|
879
|
+
"items": {
|
|
880
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
881
|
+
},
|
|
882
|
+
"type": "array"
|
|
883
|
+
}
|
|
884
|
+
},
|
|
885
|
+
"required": ["configOptions"],
|
|
886
|
+
"type": "object"
|
|
887
|
+
},
|
|
888
|
+
"Content": {
|
|
889
|
+
"description": "Standard content block (text, images, resources).",
|
|
890
|
+
"properties": {
|
|
891
|
+
"_meta": {
|
|
892
|
+
"additionalProperties": true,
|
|
893
|
+
"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)",
|
|
894
|
+
"type": ["object", "null"]
|
|
895
|
+
},
|
|
896
|
+
"content": {
|
|
897
|
+
"allOf": [
|
|
898
|
+
{
|
|
899
|
+
"$ref": "#/$defs/ContentBlock"
|
|
900
|
+
}
|
|
901
|
+
],
|
|
902
|
+
"description": "The actual content block."
|
|
903
|
+
}
|
|
904
|
+
},
|
|
905
|
+
"required": ["content"],
|
|
906
|
+
"type": "object"
|
|
907
|
+
},
|
|
908
|
+
"ContentBlock": {
|
|
909
|
+
"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)",
|
|
910
|
+
"discriminator": {
|
|
911
|
+
"propertyName": "type"
|
|
912
|
+
},
|
|
913
|
+
"oneOf": [
|
|
914
|
+
{
|
|
915
|
+
"allOf": [
|
|
916
|
+
{
|
|
917
|
+
"$ref": "#/$defs/TextContent"
|
|
918
|
+
}
|
|
919
|
+
],
|
|
920
|
+
"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.",
|
|
921
|
+
"properties": {
|
|
922
|
+
"type": {
|
|
923
|
+
"const": "text",
|
|
924
|
+
"type": "string"
|
|
925
|
+
}
|
|
926
|
+
},
|
|
927
|
+
"required": ["type"],
|
|
928
|
+
"type": "object"
|
|
929
|
+
},
|
|
930
|
+
{
|
|
931
|
+
"allOf": [
|
|
932
|
+
{
|
|
933
|
+
"$ref": "#/$defs/ImageContent"
|
|
934
|
+
}
|
|
935
|
+
],
|
|
936
|
+
"description": "Images for visual context or analysis.\n\nRequires the `image` prompt capability when included in prompts.",
|
|
937
|
+
"properties": {
|
|
938
|
+
"type": {
|
|
939
|
+
"const": "image",
|
|
940
|
+
"type": "string"
|
|
941
|
+
}
|
|
942
|
+
},
|
|
943
|
+
"required": ["type"],
|
|
944
|
+
"type": "object"
|
|
945
|
+
},
|
|
946
|
+
{
|
|
947
|
+
"allOf": [
|
|
948
|
+
{
|
|
949
|
+
"$ref": "#/$defs/AudioContent"
|
|
950
|
+
}
|
|
951
|
+
],
|
|
952
|
+
"description": "Audio data for transcription or analysis.\n\nRequires the `audio` prompt capability when included in prompts.",
|
|
953
|
+
"properties": {
|
|
954
|
+
"type": {
|
|
955
|
+
"const": "audio",
|
|
956
|
+
"type": "string"
|
|
957
|
+
}
|
|
958
|
+
},
|
|
959
|
+
"required": ["type"],
|
|
960
|
+
"type": "object"
|
|
961
|
+
},
|
|
962
|
+
{
|
|
963
|
+
"allOf": [
|
|
964
|
+
{
|
|
965
|
+
"$ref": "#/$defs/ResourceLink"
|
|
966
|
+
}
|
|
967
|
+
],
|
|
968
|
+
"description": "References to resources that the agent can access.\n\nAll agents MUST support resource links in prompts.",
|
|
969
|
+
"properties": {
|
|
970
|
+
"type": {
|
|
971
|
+
"const": "resource_link",
|
|
972
|
+
"type": "string"
|
|
973
|
+
}
|
|
974
|
+
},
|
|
975
|
+
"required": ["type"],
|
|
976
|
+
"type": "object"
|
|
977
|
+
},
|
|
978
|
+
{
|
|
979
|
+
"allOf": [
|
|
980
|
+
{
|
|
981
|
+
"$ref": "#/$defs/EmbeddedResource"
|
|
982
|
+
}
|
|
983
|
+
],
|
|
984
|
+
"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.",
|
|
985
|
+
"properties": {
|
|
986
|
+
"type": {
|
|
987
|
+
"const": "resource",
|
|
988
|
+
"type": "string"
|
|
989
|
+
}
|
|
990
|
+
},
|
|
991
|
+
"required": ["type"],
|
|
992
|
+
"type": "object"
|
|
993
|
+
}
|
|
994
|
+
]
|
|
995
|
+
},
|
|
996
|
+
"ContentChunk": {
|
|
997
|
+
"description": "A streamed item of content",
|
|
998
|
+
"properties": {
|
|
999
|
+
"_meta": {
|
|
1000
|
+
"additionalProperties": true,
|
|
1001
|
+
"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)",
|
|
1002
|
+
"type": ["object", "null"]
|
|
1003
|
+
},
|
|
1004
|
+
"content": {
|
|
1005
|
+
"allOf": [
|
|
1006
|
+
{
|
|
1007
|
+
"$ref": "#/$defs/ContentBlock"
|
|
1008
|
+
}
|
|
1009
|
+
],
|
|
1010
|
+
"description": "A single item of content"
|
|
1011
|
+
}
|
|
1012
|
+
},
|
|
1013
|
+
"required": ["content"],
|
|
1014
|
+
"type": "object"
|
|
1015
|
+
},
|
|
1016
|
+
"Cost": {
|
|
1017
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nCost information for a session.",
|
|
1018
|
+
"properties": {
|
|
1019
|
+
"amount": {
|
|
1020
|
+
"description": "Total cumulative cost for session.",
|
|
1021
|
+
"format": "double",
|
|
1022
|
+
"type": "number"
|
|
1023
|
+
},
|
|
1024
|
+
"currency": {
|
|
1025
|
+
"description": "ISO 4217 currency code (e.g., \"USD\", \"EUR\").",
|
|
1026
|
+
"type": "string"
|
|
1027
|
+
}
|
|
1028
|
+
},
|
|
1029
|
+
"required": ["amount", "currency"],
|
|
1030
|
+
"type": "object"
|
|
1031
|
+
},
|
|
1032
|
+
"CreateTerminalRequest": {
|
|
1033
|
+
"description": "Request to create a new terminal and execute a command.",
|
|
1034
|
+
"properties": {
|
|
1035
|
+
"_meta": {
|
|
1036
|
+
"additionalProperties": true,
|
|
1037
|
+
"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)",
|
|
1038
|
+
"type": ["object", "null"]
|
|
1039
|
+
},
|
|
1040
|
+
"args": {
|
|
1041
|
+
"description": "Array of command arguments.",
|
|
1042
|
+
"items": {
|
|
1043
|
+
"type": "string"
|
|
1044
|
+
},
|
|
1045
|
+
"type": "array"
|
|
1046
|
+
},
|
|
1047
|
+
"command": {
|
|
1048
|
+
"description": "The command to execute.",
|
|
1049
|
+
"type": "string"
|
|
1050
|
+
},
|
|
1051
|
+
"cwd": {
|
|
1052
|
+
"description": "Working directory for the command (absolute path).",
|
|
1053
|
+
"type": ["string", "null"]
|
|
1054
|
+
},
|
|
1055
|
+
"env": {
|
|
1056
|
+
"description": "Environment variables for the command.",
|
|
1057
|
+
"items": {
|
|
1058
|
+
"$ref": "#/$defs/EnvVariable"
|
|
1059
|
+
},
|
|
1060
|
+
"type": "array"
|
|
1061
|
+
},
|
|
1062
|
+
"outputByteLimit": {
|
|
1063
|
+
"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.",
|
|
1064
|
+
"format": "uint64",
|
|
1065
|
+
"minimum": 0,
|
|
1066
|
+
"type": ["integer", "null"]
|
|
1067
|
+
},
|
|
1068
|
+
"sessionId": {
|
|
1069
|
+
"allOf": [
|
|
1070
|
+
{
|
|
1071
|
+
"$ref": "#/$defs/SessionId"
|
|
1072
|
+
}
|
|
1073
|
+
],
|
|
1074
|
+
"description": "The session ID for this request."
|
|
1075
|
+
}
|
|
1076
|
+
},
|
|
1077
|
+
"required": ["sessionId", "command"],
|
|
1078
|
+
"type": "object",
|
|
1079
|
+
"x-method": "terminal/create",
|
|
1080
|
+
"x-side": "client"
|
|
1081
|
+
},
|
|
1082
|
+
"CreateTerminalResponse": {
|
|
1083
|
+
"description": "Response containing the ID of the created terminal.",
|
|
1084
|
+
"properties": {
|
|
1085
|
+
"_meta": {
|
|
1086
|
+
"additionalProperties": true,
|
|
1087
|
+
"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)",
|
|
1088
|
+
"type": ["object", "null"]
|
|
1089
|
+
},
|
|
1090
|
+
"terminalId": {
|
|
1091
|
+
"description": "The unique identifier for the created terminal.",
|
|
1092
|
+
"type": "string"
|
|
1093
|
+
}
|
|
1094
|
+
},
|
|
1095
|
+
"required": ["terminalId"],
|
|
1096
|
+
"type": "object",
|
|
1097
|
+
"x-method": "terminal/create",
|
|
1098
|
+
"x-side": "client"
|
|
1099
|
+
},
|
|
1100
|
+
"CurrentModeUpdate": {
|
|
1101
|
+
"description": "The current mode of the session has changed\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)",
|
|
1102
|
+
"properties": {
|
|
1103
|
+
"_meta": {
|
|
1104
|
+
"additionalProperties": true,
|
|
1105
|
+
"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)",
|
|
1106
|
+
"type": ["object", "null"]
|
|
1107
|
+
},
|
|
1108
|
+
"currentModeId": {
|
|
1109
|
+
"allOf": [
|
|
1110
|
+
{
|
|
1111
|
+
"$ref": "#/$defs/SessionModeId"
|
|
1112
|
+
}
|
|
1113
|
+
],
|
|
1114
|
+
"description": "The ID of the current mode"
|
|
1115
|
+
}
|
|
1116
|
+
},
|
|
1117
|
+
"required": ["currentModeId"],
|
|
1118
|
+
"type": "object"
|
|
1119
|
+
},
|
|
1120
|
+
"Diff": {
|
|
1121
|
+
"description": "A diff representing file modifications.\n\nShows changes to files in a format suitable for display in the client UI.\n\nSee protocol docs: [Content](https://agentclientprotocol.com/protocol/tool-calls#content)",
|
|
1122
|
+
"properties": {
|
|
1123
|
+
"_meta": {
|
|
1124
|
+
"additionalProperties": true,
|
|
1125
|
+
"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)",
|
|
1126
|
+
"type": ["object", "null"]
|
|
1127
|
+
},
|
|
1128
|
+
"newText": {
|
|
1129
|
+
"description": "The new content after modification.",
|
|
1130
|
+
"type": "string"
|
|
1131
|
+
},
|
|
1132
|
+
"oldText": {
|
|
1133
|
+
"description": "The original content (None for new files).",
|
|
1134
|
+
"type": ["string", "null"]
|
|
1135
|
+
},
|
|
1136
|
+
"path": {
|
|
1137
|
+
"description": "The file path being modified.",
|
|
1138
|
+
"type": "string"
|
|
1139
|
+
}
|
|
1140
|
+
},
|
|
1141
|
+
"required": ["path", "newText"],
|
|
1142
|
+
"type": "object"
|
|
1143
|
+
},
|
|
1144
|
+
"EmbeddedResource": {
|
|
1145
|
+
"description": "The contents of a resource, embedded into a prompt or tool call result.",
|
|
1146
|
+
"properties": {
|
|
1147
|
+
"_meta": {
|
|
1148
|
+
"additionalProperties": true,
|
|
1149
|
+
"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)",
|
|
1150
|
+
"type": ["object", "null"]
|
|
1151
|
+
},
|
|
1152
|
+
"annotations": {
|
|
1153
|
+
"anyOf": [
|
|
1154
|
+
{
|
|
1155
|
+
"$ref": "#/$defs/Annotations"
|
|
1156
|
+
},
|
|
1157
|
+
{
|
|
1158
|
+
"type": "null"
|
|
1159
|
+
}
|
|
1160
|
+
]
|
|
1161
|
+
},
|
|
1162
|
+
"resource": {
|
|
1163
|
+
"$ref": "#/$defs/EmbeddedResourceResource"
|
|
1164
|
+
}
|
|
1165
|
+
},
|
|
1166
|
+
"required": ["resource"],
|
|
1167
|
+
"type": "object"
|
|
1168
|
+
},
|
|
1169
|
+
"EmbeddedResourceResource": {
|
|
1170
|
+
"anyOf": [
|
|
1171
|
+
{
|
|
1172
|
+
"allOf": [
|
|
1173
|
+
{
|
|
1174
|
+
"$ref": "#/$defs/TextResourceContents"
|
|
1175
|
+
}
|
|
1176
|
+
],
|
|
1177
|
+
"title": "TextResourceContents"
|
|
1178
|
+
},
|
|
1179
|
+
{
|
|
1180
|
+
"allOf": [
|
|
1181
|
+
{
|
|
1182
|
+
"$ref": "#/$defs/BlobResourceContents"
|
|
1183
|
+
}
|
|
1184
|
+
],
|
|
1185
|
+
"title": "BlobResourceContents"
|
|
1186
|
+
}
|
|
1187
|
+
],
|
|
1188
|
+
"description": "Resource content that can be embedded in a message."
|
|
1189
|
+
},
|
|
1190
|
+
"EnvVariable": {
|
|
1191
|
+
"description": "An environment variable to set when launching an MCP server.",
|
|
1192
|
+
"properties": {
|
|
1193
|
+
"_meta": {
|
|
1194
|
+
"additionalProperties": true,
|
|
1195
|
+
"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)",
|
|
1196
|
+
"type": ["object", "null"]
|
|
1197
|
+
},
|
|
1198
|
+
"name": {
|
|
1199
|
+
"description": "The name of the environment variable.",
|
|
1200
|
+
"type": "string"
|
|
1201
|
+
},
|
|
1202
|
+
"value": {
|
|
1203
|
+
"description": "The value to set for the environment variable.",
|
|
1204
|
+
"type": "string"
|
|
1205
|
+
}
|
|
1206
|
+
},
|
|
1207
|
+
"required": ["name", "value"],
|
|
1208
|
+
"type": "object"
|
|
1209
|
+
},
|
|
1210
|
+
"Error": {
|
|
1211
|
+
"description": "JSON-RPC error object.\n\nRepresents an error that occurred during method execution, following the\nJSON-RPC 2.0 error object specification with optional additional data.\n\nSee protocol docs: [JSON-RPC Error Object](https://www.jsonrpc.org/specification#error_object)",
|
|
1212
|
+
"properties": {
|
|
1213
|
+
"code": {
|
|
1214
|
+
"allOf": [
|
|
1215
|
+
{
|
|
1216
|
+
"$ref": "#/$defs/ErrorCode"
|
|
1217
|
+
}
|
|
1218
|
+
],
|
|
1219
|
+
"description": "A number indicating the error type that occurred.\nThis must be an integer as defined in the JSON-RPC specification."
|
|
1220
|
+
},
|
|
1221
|
+
"data": {
|
|
1222
|
+
"description": "Optional primitive or structured value that contains additional information about the error.\nThis may include debugging information or context-specific details."
|
|
1223
|
+
},
|
|
1224
|
+
"message": {
|
|
1225
|
+
"description": "A string providing a short description of the error.\nThe message should be limited to a concise single sentence.",
|
|
1226
|
+
"type": "string"
|
|
1227
|
+
}
|
|
1228
|
+
},
|
|
1229
|
+
"required": ["code", "message"],
|
|
1230
|
+
"type": "object"
|
|
1231
|
+
},
|
|
1232
|
+
"ErrorCode": {
|
|
1233
|
+
"anyOf": [
|
|
1234
|
+
{
|
|
1235
|
+
"const": -32700,
|
|
1236
|
+
"description": "**Parse error**: Invalid JSON was received by the server.\nAn error occurred on the server while parsing the JSON text.",
|
|
1237
|
+
"format": "int32",
|
|
1238
|
+
"title": "Parse error",
|
|
1239
|
+
"type": "integer"
|
|
1240
|
+
},
|
|
1241
|
+
{
|
|
1242
|
+
"const": -32600,
|
|
1243
|
+
"description": "**Invalid request**: The JSON sent is not a valid Request object.",
|
|
1244
|
+
"format": "int32",
|
|
1245
|
+
"title": "Invalid request",
|
|
1246
|
+
"type": "integer"
|
|
1247
|
+
},
|
|
1248
|
+
{
|
|
1249
|
+
"const": -32601,
|
|
1250
|
+
"description": "**Method not found**: The method does not exist or is not available.",
|
|
1251
|
+
"format": "int32",
|
|
1252
|
+
"title": "Method not found",
|
|
1253
|
+
"type": "integer"
|
|
1254
|
+
},
|
|
1255
|
+
{
|
|
1256
|
+
"const": -32602,
|
|
1257
|
+
"description": "**Invalid params**: Invalid method parameter(s).",
|
|
1258
|
+
"format": "int32",
|
|
1259
|
+
"title": "Invalid params",
|
|
1260
|
+
"type": "integer"
|
|
1261
|
+
},
|
|
1262
|
+
{
|
|
1263
|
+
"const": -32603,
|
|
1264
|
+
"description": "**Internal error**: Internal JSON-RPC error.\nReserved for implementation-defined server errors.",
|
|
1265
|
+
"format": "int32",
|
|
1266
|
+
"title": "Internal error",
|
|
1267
|
+
"type": "integer"
|
|
1268
|
+
},
|
|
1269
|
+
{
|
|
1270
|
+
"const": -32800,
|
|
1271
|
+
"description": "**Request cancelled**: **UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nExecution of the method was aborted either due to a cancellation request from the caller or\nbecause of resource constraints or shutdown.",
|
|
1272
|
+
"format": "int32",
|
|
1273
|
+
"title": "Request cancelled",
|
|
1274
|
+
"type": "integer"
|
|
1275
|
+
},
|
|
1276
|
+
{
|
|
1277
|
+
"const": -32000,
|
|
1278
|
+
"description": "**Authentication required**: Authentication is required before this operation can be performed.",
|
|
1279
|
+
"format": "int32",
|
|
1280
|
+
"title": "Authentication required",
|
|
1281
|
+
"type": "integer"
|
|
1282
|
+
},
|
|
1283
|
+
{
|
|
1284
|
+
"const": -32002,
|
|
1285
|
+
"description": "**Resource not found**: A given resource, such as a file, was not found.",
|
|
1286
|
+
"format": "int32",
|
|
1287
|
+
"title": "Resource not found",
|
|
1288
|
+
"type": "integer"
|
|
1289
|
+
},
|
|
1290
|
+
{
|
|
1291
|
+
"description": "Other undefined error code.",
|
|
1292
|
+
"format": "int32",
|
|
1293
|
+
"title": "Other",
|
|
1294
|
+
"type": "integer"
|
|
1295
|
+
}
|
|
1296
|
+
],
|
|
1297
|
+
"description": "Predefined error codes for common JSON-RPC and ACP-specific errors.\n\nThese codes follow the JSON-RPC 2.0 specification for standard errors\nand use the reserved range (-32000 to -32099) for protocol-specific errors."
|
|
1298
|
+
},
|
|
1299
|
+
"ExtNotification": {
|
|
1300
|
+
"description": "Allows 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)"
|
|
1301
|
+
},
|
|
1302
|
+
"ExtRequest": {
|
|
1303
|
+
"description": "Allows for sending 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)"
|
|
1304
|
+
},
|
|
1305
|
+
"ExtResponse": {
|
|
1306
|
+
"description": "Allows for sending an arbitrary response to an [`ExtRequest`] 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)"
|
|
1307
|
+
},
|
|
1308
|
+
"FileSystemCapability": {
|
|
1309
|
+
"description": "Filesystem capabilities supported by the client.\nFile system capabilities that a client may support.\n\nSee protocol docs: [FileSystem](https://agentclientprotocol.com/protocol/initialization#filesystem)",
|
|
1310
|
+
"properties": {
|
|
1311
|
+
"_meta": {
|
|
1312
|
+
"additionalProperties": true,
|
|
1313
|
+
"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)",
|
|
1314
|
+
"type": ["object", "null"]
|
|
1315
|
+
},
|
|
1316
|
+
"readTextFile": {
|
|
1317
|
+
"default": false,
|
|
1318
|
+
"description": "Whether the Client supports `fs/read_text_file` requests.",
|
|
1319
|
+
"type": "boolean"
|
|
1320
|
+
},
|
|
1321
|
+
"writeTextFile": {
|
|
1322
|
+
"default": false,
|
|
1323
|
+
"description": "Whether the Client supports `fs/write_text_file` requests.",
|
|
1324
|
+
"type": "boolean"
|
|
1325
|
+
}
|
|
1326
|
+
},
|
|
1327
|
+
"type": "object"
|
|
1328
|
+
},
|
|
1329
|
+
"ForkSessionRequest": {
|
|
1330
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nRequest parameters for forking an existing session.\n\nCreates a new session based on the context of an existing one, allowing\noperations like generating summaries without affecting the original session's history.\n\nOnly available if the Agent supports the `session.fork` capability.",
|
|
1331
|
+
"properties": {
|
|
1332
|
+
"_meta": {
|
|
1333
|
+
"additionalProperties": true,
|
|
1334
|
+
"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)",
|
|
1335
|
+
"type": ["object", "null"]
|
|
1336
|
+
},
|
|
1337
|
+
"cwd": {
|
|
1338
|
+
"description": "The working directory for this session.",
|
|
1339
|
+
"type": "string"
|
|
1340
|
+
},
|
|
1341
|
+
"mcpServers": {
|
|
1342
|
+
"description": "List of MCP servers to connect to for this session.",
|
|
1343
|
+
"items": {
|
|
1344
|
+
"$ref": "#/$defs/McpServer"
|
|
1345
|
+
},
|
|
1346
|
+
"type": "array"
|
|
1347
|
+
},
|
|
1348
|
+
"sessionId": {
|
|
1349
|
+
"allOf": [
|
|
1350
|
+
{
|
|
1351
|
+
"$ref": "#/$defs/SessionId"
|
|
1352
|
+
}
|
|
1353
|
+
],
|
|
1354
|
+
"description": "The ID of the session to fork."
|
|
1355
|
+
}
|
|
1356
|
+
},
|
|
1357
|
+
"required": ["sessionId", "cwd"],
|
|
1358
|
+
"type": "object",
|
|
1359
|
+
"x-method": "session/fork",
|
|
1360
|
+
"x-side": "agent"
|
|
1361
|
+
},
|
|
1362
|
+
"ForkSessionResponse": {
|
|
1363
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nResponse from forking an existing session.",
|
|
1364
|
+
"properties": {
|
|
1365
|
+
"_meta": {
|
|
1366
|
+
"additionalProperties": true,
|
|
1367
|
+
"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)",
|
|
1368
|
+
"type": ["object", "null"]
|
|
1369
|
+
},
|
|
1370
|
+
"configOptions": {
|
|
1371
|
+
"description": "Initial session configuration options if supported by the Agent.",
|
|
1372
|
+
"items": {
|
|
1373
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
1374
|
+
},
|
|
1375
|
+
"type": ["array", "null"]
|
|
1376
|
+
},
|
|
1377
|
+
"models": {
|
|
1378
|
+
"anyOf": [
|
|
1379
|
+
{
|
|
1380
|
+
"$ref": "#/$defs/SessionModelState"
|
|
1381
|
+
},
|
|
1382
|
+
{
|
|
1383
|
+
"type": "null"
|
|
1384
|
+
}
|
|
1385
|
+
],
|
|
1386
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInitial model state if supported by the Agent"
|
|
1387
|
+
},
|
|
1388
|
+
"modes": {
|
|
1389
|
+
"anyOf": [
|
|
1390
|
+
{
|
|
1391
|
+
"$ref": "#/$defs/SessionModeState"
|
|
1392
|
+
},
|
|
1393
|
+
{
|
|
1394
|
+
"type": "null"
|
|
1395
|
+
}
|
|
1396
|
+
],
|
|
1397
|
+
"description": "Initial mode state if supported by the Agent\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)"
|
|
1398
|
+
},
|
|
1399
|
+
"sessionId": {
|
|
1400
|
+
"allOf": [
|
|
1401
|
+
{
|
|
1402
|
+
"$ref": "#/$defs/SessionId"
|
|
1403
|
+
}
|
|
1404
|
+
],
|
|
1405
|
+
"description": "Unique identifier for the newly created forked session."
|
|
1406
|
+
}
|
|
1407
|
+
},
|
|
1408
|
+
"required": ["sessionId"],
|
|
1409
|
+
"type": "object",
|
|
1410
|
+
"x-method": "session/fork",
|
|
1411
|
+
"x-side": "agent"
|
|
1412
|
+
},
|
|
1413
|
+
"HttpHeader": {
|
|
1414
|
+
"description": "An HTTP header to set when making requests to the MCP server.",
|
|
1415
|
+
"properties": {
|
|
1416
|
+
"_meta": {
|
|
1417
|
+
"additionalProperties": true,
|
|
1418
|
+
"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)",
|
|
1419
|
+
"type": ["object", "null"]
|
|
1420
|
+
},
|
|
1421
|
+
"name": {
|
|
1422
|
+
"description": "The name of the HTTP header.",
|
|
1423
|
+
"type": "string"
|
|
1424
|
+
},
|
|
1425
|
+
"value": {
|
|
1426
|
+
"description": "The value to set for the HTTP header.",
|
|
1427
|
+
"type": "string"
|
|
1428
|
+
}
|
|
1429
|
+
},
|
|
1430
|
+
"required": ["name", "value"],
|
|
1431
|
+
"type": "object"
|
|
1432
|
+
},
|
|
1433
|
+
"ImageContent": {
|
|
1434
|
+
"description": "An image provided to or from an LLM.",
|
|
1435
|
+
"properties": {
|
|
1436
|
+
"_meta": {
|
|
1437
|
+
"additionalProperties": true,
|
|
1438
|
+
"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)",
|
|
1439
|
+
"type": ["object", "null"]
|
|
1440
|
+
},
|
|
1441
|
+
"annotations": {
|
|
1442
|
+
"anyOf": [
|
|
1443
|
+
{
|
|
1444
|
+
"$ref": "#/$defs/Annotations"
|
|
1445
|
+
},
|
|
1446
|
+
{
|
|
1447
|
+
"type": "null"
|
|
1448
|
+
}
|
|
1449
|
+
]
|
|
1450
|
+
},
|
|
1451
|
+
"data": {
|
|
1452
|
+
"type": "string"
|
|
1453
|
+
},
|
|
1454
|
+
"mimeType": {
|
|
1455
|
+
"type": "string"
|
|
1456
|
+
},
|
|
1457
|
+
"uri": {
|
|
1458
|
+
"type": ["string", "null"]
|
|
1459
|
+
}
|
|
1460
|
+
},
|
|
1461
|
+
"required": ["data", "mimeType"],
|
|
1462
|
+
"type": "object"
|
|
1463
|
+
},
|
|
1464
|
+
"Implementation": {
|
|
1465
|
+
"description": "Metadata about the implementation of the client or agent.\nDescribes the name and version of an MCP implementation, with an optional\ntitle for UI representation.",
|
|
1466
|
+
"properties": {
|
|
1467
|
+
"_meta": {
|
|
1468
|
+
"additionalProperties": true,
|
|
1469
|
+
"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)",
|
|
1470
|
+
"type": ["object", "null"]
|
|
1471
|
+
},
|
|
1472
|
+
"name": {
|
|
1473
|
+
"description": "Intended for programmatic or logical use, but can be used as a display\nname fallback if title isn’t present.",
|
|
1474
|
+
"type": "string"
|
|
1475
|
+
},
|
|
1476
|
+
"title": {
|
|
1477
|
+
"description": "Intended for UI and end-user contexts — optimized to be human-readable\nand easily understood.\n\nIf not provided, the name should be used for display.",
|
|
1478
|
+
"type": ["string", "null"]
|
|
1479
|
+
},
|
|
1480
|
+
"version": {
|
|
1481
|
+
"description": "Version of the implementation. Can be displayed to the user or used\nfor debugging or metrics purposes. (e.g. \"1.0.0\").",
|
|
1482
|
+
"type": "string"
|
|
1483
|
+
}
|
|
1484
|
+
},
|
|
1485
|
+
"required": ["name", "version"],
|
|
1486
|
+
"type": "object"
|
|
1487
|
+
},
|
|
1488
|
+
"InitializeRequest": {
|
|
1489
|
+
"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)",
|
|
1490
|
+
"properties": {
|
|
1491
|
+
"_meta": {
|
|
1492
|
+
"additionalProperties": true,
|
|
1493
|
+
"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)",
|
|
1494
|
+
"type": ["object", "null"]
|
|
1495
|
+
},
|
|
1496
|
+
"clientCapabilities": {
|
|
1497
|
+
"allOf": [
|
|
1498
|
+
{
|
|
1499
|
+
"$ref": "#/$defs/ClientCapabilities"
|
|
1500
|
+
}
|
|
1501
|
+
],
|
|
1502
|
+
"default": {
|
|
1503
|
+
"fs": {
|
|
1504
|
+
"readTextFile": false,
|
|
1505
|
+
"writeTextFile": false
|
|
1506
|
+
},
|
|
1507
|
+
"terminal": false
|
|
1508
|
+
},
|
|
1509
|
+
"description": "Capabilities supported by the client."
|
|
1510
|
+
},
|
|
1511
|
+
"clientInfo": {
|
|
1512
|
+
"anyOf": [
|
|
1513
|
+
{
|
|
1514
|
+
"$ref": "#/$defs/Implementation"
|
|
1515
|
+
},
|
|
1516
|
+
{
|
|
1517
|
+
"type": "null"
|
|
1518
|
+
}
|
|
1519
|
+
],
|
|
1520
|
+
"description": "Information about the Client name and version sent to the Agent.\n\nNote: in future versions of the protocol, this will be required."
|
|
1521
|
+
},
|
|
1522
|
+
"protocolVersion": {
|
|
1523
|
+
"allOf": [
|
|
1524
|
+
{
|
|
1525
|
+
"$ref": "#/$defs/ProtocolVersion"
|
|
1526
|
+
}
|
|
1527
|
+
],
|
|
1528
|
+
"description": "The latest protocol version supported by the client."
|
|
1529
|
+
}
|
|
1530
|
+
},
|
|
1531
|
+
"required": ["protocolVersion"],
|
|
1532
|
+
"type": "object",
|
|
1533
|
+
"x-method": "initialize",
|
|
1534
|
+
"x-side": "agent"
|
|
1535
|
+
},
|
|
1536
|
+
"InitializeResponse": {
|
|
1537
|
+
"description": "Response to the `initialize` method.\n\nContains the negotiated protocol version and agent capabilities.\n\nSee protocol docs: [Initialization](https://agentclientprotocol.com/protocol/initialization)",
|
|
1538
|
+
"properties": {
|
|
1539
|
+
"_meta": {
|
|
1540
|
+
"additionalProperties": true,
|
|
1541
|
+
"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)",
|
|
1542
|
+
"type": ["object", "null"]
|
|
1543
|
+
},
|
|
1544
|
+
"agentCapabilities": {
|
|
1545
|
+
"allOf": [
|
|
1546
|
+
{
|
|
1547
|
+
"$ref": "#/$defs/AgentCapabilities"
|
|
1548
|
+
}
|
|
1549
|
+
],
|
|
1550
|
+
"default": {
|
|
1551
|
+
"loadSession": false,
|
|
1552
|
+
"mcpCapabilities": {
|
|
1553
|
+
"http": false,
|
|
1554
|
+
"sse": false
|
|
1555
|
+
},
|
|
1556
|
+
"promptCapabilities": {
|
|
1557
|
+
"audio": false,
|
|
1558
|
+
"embeddedContext": false,
|
|
1559
|
+
"image": false
|
|
1560
|
+
},
|
|
1561
|
+
"sessionCapabilities": {}
|
|
1562
|
+
},
|
|
1563
|
+
"description": "Capabilities supported by the agent."
|
|
1564
|
+
},
|
|
1565
|
+
"agentInfo": {
|
|
1566
|
+
"anyOf": [
|
|
1567
|
+
{
|
|
1568
|
+
"$ref": "#/$defs/Implementation"
|
|
1569
|
+
},
|
|
1570
|
+
{
|
|
1571
|
+
"type": "null"
|
|
1572
|
+
}
|
|
1573
|
+
],
|
|
1574
|
+
"description": "Information about the Agent name and version sent to the Client.\n\nNote: in future versions of the protocol, this will be required."
|
|
1575
|
+
},
|
|
1576
|
+
"authMethods": {
|
|
1577
|
+
"default": [],
|
|
1578
|
+
"description": "Authentication methods supported by the agent.",
|
|
1579
|
+
"items": {
|
|
1580
|
+
"$ref": "#/$defs/AuthMethod"
|
|
1581
|
+
},
|
|
1582
|
+
"type": "array"
|
|
1583
|
+
},
|
|
1584
|
+
"protocolVersion": {
|
|
1585
|
+
"allOf": [
|
|
1586
|
+
{
|
|
1587
|
+
"$ref": "#/$defs/ProtocolVersion"
|
|
1588
|
+
}
|
|
1589
|
+
],
|
|
1590
|
+
"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."
|
|
1591
|
+
}
|
|
1592
|
+
},
|
|
1593
|
+
"required": ["protocolVersion"],
|
|
1594
|
+
"type": "object",
|
|
1595
|
+
"x-method": "initialize",
|
|
1596
|
+
"x-side": "agent"
|
|
1597
|
+
},
|
|
1598
|
+
"KillTerminalCommandRequest": {
|
|
1599
|
+
"description": "Request to kill a terminal command without releasing the terminal.",
|
|
1600
|
+
"properties": {
|
|
1601
|
+
"_meta": {
|
|
1602
|
+
"additionalProperties": true,
|
|
1603
|
+
"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)",
|
|
1604
|
+
"type": ["object", "null"]
|
|
1605
|
+
},
|
|
1606
|
+
"sessionId": {
|
|
1607
|
+
"allOf": [
|
|
1608
|
+
{
|
|
1609
|
+
"$ref": "#/$defs/SessionId"
|
|
1610
|
+
}
|
|
1611
|
+
],
|
|
1612
|
+
"description": "The session ID for this request."
|
|
1613
|
+
},
|
|
1614
|
+
"terminalId": {
|
|
1615
|
+
"description": "The ID of the terminal to kill.",
|
|
1616
|
+
"type": "string"
|
|
1617
|
+
}
|
|
1618
|
+
},
|
|
1619
|
+
"required": ["sessionId", "terminalId"],
|
|
1620
|
+
"type": "object",
|
|
1621
|
+
"x-method": "terminal/kill",
|
|
1622
|
+
"x-side": "client"
|
|
1623
|
+
},
|
|
1624
|
+
"KillTerminalCommandResponse": {
|
|
1625
|
+
"description": "Response to terminal/kill command method",
|
|
1626
|
+
"properties": {
|
|
1627
|
+
"_meta": {
|
|
1628
|
+
"additionalProperties": true,
|
|
1629
|
+
"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)",
|
|
1630
|
+
"type": ["object", "null"]
|
|
1631
|
+
}
|
|
1632
|
+
},
|
|
1633
|
+
"type": "object",
|
|
1634
|
+
"x-method": "terminal/kill",
|
|
1635
|
+
"x-side": "client"
|
|
1636
|
+
},
|
|
1637
|
+
"ListSessionsRequest": {
|
|
1638
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nRequest parameters for listing existing sessions.\n\nOnly available if the Agent supports the `listSessions` capability.",
|
|
1639
|
+
"properties": {
|
|
1640
|
+
"_meta": {
|
|
1641
|
+
"additionalProperties": true,
|
|
1642
|
+
"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)",
|
|
1643
|
+
"type": ["object", "null"]
|
|
1644
|
+
},
|
|
1645
|
+
"cursor": {
|
|
1646
|
+
"description": "Opaque cursor token from a previous response's nextCursor field for cursor-based pagination",
|
|
1647
|
+
"type": ["string", "null"]
|
|
1648
|
+
},
|
|
1649
|
+
"cwd": {
|
|
1650
|
+
"description": "Filter sessions by working directory. Must be an absolute path.",
|
|
1651
|
+
"type": ["string", "null"]
|
|
1652
|
+
}
|
|
1653
|
+
},
|
|
1654
|
+
"type": "object",
|
|
1655
|
+
"x-method": "session/list",
|
|
1656
|
+
"x-side": "agent"
|
|
1657
|
+
},
|
|
1658
|
+
"ListSessionsResponse": {
|
|
1659
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nResponse from listing sessions.",
|
|
1660
|
+
"properties": {
|
|
1661
|
+
"_meta": {
|
|
1662
|
+
"additionalProperties": true,
|
|
1663
|
+
"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)",
|
|
1664
|
+
"type": ["object", "null"]
|
|
1665
|
+
},
|
|
1666
|
+
"nextCursor": {
|
|
1667
|
+
"description": "Opaque cursor token. If present, pass this in the next request's cursor parameter\nto fetch the next page. If absent, there are no more results.",
|
|
1668
|
+
"type": ["string", "null"]
|
|
1669
|
+
},
|
|
1670
|
+
"sessions": {
|
|
1671
|
+
"description": "Array of session information objects",
|
|
1672
|
+
"items": {
|
|
1673
|
+
"$ref": "#/$defs/SessionInfo"
|
|
1674
|
+
},
|
|
1675
|
+
"type": "array"
|
|
1676
|
+
}
|
|
1677
|
+
},
|
|
1678
|
+
"required": ["sessions"],
|
|
1679
|
+
"type": "object",
|
|
1680
|
+
"x-method": "session/list",
|
|
1681
|
+
"x-side": "agent"
|
|
1682
|
+
},
|
|
1683
|
+
"LoadSessionRequest": {
|
|
1684
|
+
"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)",
|
|
1685
|
+
"properties": {
|
|
1686
|
+
"_meta": {
|
|
1687
|
+
"additionalProperties": true,
|
|
1688
|
+
"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)",
|
|
1689
|
+
"type": ["object", "null"]
|
|
1690
|
+
},
|
|
1691
|
+
"cwd": {
|
|
1692
|
+
"description": "The working directory for this session.",
|
|
1693
|
+
"type": "string"
|
|
1694
|
+
},
|
|
1695
|
+
"mcpServers": {
|
|
1696
|
+
"description": "List of MCP servers to connect to for this session.",
|
|
1697
|
+
"items": {
|
|
1698
|
+
"$ref": "#/$defs/McpServer"
|
|
1699
|
+
},
|
|
1700
|
+
"type": "array"
|
|
1701
|
+
},
|
|
1702
|
+
"sessionId": {
|
|
1703
|
+
"allOf": [
|
|
1704
|
+
{
|
|
1705
|
+
"$ref": "#/$defs/SessionId"
|
|
1706
|
+
}
|
|
1707
|
+
],
|
|
1708
|
+
"description": "The ID of the session to load."
|
|
1709
|
+
}
|
|
1710
|
+
},
|
|
1711
|
+
"required": ["mcpServers", "cwd", "sessionId"],
|
|
1712
|
+
"type": "object",
|
|
1713
|
+
"x-method": "session/load",
|
|
1714
|
+
"x-side": "agent"
|
|
1715
|
+
},
|
|
1716
|
+
"LoadSessionResponse": {
|
|
1717
|
+
"description": "Response from loading an existing session.",
|
|
1718
|
+
"properties": {
|
|
1719
|
+
"_meta": {
|
|
1720
|
+
"additionalProperties": true,
|
|
1721
|
+
"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)",
|
|
1722
|
+
"type": ["object", "null"]
|
|
1723
|
+
},
|
|
1724
|
+
"configOptions": {
|
|
1725
|
+
"description": "Initial session configuration options if supported by the Agent.",
|
|
1726
|
+
"items": {
|
|
1727
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
1728
|
+
},
|
|
1729
|
+
"type": ["array", "null"]
|
|
1730
|
+
},
|
|
1731
|
+
"models": {
|
|
1732
|
+
"anyOf": [
|
|
1733
|
+
{
|
|
1734
|
+
"$ref": "#/$defs/SessionModelState"
|
|
1735
|
+
},
|
|
1736
|
+
{
|
|
1737
|
+
"type": "null"
|
|
1738
|
+
}
|
|
1739
|
+
],
|
|
1740
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInitial model state if supported by the Agent"
|
|
1741
|
+
},
|
|
1742
|
+
"modes": {
|
|
1743
|
+
"anyOf": [
|
|
1744
|
+
{
|
|
1745
|
+
"$ref": "#/$defs/SessionModeState"
|
|
1746
|
+
},
|
|
1747
|
+
{
|
|
1748
|
+
"type": "null"
|
|
1749
|
+
}
|
|
1750
|
+
],
|
|
1751
|
+
"description": "Initial mode state if supported by the Agent\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)"
|
|
1752
|
+
}
|
|
1753
|
+
},
|
|
1754
|
+
"type": "object",
|
|
1755
|
+
"x-method": "session/load",
|
|
1756
|
+
"x-side": "agent"
|
|
1757
|
+
},
|
|
1758
|
+
"McpCapabilities": {
|
|
1759
|
+
"description": "MCP capabilities supported by the agent",
|
|
1760
|
+
"properties": {
|
|
1761
|
+
"_meta": {
|
|
1762
|
+
"additionalProperties": true,
|
|
1763
|
+
"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)",
|
|
1764
|
+
"type": ["object", "null"]
|
|
1765
|
+
},
|
|
1766
|
+
"http": {
|
|
1767
|
+
"default": false,
|
|
1768
|
+
"description": "Agent supports [`McpServer::Http`].",
|
|
1769
|
+
"type": "boolean"
|
|
1770
|
+
},
|
|
1771
|
+
"sse": {
|
|
1772
|
+
"default": false,
|
|
1773
|
+
"description": "Agent supports [`McpServer::Sse`].",
|
|
1774
|
+
"type": "boolean"
|
|
1775
|
+
}
|
|
1776
|
+
},
|
|
1777
|
+
"type": "object"
|
|
1778
|
+
},
|
|
1779
|
+
"McpServer": {
|
|
1780
|
+
"anyOf": [
|
|
1781
|
+
{
|
|
1782
|
+
"allOf": [
|
|
1783
|
+
{
|
|
1784
|
+
"$ref": "#/$defs/McpServerHttp"
|
|
1785
|
+
}
|
|
1786
|
+
],
|
|
1787
|
+
"description": "HTTP transport configuration\n\nOnly available when the Agent capabilities indicate `mcp_capabilities.http` is `true`.",
|
|
1788
|
+
"properties": {
|
|
1789
|
+
"type": {
|
|
1790
|
+
"const": "http",
|
|
1791
|
+
"type": "string"
|
|
1792
|
+
}
|
|
1793
|
+
},
|
|
1794
|
+
"required": ["type"],
|
|
1795
|
+
"type": "object"
|
|
1796
|
+
},
|
|
1797
|
+
{
|
|
1798
|
+
"allOf": [
|
|
1799
|
+
{
|
|
1800
|
+
"$ref": "#/$defs/McpServerSse"
|
|
1801
|
+
}
|
|
1802
|
+
],
|
|
1803
|
+
"description": "SSE transport configuration\n\nOnly available when the Agent capabilities indicate `mcp_capabilities.sse` is `true`.",
|
|
1804
|
+
"properties": {
|
|
1805
|
+
"type": {
|
|
1806
|
+
"const": "sse",
|
|
1807
|
+
"type": "string"
|
|
1808
|
+
}
|
|
1809
|
+
},
|
|
1810
|
+
"required": ["type"],
|
|
1811
|
+
"type": "object"
|
|
1812
|
+
},
|
|
1813
|
+
{
|
|
1814
|
+
"allOf": [
|
|
1815
|
+
{
|
|
1816
|
+
"$ref": "#/$defs/McpServerStdio"
|
|
1817
|
+
}
|
|
1818
|
+
],
|
|
1819
|
+
"description": "Stdio transport configuration\n\nAll Agents MUST support this transport.",
|
|
1820
|
+
"title": "stdio"
|
|
1821
|
+
}
|
|
1822
|
+
],
|
|
1823
|
+
"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)"
|
|
1824
|
+
},
|
|
1825
|
+
"McpServerHttp": {
|
|
1826
|
+
"description": "HTTP transport configuration for MCP.",
|
|
1827
|
+
"properties": {
|
|
1828
|
+
"_meta": {
|
|
1829
|
+
"additionalProperties": true,
|
|
1830
|
+
"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)",
|
|
1831
|
+
"type": ["object", "null"]
|
|
1832
|
+
},
|
|
1833
|
+
"headers": {
|
|
1834
|
+
"description": "HTTP headers to set when making requests to the MCP server.",
|
|
1835
|
+
"items": {
|
|
1836
|
+
"$ref": "#/$defs/HttpHeader"
|
|
1837
|
+
},
|
|
1838
|
+
"type": "array"
|
|
1839
|
+
},
|
|
1840
|
+
"name": {
|
|
1841
|
+
"description": "Human-readable name identifying this MCP server.",
|
|
1842
|
+
"type": "string"
|
|
1843
|
+
},
|
|
1844
|
+
"url": {
|
|
1845
|
+
"description": "URL to the MCP server.",
|
|
1846
|
+
"type": "string"
|
|
1847
|
+
}
|
|
1848
|
+
},
|
|
1849
|
+
"required": ["name", "url", "headers"],
|
|
1850
|
+
"type": "object"
|
|
1851
|
+
},
|
|
1852
|
+
"McpServerSse": {
|
|
1853
|
+
"description": "SSE transport configuration for MCP.",
|
|
1854
|
+
"properties": {
|
|
1855
|
+
"_meta": {
|
|
1856
|
+
"additionalProperties": true,
|
|
1857
|
+
"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)",
|
|
1858
|
+
"type": ["object", "null"]
|
|
1859
|
+
},
|
|
1860
|
+
"headers": {
|
|
1861
|
+
"description": "HTTP headers to set when making requests to the MCP server.",
|
|
1862
|
+
"items": {
|
|
1863
|
+
"$ref": "#/$defs/HttpHeader"
|
|
1864
|
+
},
|
|
1865
|
+
"type": "array"
|
|
1866
|
+
},
|
|
1867
|
+
"name": {
|
|
1868
|
+
"description": "Human-readable name identifying this MCP server.",
|
|
1869
|
+
"type": "string"
|
|
1870
|
+
},
|
|
1871
|
+
"url": {
|
|
1872
|
+
"description": "URL to the MCP server.",
|
|
1873
|
+
"type": "string"
|
|
1874
|
+
}
|
|
1875
|
+
},
|
|
1876
|
+
"required": ["name", "url", "headers"],
|
|
1877
|
+
"type": "object"
|
|
1878
|
+
},
|
|
1879
|
+
"McpServerStdio": {
|
|
1880
|
+
"description": "Stdio transport configuration for MCP.",
|
|
1881
|
+
"properties": {
|
|
1882
|
+
"_meta": {
|
|
1883
|
+
"additionalProperties": true,
|
|
1884
|
+
"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)",
|
|
1885
|
+
"type": ["object", "null"]
|
|
1886
|
+
},
|
|
1887
|
+
"args": {
|
|
1888
|
+
"description": "Command-line arguments to pass to the MCP server.",
|
|
1889
|
+
"items": {
|
|
1890
|
+
"type": "string"
|
|
1891
|
+
},
|
|
1892
|
+
"type": "array"
|
|
1893
|
+
},
|
|
1894
|
+
"command": {
|
|
1895
|
+
"description": "Path to the MCP server executable.",
|
|
1896
|
+
"type": "string"
|
|
1897
|
+
},
|
|
1898
|
+
"env": {
|
|
1899
|
+
"description": "Environment variables to set when launching the MCP server.",
|
|
1900
|
+
"items": {
|
|
1901
|
+
"$ref": "#/$defs/EnvVariable"
|
|
1902
|
+
},
|
|
1903
|
+
"type": "array"
|
|
1904
|
+
},
|
|
1905
|
+
"name": {
|
|
1906
|
+
"description": "Human-readable name identifying this MCP server.",
|
|
1907
|
+
"type": "string"
|
|
1908
|
+
}
|
|
1909
|
+
},
|
|
1910
|
+
"required": ["name", "command", "args", "env"],
|
|
1911
|
+
"type": "object"
|
|
1912
|
+
},
|
|
1913
|
+
"ModelId": {
|
|
1914
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nA unique identifier for a model.",
|
|
1915
|
+
"type": "string"
|
|
1916
|
+
},
|
|
1917
|
+
"ModelInfo": {
|
|
1918
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInformation about a selectable model.",
|
|
1919
|
+
"properties": {
|
|
1920
|
+
"_meta": {
|
|
1921
|
+
"additionalProperties": true,
|
|
1922
|
+
"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)",
|
|
1923
|
+
"type": ["object", "null"]
|
|
1924
|
+
},
|
|
1925
|
+
"description": {
|
|
1926
|
+
"description": "Optional description of the model.",
|
|
1927
|
+
"type": ["string", "null"]
|
|
1928
|
+
},
|
|
1929
|
+
"modelId": {
|
|
1930
|
+
"allOf": [
|
|
1931
|
+
{
|
|
1932
|
+
"$ref": "#/$defs/ModelId"
|
|
1933
|
+
}
|
|
1934
|
+
],
|
|
1935
|
+
"description": "Unique identifier for the model."
|
|
1936
|
+
},
|
|
1937
|
+
"name": {
|
|
1938
|
+
"description": "Human-readable name of the model.",
|
|
1939
|
+
"type": "string"
|
|
1940
|
+
}
|
|
1941
|
+
},
|
|
1942
|
+
"required": ["modelId", "name"],
|
|
1943
|
+
"type": "object"
|
|
1944
|
+
},
|
|
1945
|
+
"NewSessionRequest": {
|
|
1946
|
+
"description": "Request parameters for creating a new session.\n\nSee protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)",
|
|
1947
|
+
"properties": {
|
|
1948
|
+
"_meta": {
|
|
1949
|
+
"additionalProperties": true,
|
|
1950
|
+
"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)",
|
|
1951
|
+
"type": ["object", "null"]
|
|
1952
|
+
},
|
|
1953
|
+
"cwd": {
|
|
1954
|
+
"description": "The working directory for this session. Must be an absolute path.",
|
|
1955
|
+
"type": "string"
|
|
1956
|
+
},
|
|
1957
|
+
"mcpServers": {
|
|
1958
|
+
"description": "List of MCP (Model Context Protocol) servers the agent should connect to.",
|
|
1959
|
+
"items": {
|
|
1960
|
+
"$ref": "#/$defs/McpServer"
|
|
1961
|
+
},
|
|
1962
|
+
"type": "array"
|
|
1963
|
+
}
|
|
1964
|
+
},
|
|
1965
|
+
"required": ["cwd", "mcpServers"],
|
|
1966
|
+
"type": "object",
|
|
1967
|
+
"x-method": "session/new",
|
|
1968
|
+
"x-side": "agent"
|
|
1969
|
+
},
|
|
1970
|
+
"NewSessionResponse": {
|
|
1971
|
+
"description": "Response from creating a new session.\n\nSee protocol docs: [Creating a Session](https://agentclientprotocol.com/protocol/session-setup#creating-a-session)",
|
|
1972
|
+
"properties": {
|
|
1973
|
+
"_meta": {
|
|
1974
|
+
"additionalProperties": true,
|
|
1975
|
+
"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)",
|
|
1976
|
+
"type": ["object", "null"]
|
|
1977
|
+
},
|
|
1978
|
+
"configOptions": {
|
|
1979
|
+
"description": "Initial session configuration options if supported by the Agent.",
|
|
1980
|
+
"items": {
|
|
1981
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
1982
|
+
},
|
|
1983
|
+
"type": ["array", "null"]
|
|
1984
|
+
},
|
|
1985
|
+
"models": {
|
|
1986
|
+
"anyOf": [
|
|
1987
|
+
{
|
|
1988
|
+
"$ref": "#/$defs/SessionModelState"
|
|
1989
|
+
},
|
|
1990
|
+
{
|
|
1991
|
+
"type": "null"
|
|
1992
|
+
}
|
|
1993
|
+
],
|
|
1994
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInitial model state if supported by the Agent"
|
|
1995
|
+
},
|
|
1996
|
+
"modes": {
|
|
1997
|
+
"anyOf": [
|
|
1998
|
+
{
|
|
1999
|
+
"$ref": "#/$defs/SessionModeState"
|
|
2000
|
+
},
|
|
2001
|
+
{
|
|
2002
|
+
"type": "null"
|
|
2003
|
+
}
|
|
2004
|
+
],
|
|
2005
|
+
"description": "Initial mode state if supported by the Agent\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)"
|
|
2006
|
+
},
|
|
2007
|
+
"sessionId": {
|
|
2008
|
+
"allOf": [
|
|
2009
|
+
{
|
|
2010
|
+
"$ref": "#/$defs/SessionId"
|
|
2011
|
+
}
|
|
2012
|
+
],
|
|
2013
|
+
"description": "Unique identifier for the created session.\n\nUsed in all subsequent requests for this conversation."
|
|
2014
|
+
}
|
|
2015
|
+
},
|
|
2016
|
+
"required": ["sessionId"],
|
|
2017
|
+
"type": "object",
|
|
2018
|
+
"x-method": "session/new",
|
|
2019
|
+
"x-side": "agent"
|
|
2020
|
+
},
|
|
2021
|
+
"PermissionOption": {
|
|
2022
|
+
"description": "An option presented to the user when requesting permission.",
|
|
2023
|
+
"properties": {
|
|
2024
|
+
"_meta": {
|
|
2025
|
+
"additionalProperties": true,
|
|
2026
|
+
"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)",
|
|
2027
|
+
"type": ["object", "null"]
|
|
2028
|
+
},
|
|
2029
|
+
"kind": {
|
|
2030
|
+
"allOf": [
|
|
2031
|
+
{
|
|
2032
|
+
"$ref": "#/$defs/PermissionOptionKind"
|
|
2033
|
+
}
|
|
2034
|
+
],
|
|
2035
|
+
"description": "Hint about the nature of this permission option."
|
|
2036
|
+
},
|
|
2037
|
+
"name": {
|
|
2038
|
+
"description": "Human-readable label to display to the user.",
|
|
2039
|
+
"type": "string"
|
|
2040
|
+
},
|
|
2041
|
+
"optionId": {
|
|
2042
|
+
"allOf": [
|
|
2043
|
+
{
|
|
2044
|
+
"$ref": "#/$defs/PermissionOptionId"
|
|
2045
|
+
}
|
|
2046
|
+
],
|
|
2047
|
+
"description": "Unique identifier for this permission option."
|
|
2048
|
+
}
|
|
2049
|
+
},
|
|
2050
|
+
"required": ["optionId", "name", "kind"],
|
|
2051
|
+
"type": "object"
|
|
2052
|
+
},
|
|
2053
|
+
"PermissionOptionId": {
|
|
2054
|
+
"description": "Unique identifier for a permission option.",
|
|
2055
|
+
"type": "string"
|
|
2056
|
+
},
|
|
2057
|
+
"PermissionOptionKind": {
|
|
2058
|
+
"description": "The type of permission option being presented to the user.\n\nHelps clients choose appropriate icons and UI treatment.",
|
|
2059
|
+
"oneOf": [
|
|
2060
|
+
{
|
|
2061
|
+
"const": "allow_once",
|
|
2062
|
+
"description": "Allow this operation only this time.",
|
|
2063
|
+
"type": "string"
|
|
2064
|
+
},
|
|
2065
|
+
{
|
|
2066
|
+
"const": "allow_always",
|
|
2067
|
+
"description": "Allow this operation and remember the choice.",
|
|
2068
|
+
"type": "string"
|
|
2069
|
+
},
|
|
2070
|
+
{
|
|
2071
|
+
"const": "reject_once",
|
|
2072
|
+
"description": "Reject this operation only this time.",
|
|
2073
|
+
"type": "string"
|
|
2074
|
+
},
|
|
2075
|
+
{
|
|
2076
|
+
"const": "reject_always",
|
|
2077
|
+
"description": "Reject this operation and remember the choice.",
|
|
2078
|
+
"type": "string"
|
|
2079
|
+
}
|
|
2080
|
+
]
|
|
2081
|
+
},
|
|
2082
|
+
"Plan": {
|
|
2083
|
+
"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)",
|
|
2084
|
+
"properties": {
|
|
2085
|
+
"_meta": {
|
|
2086
|
+
"additionalProperties": true,
|
|
2087
|
+
"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)",
|
|
2088
|
+
"type": ["object", "null"]
|
|
2089
|
+
},
|
|
2090
|
+
"entries": {
|
|
2091
|
+
"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.",
|
|
2092
|
+
"items": {
|
|
2093
|
+
"$ref": "#/$defs/PlanEntry"
|
|
2094
|
+
},
|
|
2095
|
+
"type": "array"
|
|
2096
|
+
}
|
|
2097
|
+
},
|
|
2098
|
+
"required": ["entries"],
|
|
2099
|
+
"type": "object"
|
|
2100
|
+
},
|
|
2101
|
+
"PlanEntry": {
|
|
2102
|
+
"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)",
|
|
2103
|
+
"properties": {
|
|
2104
|
+
"_meta": {
|
|
2105
|
+
"additionalProperties": true,
|
|
2106
|
+
"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)",
|
|
2107
|
+
"type": ["object", "null"]
|
|
2108
|
+
},
|
|
2109
|
+
"content": {
|
|
2110
|
+
"description": "Human-readable description of what this task aims to accomplish.",
|
|
2111
|
+
"type": "string"
|
|
2112
|
+
},
|
|
2113
|
+
"priority": {
|
|
2114
|
+
"allOf": [
|
|
2115
|
+
{
|
|
2116
|
+
"$ref": "#/$defs/PlanEntryPriority"
|
|
2117
|
+
}
|
|
2118
|
+
],
|
|
2119
|
+
"description": "The relative importance of this task.\nUsed to indicate which tasks are most critical to the overall goal."
|
|
2120
|
+
},
|
|
2121
|
+
"status": {
|
|
2122
|
+
"allOf": [
|
|
2123
|
+
{
|
|
2124
|
+
"$ref": "#/$defs/PlanEntryStatus"
|
|
2125
|
+
}
|
|
2126
|
+
],
|
|
2127
|
+
"description": "Current execution status of this task."
|
|
2128
|
+
}
|
|
2129
|
+
},
|
|
2130
|
+
"required": ["content", "priority", "status"],
|
|
2131
|
+
"type": "object"
|
|
2132
|
+
},
|
|
2133
|
+
"PlanEntryPriority": {
|
|
2134
|
+
"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)",
|
|
2135
|
+
"oneOf": [
|
|
2136
|
+
{
|
|
2137
|
+
"const": "high",
|
|
2138
|
+
"description": "High priority task - critical to the overall goal.",
|
|
2139
|
+
"type": "string"
|
|
2140
|
+
},
|
|
2141
|
+
{
|
|
2142
|
+
"const": "medium",
|
|
2143
|
+
"description": "Medium priority task - important but not critical.",
|
|
2144
|
+
"type": "string"
|
|
2145
|
+
},
|
|
2146
|
+
{
|
|
2147
|
+
"const": "low",
|
|
2148
|
+
"description": "Low priority task - nice to have but not essential.",
|
|
2149
|
+
"type": "string"
|
|
2150
|
+
}
|
|
2151
|
+
]
|
|
2152
|
+
},
|
|
2153
|
+
"PlanEntryStatus": {
|
|
2154
|
+
"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)",
|
|
2155
|
+
"oneOf": [
|
|
2156
|
+
{
|
|
2157
|
+
"const": "pending",
|
|
2158
|
+
"description": "The task has not started yet.",
|
|
2159
|
+
"type": "string"
|
|
2160
|
+
},
|
|
2161
|
+
{
|
|
2162
|
+
"const": "in_progress",
|
|
2163
|
+
"description": "The task is currently being worked on.",
|
|
2164
|
+
"type": "string"
|
|
2165
|
+
},
|
|
2166
|
+
{
|
|
2167
|
+
"const": "completed",
|
|
2168
|
+
"description": "The task has been successfully completed.",
|
|
2169
|
+
"type": "string"
|
|
2170
|
+
}
|
|
2171
|
+
]
|
|
2172
|
+
},
|
|
2173
|
+
"PromptCapabilities": {
|
|
2174
|
+
"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)",
|
|
2175
|
+
"properties": {
|
|
2176
|
+
"_meta": {
|
|
2177
|
+
"additionalProperties": true,
|
|
2178
|
+
"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)",
|
|
2179
|
+
"type": ["object", "null"]
|
|
2180
|
+
},
|
|
2181
|
+
"audio": {
|
|
2182
|
+
"default": false,
|
|
2183
|
+
"description": "Agent supports [`ContentBlock::Audio`].",
|
|
2184
|
+
"type": "boolean"
|
|
2185
|
+
},
|
|
2186
|
+
"embeddedContext": {
|
|
2187
|
+
"default": false,
|
|
2188
|
+
"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.",
|
|
2189
|
+
"type": "boolean"
|
|
2190
|
+
},
|
|
2191
|
+
"image": {
|
|
2192
|
+
"default": false,
|
|
2193
|
+
"description": "Agent supports [`ContentBlock::Image`].",
|
|
2194
|
+
"type": "boolean"
|
|
2195
|
+
}
|
|
2196
|
+
},
|
|
2197
|
+
"type": "object"
|
|
2198
|
+
},
|
|
2199
|
+
"PromptRequest": {
|
|
2200
|
+
"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)",
|
|
2201
|
+
"properties": {
|
|
2202
|
+
"_meta": {
|
|
2203
|
+
"additionalProperties": true,
|
|
2204
|
+
"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)",
|
|
2205
|
+
"type": ["object", "null"]
|
|
2206
|
+
},
|
|
2207
|
+
"prompt": {
|
|
2208
|
+
"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.",
|
|
2209
|
+
"items": {
|
|
2210
|
+
"$ref": "#/$defs/ContentBlock"
|
|
2211
|
+
},
|
|
2212
|
+
"type": "array"
|
|
2213
|
+
},
|
|
2214
|
+
"sessionId": {
|
|
2215
|
+
"allOf": [
|
|
2216
|
+
{
|
|
2217
|
+
"$ref": "#/$defs/SessionId"
|
|
2218
|
+
}
|
|
2219
|
+
],
|
|
2220
|
+
"description": "The ID of the session to send this user message to"
|
|
2221
|
+
}
|
|
2222
|
+
},
|
|
2223
|
+
"required": ["sessionId", "prompt"],
|
|
2224
|
+
"type": "object",
|
|
2225
|
+
"x-method": "session/prompt",
|
|
2226
|
+
"x-side": "agent"
|
|
2227
|
+
},
|
|
2228
|
+
"PromptResponse": {
|
|
2229
|
+
"description": "Response from processing a user prompt.\n\nSee protocol docs: [Check for Completion](https://agentclientprotocol.com/protocol/prompt-turn#4-check-for-completion)",
|
|
2230
|
+
"properties": {
|
|
2231
|
+
"_meta": {
|
|
2232
|
+
"additionalProperties": true,
|
|
2233
|
+
"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)",
|
|
2234
|
+
"type": ["object", "null"]
|
|
2235
|
+
},
|
|
2236
|
+
"stopReason": {
|
|
2237
|
+
"allOf": [
|
|
2238
|
+
{
|
|
2239
|
+
"$ref": "#/$defs/StopReason"
|
|
2240
|
+
}
|
|
2241
|
+
],
|
|
2242
|
+
"description": "Indicates why the agent stopped processing the turn."
|
|
2243
|
+
},
|
|
2244
|
+
"usage": {
|
|
2245
|
+
"anyOf": [
|
|
2246
|
+
{
|
|
2247
|
+
"$ref": "#/$defs/Usage"
|
|
2248
|
+
},
|
|
2249
|
+
{
|
|
2250
|
+
"type": "null"
|
|
2251
|
+
}
|
|
2252
|
+
],
|
|
2253
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nToken usage for this turn (optional)."
|
|
2254
|
+
}
|
|
2255
|
+
},
|
|
2256
|
+
"required": ["stopReason"],
|
|
2257
|
+
"type": "object",
|
|
2258
|
+
"x-method": "session/prompt",
|
|
2259
|
+
"x-side": "agent"
|
|
2260
|
+
},
|
|
2261
|
+
"ProtocolVersion": {
|
|
2262
|
+
"description": "Protocol version identifier.\n\nThis version is only bumped for breaking changes.\nNon-breaking changes should be introduced via capabilities.",
|
|
2263
|
+
"format": "uint16",
|
|
2264
|
+
"maximum": 65535,
|
|
2265
|
+
"minimum": 0,
|
|
2266
|
+
"type": "integer"
|
|
2267
|
+
},
|
|
2268
|
+
"ReadTextFileRequest": {
|
|
2269
|
+
"description": "Request to read content from a text file.\n\nOnly available if the client supports the `fs.readTextFile` capability.",
|
|
2270
|
+
"properties": {
|
|
2271
|
+
"_meta": {
|
|
2272
|
+
"additionalProperties": true,
|
|
2273
|
+
"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)",
|
|
2274
|
+
"type": ["object", "null"]
|
|
2275
|
+
},
|
|
2276
|
+
"limit": {
|
|
2277
|
+
"description": "Maximum number of lines to read.",
|
|
2278
|
+
"format": "uint32",
|
|
2279
|
+
"minimum": 0,
|
|
2280
|
+
"type": ["integer", "null"]
|
|
2281
|
+
},
|
|
2282
|
+
"line": {
|
|
2283
|
+
"description": "Line number to start reading from (1-based).",
|
|
2284
|
+
"format": "uint32",
|
|
2285
|
+
"minimum": 0,
|
|
2286
|
+
"type": ["integer", "null"]
|
|
2287
|
+
},
|
|
2288
|
+
"path": {
|
|
2289
|
+
"description": "Absolute path to the file to read.",
|
|
2290
|
+
"type": "string"
|
|
2291
|
+
},
|
|
2292
|
+
"sessionId": {
|
|
2293
|
+
"allOf": [
|
|
2294
|
+
{
|
|
2295
|
+
"$ref": "#/$defs/SessionId"
|
|
2296
|
+
}
|
|
2297
|
+
],
|
|
2298
|
+
"description": "The session ID for this request."
|
|
2299
|
+
}
|
|
2300
|
+
},
|
|
2301
|
+
"required": ["sessionId", "path"],
|
|
2302
|
+
"type": "object",
|
|
2303
|
+
"x-method": "fs/read_text_file",
|
|
2304
|
+
"x-side": "client"
|
|
2305
|
+
},
|
|
2306
|
+
"ReadTextFileResponse": {
|
|
2307
|
+
"description": "Response containing the contents of a text file.",
|
|
2308
|
+
"properties": {
|
|
2309
|
+
"_meta": {
|
|
2310
|
+
"additionalProperties": true,
|
|
2311
|
+
"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)",
|
|
2312
|
+
"type": ["object", "null"]
|
|
2313
|
+
},
|
|
2314
|
+
"content": {
|
|
2315
|
+
"type": "string"
|
|
2316
|
+
}
|
|
2317
|
+
},
|
|
2318
|
+
"required": ["content"],
|
|
2319
|
+
"type": "object",
|
|
2320
|
+
"x-method": "fs/read_text_file",
|
|
2321
|
+
"x-side": "client"
|
|
2322
|
+
},
|
|
2323
|
+
"ReleaseTerminalRequest": {
|
|
2324
|
+
"description": "Request to release a terminal and free its resources.",
|
|
2325
|
+
"properties": {
|
|
2326
|
+
"_meta": {
|
|
2327
|
+
"additionalProperties": true,
|
|
2328
|
+
"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)",
|
|
2329
|
+
"type": ["object", "null"]
|
|
2330
|
+
},
|
|
2331
|
+
"sessionId": {
|
|
2332
|
+
"allOf": [
|
|
2333
|
+
{
|
|
2334
|
+
"$ref": "#/$defs/SessionId"
|
|
2335
|
+
}
|
|
2336
|
+
],
|
|
2337
|
+
"description": "The session ID for this request."
|
|
2338
|
+
},
|
|
2339
|
+
"terminalId": {
|
|
2340
|
+
"description": "The ID of the terminal to release.",
|
|
2341
|
+
"type": "string"
|
|
2342
|
+
}
|
|
2343
|
+
},
|
|
2344
|
+
"required": ["sessionId", "terminalId"],
|
|
2345
|
+
"type": "object",
|
|
2346
|
+
"x-method": "terminal/release",
|
|
2347
|
+
"x-side": "client"
|
|
2348
|
+
},
|
|
2349
|
+
"ReleaseTerminalResponse": {
|
|
2350
|
+
"description": "Response to terminal/release method",
|
|
2351
|
+
"properties": {
|
|
2352
|
+
"_meta": {
|
|
2353
|
+
"additionalProperties": true,
|
|
2354
|
+
"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)",
|
|
2355
|
+
"type": ["object", "null"]
|
|
2356
|
+
}
|
|
2357
|
+
},
|
|
2358
|
+
"type": "object",
|
|
2359
|
+
"x-method": "terminal/release",
|
|
2360
|
+
"x-side": "client"
|
|
2361
|
+
},
|
|
2362
|
+
"RequestId": {
|
|
2363
|
+
"anyOf": [
|
|
2364
|
+
{
|
|
2365
|
+
"title": "Null",
|
|
2366
|
+
"type": "null"
|
|
2367
|
+
},
|
|
2368
|
+
{
|
|
2369
|
+
"format": "int64",
|
|
2370
|
+
"title": "Number",
|
|
2371
|
+
"type": "integer"
|
|
2372
|
+
},
|
|
2373
|
+
{
|
|
2374
|
+
"title": "Str",
|
|
2375
|
+
"type": "string"
|
|
2376
|
+
}
|
|
2377
|
+
],
|
|
2378
|
+
"description": "JSON RPC Request Id\n\nAn identifier established by the Client that MUST contain a String, Number, or NULL value if included. If it is not included it is assumed to be a notification. The value SHOULD normally not be Null [1] and Numbers SHOULD NOT contain fractional parts [2]\n\nThe Server MUST reply with the same value in the Response object if included. This member is used to correlate the context between the two objects.\n\n[1] The use of Null as a value for the id member in a Request object is discouraged, because this specification uses a value of Null for Responses with an unknown id. Also, because JSON-RPC 1.0 uses an id value of Null for Notifications this could cause confusion in handling.\n\n[2] Fractional parts may be problematic, since many decimal fractions cannot be represented exactly as binary fractions."
|
|
2379
|
+
},
|
|
2380
|
+
"RequestPermissionOutcome": {
|
|
2381
|
+
"description": "The outcome of a permission request.",
|
|
2382
|
+
"discriminator": {
|
|
2383
|
+
"propertyName": "outcome"
|
|
2384
|
+
},
|
|
2385
|
+
"oneOf": [
|
|
2386
|
+
{
|
|
2387
|
+
"description": "The prompt turn was cancelled before the user responded.\n\nWhen a client sends a `session/cancel` notification to cancel an ongoing\nprompt turn, it MUST respond to all pending `session/request_permission`\nrequests with this `Cancelled` outcome.\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/prompt-turn#cancellation)",
|
|
2388
|
+
"properties": {
|
|
2389
|
+
"outcome": {
|
|
2390
|
+
"const": "cancelled",
|
|
2391
|
+
"type": "string"
|
|
2392
|
+
}
|
|
2393
|
+
},
|
|
2394
|
+
"required": ["outcome"],
|
|
2395
|
+
"type": "object"
|
|
2396
|
+
},
|
|
2397
|
+
{
|
|
2398
|
+
"allOf": [
|
|
2399
|
+
{
|
|
2400
|
+
"$ref": "#/$defs/SelectedPermissionOutcome"
|
|
2401
|
+
}
|
|
2402
|
+
],
|
|
2403
|
+
"description": "The user selected one of the provided options.",
|
|
2404
|
+
"properties": {
|
|
2405
|
+
"outcome": {
|
|
2406
|
+
"const": "selected",
|
|
2407
|
+
"type": "string"
|
|
2408
|
+
}
|
|
2409
|
+
},
|
|
2410
|
+
"required": ["outcome"],
|
|
2411
|
+
"type": "object"
|
|
2412
|
+
}
|
|
2413
|
+
]
|
|
2414
|
+
},
|
|
2415
|
+
"RequestPermissionRequest": {
|
|
2416
|
+
"description": "Request for user permission to execute a tool call.\n\nSent when the agent needs authorization before performing a sensitive operation.\n\nSee protocol docs: [Requesting Permission](https://agentclientprotocol.com/protocol/tool-calls#requesting-permission)",
|
|
2417
|
+
"properties": {
|
|
2418
|
+
"_meta": {
|
|
2419
|
+
"additionalProperties": true,
|
|
2420
|
+
"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)",
|
|
2421
|
+
"type": ["object", "null"]
|
|
2422
|
+
},
|
|
2423
|
+
"options": {
|
|
2424
|
+
"description": "Available permission options for the user to choose from.",
|
|
2425
|
+
"items": {
|
|
2426
|
+
"$ref": "#/$defs/PermissionOption"
|
|
2427
|
+
},
|
|
2428
|
+
"type": "array"
|
|
2429
|
+
},
|
|
2430
|
+
"sessionId": {
|
|
2431
|
+
"allOf": [
|
|
2432
|
+
{
|
|
2433
|
+
"$ref": "#/$defs/SessionId"
|
|
2434
|
+
}
|
|
2435
|
+
],
|
|
2436
|
+
"description": "The session ID for this request."
|
|
2437
|
+
},
|
|
2438
|
+
"toolCall": {
|
|
2439
|
+
"allOf": [
|
|
2440
|
+
{
|
|
2441
|
+
"$ref": "#/$defs/ToolCallUpdate"
|
|
2442
|
+
}
|
|
2443
|
+
],
|
|
2444
|
+
"description": "Details about the tool call requiring permission."
|
|
2445
|
+
}
|
|
2446
|
+
},
|
|
2447
|
+
"required": ["sessionId", "toolCall", "options"],
|
|
2448
|
+
"type": "object",
|
|
2449
|
+
"x-method": "session/request_permission",
|
|
2450
|
+
"x-side": "client"
|
|
2451
|
+
},
|
|
2452
|
+
"RequestPermissionResponse": {
|
|
2453
|
+
"description": "Response to a permission request.",
|
|
2454
|
+
"properties": {
|
|
2455
|
+
"_meta": {
|
|
2456
|
+
"additionalProperties": true,
|
|
2457
|
+
"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)",
|
|
2458
|
+
"type": ["object", "null"]
|
|
2459
|
+
},
|
|
2460
|
+
"outcome": {
|
|
2461
|
+
"allOf": [
|
|
2462
|
+
{
|
|
2463
|
+
"$ref": "#/$defs/RequestPermissionOutcome"
|
|
2464
|
+
}
|
|
2465
|
+
],
|
|
2466
|
+
"description": "The user's decision on the permission request."
|
|
2467
|
+
}
|
|
2468
|
+
},
|
|
2469
|
+
"required": ["outcome"],
|
|
2470
|
+
"type": "object",
|
|
2471
|
+
"x-method": "session/request_permission",
|
|
2472
|
+
"x-side": "client"
|
|
2473
|
+
},
|
|
2474
|
+
"ResourceLink": {
|
|
2475
|
+
"description": "A resource that the server is capable of reading, included in a prompt or tool call result.",
|
|
2476
|
+
"properties": {
|
|
2477
|
+
"_meta": {
|
|
2478
|
+
"additionalProperties": true,
|
|
2479
|
+
"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)",
|
|
2480
|
+
"type": ["object", "null"]
|
|
2481
|
+
},
|
|
2482
|
+
"annotations": {
|
|
2483
|
+
"anyOf": [
|
|
2484
|
+
{
|
|
2485
|
+
"$ref": "#/$defs/Annotations"
|
|
2486
|
+
},
|
|
2487
|
+
{
|
|
2488
|
+
"type": "null"
|
|
2489
|
+
}
|
|
2490
|
+
]
|
|
2491
|
+
},
|
|
2492
|
+
"description": {
|
|
2493
|
+
"type": ["string", "null"]
|
|
2494
|
+
},
|
|
2495
|
+
"mimeType": {
|
|
2496
|
+
"type": ["string", "null"]
|
|
2497
|
+
},
|
|
2498
|
+
"name": {
|
|
2499
|
+
"type": "string"
|
|
2500
|
+
},
|
|
2501
|
+
"size": {
|
|
2502
|
+
"format": "int64",
|
|
2503
|
+
"type": ["integer", "null"]
|
|
2504
|
+
},
|
|
2505
|
+
"title": {
|
|
2506
|
+
"type": ["string", "null"]
|
|
2507
|
+
},
|
|
2508
|
+
"uri": {
|
|
2509
|
+
"type": "string"
|
|
2510
|
+
}
|
|
2511
|
+
},
|
|
2512
|
+
"required": ["name", "uri"],
|
|
2513
|
+
"type": "object"
|
|
2514
|
+
},
|
|
2515
|
+
"ResumeSessionRequest": {
|
|
2516
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nRequest parameters for resuming an existing session.\n\nResumes an existing session without returning previous messages (unlike `session/load`).\nThis is useful for agents that can resume sessions but don't implement full session loading.\n\nOnly available if the Agent supports the `session.resume` capability.",
|
|
2517
|
+
"properties": {
|
|
2518
|
+
"_meta": {
|
|
2519
|
+
"additionalProperties": true,
|
|
2520
|
+
"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)",
|
|
2521
|
+
"type": ["object", "null"]
|
|
2522
|
+
},
|
|
2523
|
+
"cwd": {
|
|
2524
|
+
"description": "The working directory for this session.",
|
|
2525
|
+
"type": "string"
|
|
2526
|
+
},
|
|
2527
|
+
"mcpServers": {
|
|
2528
|
+
"description": "List of MCP servers to connect to for this session.",
|
|
2529
|
+
"items": {
|
|
2530
|
+
"$ref": "#/$defs/McpServer"
|
|
2531
|
+
},
|
|
2532
|
+
"type": "array"
|
|
2533
|
+
},
|
|
2534
|
+
"sessionId": {
|
|
2535
|
+
"allOf": [
|
|
2536
|
+
{
|
|
2537
|
+
"$ref": "#/$defs/SessionId"
|
|
2538
|
+
}
|
|
2539
|
+
],
|
|
2540
|
+
"description": "The ID of the session to resume."
|
|
2541
|
+
}
|
|
2542
|
+
},
|
|
2543
|
+
"required": ["sessionId", "cwd"],
|
|
2544
|
+
"type": "object",
|
|
2545
|
+
"x-method": "session/resume",
|
|
2546
|
+
"x-side": "agent"
|
|
2547
|
+
},
|
|
2548
|
+
"ResumeSessionResponse": {
|
|
2549
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nResponse from resuming an existing session.",
|
|
2550
|
+
"properties": {
|
|
2551
|
+
"_meta": {
|
|
2552
|
+
"additionalProperties": true,
|
|
2553
|
+
"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)",
|
|
2554
|
+
"type": ["object", "null"]
|
|
2555
|
+
},
|
|
2556
|
+
"configOptions": {
|
|
2557
|
+
"description": "Initial session configuration options if supported by the Agent.",
|
|
2558
|
+
"items": {
|
|
2559
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
2560
|
+
},
|
|
2561
|
+
"type": ["array", "null"]
|
|
2562
|
+
},
|
|
2563
|
+
"models": {
|
|
2564
|
+
"anyOf": [
|
|
2565
|
+
{
|
|
2566
|
+
"$ref": "#/$defs/SessionModelState"
|
|
2567
|
+
},
|
|
2568
|
+
{
|
|
2569
|
+
"type": "null"
|
|
2570
|
+
}
|
|
2571
|
+
],
|
|
2572
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInitial model state if supported by the Agent"
|
|
2573
|
+
},
|
|
2574
|
+
"modes": {
|
|
2575
|
+
"anyOf": [
|
|
2576
|
+
{
|
|
2577
|
+
"$ref": "#/$defs/SessionModeState"
|
|
2578
|
+
},
|
|
2579
|
+
{
|
|
2580
|
+
"type": "null"
|
|
2581
|
+
}
|
|
2582
|
+
],
|
|
2583
|
+
"description": "Initial mode state if supported by the Agent\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)"
|
|
2584
|
+
}
|
|
2585
|
+
},
|
|
2586
|
+
"type": "object",
|
|
2587
|
+
"x-method": "session/resume",
|
|
2588
|
+
"x-side": "agent"
|
|
2589
|
+
},
|
|
2590
|
+
"Role": {
|
|
2591
|
+
"description": "The sender or recipient of messages and data in a conversation.",
|
|
2592
|
+
"enum": ["assistant", "user"],
|
|
2593
|
+
"type": "string"
|
|
2594
|
+
},
|
|
2595
|
+
"SelectedPermissionOutcome": {
|
|
2596
|
+
"description": "The user selected one of the provided options.",
|
|
2597
|
+
"properties": {
|
|
2598
|
+
"_meta": {
|
|
2599
|
+
"additionalProperties": true,
|
|
2600
|
+
"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)",
|
|
2601
|
+
"type": ["object", "null"]
|
|
2602
|
+
},
|
|
2603
|
+
"optionId": {
|
|
2604
|
+
"allOf": [
|
|
2605
|
+
{
|
|
2606
|
+
"$ref": "#/$defs/PermissionOptionId"
|
|
2607
|
+
}
|
|
2608
|
+
],
|
|
2609
|
+
"description": "The ID of the option the user selected."
|
|
2610
|
+
}
|
|
2611
|
+
},
|
|
2612
|
+
"required": ["optionId"],
|
|
2613
|
+
"type": "object"
|
|
2614
|
+
},
|
|
2615
|
+
"SessionCapabilities": {
|
|
2616
|
+
"description": "Session capabilities supported by the agent.\n\nAs a baseline, all Agents **MUST** support `session/new`, `session/prompt`, `session/cancel`, and `session/update`.\n\nOptionally, they **MAY** support other session methods and notifications by specifying additional capabilities.\n\nNote: `session/load` is still handled by the top-level `load_session` capability. This will be unified in future versions of the protocol.\n\nSee protocol docs: [Session Capabilities](https://agentclientprotocol.com/protocol/initialization#session-capabilities)",
|
|
2617
|
+
"properties": {
|
|
2618
|
+
"_meta": {
|
|
2619
|
+
"additionalProperties": true,
|
|
2620
|
+
"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)",
|
|
2621
|
+
"type": ["object", "null"]
|
|
2622
|
+
},
|
|
2623
|
+
"fork": {
|
|
2624
|
+
"anyOf": [
|
|
2625
|
+
{
|
|
2626
|
+
"$ref": "#/$defs/SessionForkCapabilities"
|
|
2627
|
+
},
|
|
2628
|
+
{
|
|
2629
|
+
"type": "null"
|
|
2630
|
+
}
|
|
2631
|
+
],
|
|
2632
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nWhether the agent supports `session/fork`."
|
|
2633
|
+
},
|
|
2634
|
+
"list": {
|
|
2635
|
+
"anyOf": [
|
|
2636
|
+
{
|
|
2637
|
+
"$ref": "#/$defs/SessionListCapabilities"
|
|
2638
|
+
},
|
|
2639
|
+
{
|
|
2640
|
+
"type": "null"
|
|
2641
|
+
}
|
|
2642
|
+
],
|
|
2643
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nWhether the agent supports `session/list`."
|
|
2644
|
+
},
|
|
2645
|
+
"resume": {
|
|
2646
|
+
"anyOf": [
|
|
2647
|
+
{
|
|
2648
|
+
"$ref": "#/$defs/SessionResumeCapabilities"
|
|
2649
|
+
},
|
|
2650
|
+
{
|
|
2651
|
+
"type": "null"
|
|
2652
|
+
}
|
|
2653
|
+
],
|
|
2654
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nWhether the agent supports `session/resume`."
|
|
2655
|
+
}
|
|
2656
|
+
},
|
|
2657
|
+
"type": "object"
|
|
2658
|
+
},
|
|
2659
|
+
"SessionConfigGroupId": {
|
|
2660
|
+
"description": "Unique identifier for a session configuration option value group.",
|
|
2661
|
+
"type": "string"
|
|
2662
|
+
},
|
|
2663
|
+
"SessionConfigId": {
|
|
2664
|
+
"description": "Unique identifier for a session configuration option.",
|
|
2665
|
+
"type": "string"
|
|
2666
|
+
},
|
|
2667
|
+
"SessionConfigOption": {
|
|
2668
|
+
"description": "A session configuration option selector and its current state.",
|
|
2669
|
+
"discriminator": {
|
|
2670
|
+
"propertyName": "type"
|
|
2671
|
+
},
|
|
2672
|
+
"oneOf": [
|
|
2673
|
+
{
|
|
2674
|
+
"allOf": [
|
|
2675
|
+
{
|
|
2676
|
+
"$ref": "#/$defs/SessionConfigSelect"
|
|
2677
|
+
}
|
|
2678
|
+
],
|
|
2679
|
+
"description": "Single-value selector (dropdown).",
|
|
2680
|
+
"properties": {
|
|
2681
|
+
"type": {
|
|
2682
|
+
"const": "select",
|
|
2683
|
+
"type": "string"
|
|
2684
|
+
}
|
|
2685
|
+
},
|
|
2686
|
+
"required": ["type"],
|
|
2687
|
+
"type": "object"
|
|
2688
|
+
}
|
|
2689
|
+
],
|
|
2690
|
+
"properties": {
|
|
2691
|
+
"_meta": {
|
|
2692
|
+
"additionalProperties": true,
|
|
2693
|
+
"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)",
|
|
2694
|
+
"type": ["object", "null"]
|
|
2695
|
+
},
|
|
2696
|
+
"category": {
|
|
2697
|
+
"anyOf": [
|
|
2698
|
+
{
|
|
2699
|
+
"$ref": "#/$defs/SessionConfigOptionCategory"
|
|
2700
|
+
},
|
|
2701
|
+
{
|
|
2702
|
+
"type": "null"
|
|
2703
|
+
}
|
|
2704
|
+
],
|
|
2705
|
+
"description": "Optional semantic category for this option (UX only)."
|
|
2706
|
+
},
|
|
2707
|
+
"description": {
|
|
2708
|
+
"description": "Optional description for the Client to display to the user.",
|
|
2709
|
+
"type": ["string", "null"]
|
|
2710
|
+
},
|
|
2711
|
+
"id": {
|
|
2712
|
+
"allOf": [
|
|
2713
|
+
{
|
|
2714
|
+
"$ref": "#/$defs/SessionConfigId"
|
|
2715
|
+
}
|
|
2716
|
+
],
|
|
2717
|
+
"description": "Unique identifier for the configuration option."
|
|
2718
|
+
},
|
|
2719
|
+
"name": {
|
|
2720
|
+
"description": "Human-readable label for the option.",
|
|
2721
|
+
"type": "string"
|
|
2722
|
+
}
|
|
2723
|
+
},
|
|
2724
|
+
"required": ["id", "name"],
|
|
2725
|
+
"type": "object"
|
|
2726
|
+
},
|
|
2727
|
+
"SessionConfigOptionCategory": {
|
|
2728
|
+
"anyOf": [
|
|
2729
|
+
{
|
|
2730
|
+
"const": "mode",
|
|
2731
|
+
"description": "Session mode selector.",
|
|
2732
|
+
"type": "string"
|
|
2733
|
+
},
|
|
2734
|
+
{
|
|
2735
|
+
"const": "model",
|
|
2736
|
+
"description": "Model selector.",
|
|
2737
|
+
"type": "string"
|
|
2738
|
+
},
|
|
2739
|
+
{
|
|
2740
|
+
"const": "thought_level",
|
|
2741
|
+
"description": "Thought/reasoning level selector.",
|
|
2742
|
+
"type": "string"
|
|
2743
|
+
},
|
|
2744
|
+
{
|
|
2745
|
+
"description": "Unknown / uncategorized selector.",
|
|
2746
|
+
"title": "other",
|
|
2747
|
+
"type": "string"
|
|
2748
|
+
}
|
|
2749
|
+
],
|
|
2750
|
+
"description": "Semantic category for a session configuration option.\n\nThis is intended to help Clients distinguish broadly common selectors (e.g. model selector vs\nsession mode selector vs thought/reasoning level) for UX purposes (keyboard shortcuts, icons,\nplacement). It MUST NOT be required for correctness. Clients MUST handle missing or unknown\ncategories gracefully.\n\nCategory names beginning with `_` are free for custom use, like other ACP extension methods.\nCategory names that do not begin with `_` are reserved for the ACP spec."
|
|
2751
|
+
},
|
|
2752
|
+
"SessionConfigSelect": {
|
|
2753
|
+
"description": "A single-value selector (dropdown) session configuration option payload.",
|
|
2754
|
+
"properties": {
|
|
2755
|
+
"currentValue": {
|
|
2756
|
+
"allOf": [
|
|
2757
|
+
{
|
|
2758
|
+
"$ref": "#/$defs/SessionConfigValueId"
|
|
2759
|
+
}
|
|
2760
|
+
],
|
|
2761
|
+
"description": "The currently selected value."
|
|
2762
|
+
},
|
|
2763
|
+
"options": {
|
|
2764
|
+
"allOf": [
|
|
2765
|
+
{
|
|
2766
|
+
"$ref": "#/$defs/SessionConfigSelectOptions"
|
|
2767
|
+
}
|
|
2768
|
+
],
|
|
2769
|
+
"description": "The set of selectable options."
|
|
2770
|
+
}
|
|
2771
|
+
},
|
|
2772
|
+
"required": ["currentValue", "options"],
|
|
2773
|
+
"type": "object"
|
|
2774
|
+
},
|
|
2775
|
+
"SessionConfigSelectGroup": {
|
|
2776
|
+
"description": "A group of possible values for a session configuration option.",
|
|
2777
|
+
"properties": {
|
|
2778
|
+
"_meta": {
|
|
2779
|
+
"additionalProperties": true,
|
|
2780
|
+
"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)",
|
|
2781
|
+
"type": ["object", "null"]
|
|
2782
|
+
},
|
|
2783
|
+
"group": {
|
|
2784
|
+
"allOf": [
|
|
2785
|
+
{
|
|
2786
|
+
"$ref": "#/$defs/SessionConfigGroupId"
|
|
2787
|
+
}
|
|
2788
|
+
],
|
|
2789
|
+
"description": "Unique identifier for this group."
|
|
2790
|
+
},
|
|
2791
|
+
"name": {
|
|
2792
|
+
"description": "Human-readable label for this group.",
|
|
2793
|
+
"type": "string"
|
|
2794
|
+
},
|
|
2795
|
+
"options": {
|
|
2796
|
+
"description": "The set of option values in this group.",
|
|
2797
|
+
"items": {
|
|
2798
|
+
"$ref": "#/$defs/SessionConfigSelectOption"
|
|
2799
|
+
},
|
|
2800
|
+
"type": "array"
|
|
2801
|
+
}
|
|
2802
|
+
},
|
|
2803
|
+
"required": ["group", "name", "options"],
|
|
2804
|
+
"type": "object"
|
|
2805
|
+
},
|
|
2806
|
+
"SessionConfigSelectOption": {
|
|
2807
|
+
"description": "A possible value for a session configuration option.",
|
|
2808
|
+
"properties": {
|
|
2809
|
+
"_meta": {
|
|
2810
|
+
"additionalProperties": true,
|
|
2811
|
+
"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)",
|
|
2812
|
+
"type": ["object", "null"]
|
|
2813
|
+
},
|
|
2814
|
+
"description": {
|
|
2815
|
+
"description": "Optional description for this option value.",
|
|
2816
|
+
"type": ["string", "null"]
|
|
2817
|
+
},
|
|
2818
|
+
"name": {
|
|
2819
|
+
"description": "Human-readable label for this option value.",
|
|
2820
|
+
"type": "string"
|
|
2821
|
+
},
|
|
2822
|
+
"value": {
|
|
2823
|
+
"allOf": [
|
|
2824
|
+
{
|
|
2825
|
+
"$ref": "#/$defs/SessionConfigValueId"
|
|
2826
|
+
}
|
|
2827
|
+
],
|
|
2828
|
+
"description": "Unique identifier for this option value."
|
|
2829
|
+
}
|
|
2830
|
+
},
|
|
2831
|
+
"required": ["value", "name"],
|
|
2832
|
+
"type": "object"
|
|
2833
|
+
},
|
|
2834
|
+
"SessionConfigSelectOptions": {
|
|
2835
|
+
"anyOf": [
|
|
2836
|
+
{
|
|
2837
|
+
"description": "A flat list of options with no grouping.",
|
|
2838
|
+
"items": {
|
|
2839
|
+
"$ref": "#/$defs/SessionConfigSelectOption"
|
|
2840
|
+
},
|
|
2841
|
+
"title": "Ungrouped",
|
|
2842
|
+
"type": "array"
|
|
2843
|
+
},
|
|
2844
|
+
{
|
|
2845
|
+
"description": "A list of options grouped under headers.",
|
|
2846
|
+
"items": {
|
|
2847
|
+
"$ref": "#/$defs/SessionConfigSelectGroup"
|
|
2848
|
+
},
|
|
2849
|
+
"title": "Grouped",
|
|
2850
|
+
"type": "array"
|
|
2851
|
+
}
|
|
2852
|
+
],
|
|
2853
|
+
"description": "Possible values for a session configuration option."
|
|
2854
|
+
},
|
|
2855
|
+
"SessionConfigValueId": {
|
|
2856
|
+
"description": "Unique identifier for a session configuration option value.",
|
|
2857
|
+
"type": "string"
|
|
2858
|
+
},
|
|
2859
|
+
"SessionForkCapabilities": {
|
|
2860
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nCapabilities for the `session/fork` method.\n\nBy supplying `{}` it means that the agent supports forking of sessions.",
|
|
2861
|
+
"properties": {
|
|
2862
|
+
"_meta": {
|
|
2863
|
+
"additionalProperties": true,
|
|
2864
|
+
"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)",
|
|
2865
|
+
"type": ["object", "null"]
|
|
2866
|
+
}
|
|
2867
|
+
},
|
|
2868
|
+
"type": "object"
|
|
2869
|
+
},
|
|
2870
|
+
"SessionId": {
|
|
2871
|
+
"description": "A unique identifier for a conversation session between a client and agent.\n\nSessions maintain their own context, conversation history, and state,\nallowing multiple independent interactions with the same agent.\n\nSee protocol docs: [Session ID](https://agentclientprotocol.com/protocol/session-setup#session-id)",
|
|
2872
|
+
"type": "string"
|
|
2873
|
+
},
|
|
2874
|
+
"SessionInfo": {
|
|
2875
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nInformation about a session returned by session/list",
|
|
2876
|
+
"properties": {
|
|
2877
|
+
"_meta": {
|
|
2878
|
+
"additionalProperties": true,
|
|
2879
|
+
"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)",
|
|
2880
|
+
"type": ["object", "null"]
|
|
2881
|
+
},
|
|
2882
|
+
"cwd": {
|
|
2883
|
+
"description": "The working directory for this session. Must be an absolute path.",
|
|
2884
|
+
"type": "string"
|
|
2885
|
+
},
|
|
2886
|
+
"sessionId": {
|
|
2887
|
+
"allOf": [
|
|
2888
|
+
{
|
|
2889
|
+
"$ref": "#/$defs/SessionId"
|
|
2890
|
+
}
|
|
2891
|
+
],
|
|
2892
|
+
"description": "Unique identifier for the session"
|
|
2893
|
+
},
|
|
2894
|
+
"title": {
|
|
2895
|
+
"description": "Human-readable title for the session",
|
|
2896
|
+
"type": ["string", "null"]
|
|
2897
|
+
},
|
|
2898
|
+
"updatedAt": {
|
|
2899
|
+
"description": "ISO 8601 timestamp of last activity",
|
|
2900
|
+
"type": ["string", "null"]
|
|
2901
|
+
}
|
|
2902
|
+
},
|
|
2903
|
+
"required": ["sessionId", "cwd"],
|
|
2904
|
+
"type": "object"
|
|
2905
|
+
},
|
|
2906
|
+
"SessionInfoUpdate": {
|
|
2907
|
+
"description": "Update to session metadata. All fields are optional to support partial updates.\n\nAgents send this notification to update session information like title or custom metadata.\nThis allows clients to display dynamic session names and track session state changes.",
|
|
2908
|
+
"properties": {
|
|
2909
|
+
"_meta": {
|
|
2910
|
+
"additionalProperties": true,
|
|
2911
|
+
"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)",
|
|
2912
|
+
"type": ["object", "null"]
|
|
2913
|
+
},
|
|
2914
|
+
"title": {
|
|
2915
|
+
"description": "Human-readable title for the session. Set to null to clear.",
|
|
2916
|
+
"type": ["string", "null"]
|
|
2917
|
+
},
|
|
2918
|
+
"updatedAt": {
|
|
2919
|
+
"description": "ISO 8601 timestamp of last activity. Set to null to clear.",
|
|
2920
|
+
"type": ["string", "null"]
|
|
2921
|
+
}
|
|
2922
|
+
},
|
|
2923
|
+
"type": "object"
|
|
2924
|
+
},
|
|
2925
|
+
"SessionListCapabilities": {
|
|
2926
|
+
"description": "Capabilities for the `session/list` method.\n\nBy supplying `{}` it means that the agent supports listing of sessions.\n\nFurther capabilities can be added in the future for other means of filtering or searching the list.",
|
|
2927
|
+
"properties": {
|
|
2928
|
+
"_meta": {
|
|
2929
|
+
"additionalProperties": true,
|
|
2930
|
+
"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)",
|
|
2931
|
+
"type": ["object", "null"]
|
|
2932
|
+
}
|
|
2933
|
+
},
|
|
2934
|
+
"type": "object"
|
|
2935
|
+
},
|
|
2936
|
+
"SessionMode": {
|
|
2937
|
+
"description": "A mode the agent can operate in.\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)",
|
|
2938
|
+
"properties": {
|
|
2939
|
+
"_meta": {
|
|
2940
|
+
"additionalProperties": true,
|
|
2941
|
+
"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)",
|
|
2942
|
+
"type": ["object", "null"]
|
|
2943
|
+
},
|
|
2944
|
+
"description": {
|
|
2945
|
+
"type": ["string", "null"]
|
|
2946
|
+
},
|
|
2947
|
+
"id": {
|
|
2948
|
+
"$ref": "#/$defs/SessionModeId"
|
|
2949
|
+
},
|
|
2950
|
+
"name": {
|
|
2951
|
+
"type": "string"
|
|
2952
|
+
}
|
|
2953
|
+
},
|
|
2954
|
+
"required": ["id", "name"],
|
|
2955
|
+
"type": "object"
|
|
2956
|
+
},
|
|
2957
|
+
"SessionModeId": {
|
|
2958
|
+
"description": "Unique identifier for a Session Mode.",
|
|
2959
|
+
"type": "string"
|
|
2960
|
+
},
|
|
2961
|
+
"SessionModeState": {
|
|
2962
|
+
"description": "The set of modes and the one currently active.",
|
|
2963
|
+
"properties": {
|
|
2964
|
+
"_meta": {
|
|
2965
|
+
"additionalProperties": true,
|
|
2966
|
+
"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)",
|
|
2967
|
+
"type": ["object", "null"]
|
|
2968
|
+
},
|
|
2969
|
+
"availableModes": {
|
|
2970
|
+
"description": "The set of modes that the Agent can operate in",
|
|
2971
|
+
"items": {
|
|
2972
|
+
"$ref": "#/$defs/SessionMode"
|
|
2973
|
+
},
|
|
2974
|
+
"type": "array"
|
|
2975
|
+
},
|
|
2976
|
+
"currentModeId": {
|
|
2977
|
+
"allOf": [
|
|
2978
|
+
{
|
|
2979
|
+
"$ref": "#/$defs/SessionModeId"
|
|
2980
|
+
}
|
|
2981
|
+
],
|
|
2982
|
+
"description": "The current mode the Agent is in."
|
|
2983
|
+
}
|
|
2984
|
+
},
|
|
2985
|
+
"required": ["currentModeId", "availableModes"],
|
|
2986
|
+
"type": "object"
|
|
2987
|
+
},
|
|
2988
|
+
"SessionModelState": {
|
|
2989
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nThe set of models and the one currently active.",
|
|
2990
|
+
"properties": {
|
|
2991
|
+
"_meta": {
|
|
2992
|
+
"additionalProperties": true,
|
|
2993
|
+
"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)",
|
|
2994
|
+
"type": ["object", "null"]
|
|
2995
|
+
},
|
|
2996
|
+
"availableModels": {
|
|
2997
|
+
"description": "The set of models that the Agent can use",
|
|
2998
|
+
"items": {
|
|
2999
|
+
"$ref": "#/$defs/ModelInfo"
|
|
3000
|
+
},
|
|
3001
|
+
"type": "array"
|
|
3002
|
+
},
|
|
3003
|
+
"currentModelId": {
|
|
3004
|
+
"allOf": [
|
|
3005
|
+
{
|
|
3006
|
+
"$ref": "#/$defs/ModelId"
|
|
3007
|
+
}
|
|
3008
|
+
],
|
|
3009
|
+
"description": "The current model the Agent is in."
|
|
3010
|
+
}
|
|
3011
|
+
},
|
|
3012
|
+
"required": ["currentModelId", "availableModels"],
|
|
3013
|
+
"type": "object"
|
|
3014
|
+
},
|
|
3015
|
+
"SessionNotification": {
|
|
3016
|
+
"description": "Notification containing a session update from the agent.\n\nUsed to stream real-time progress and results during prompt processing.\n\nSee protocol docs: [Agent Reports Output](https://agentclientprotocol.com/protocol/prompt-turn#3-agent-reports-output)",
|
|
3017
|
+
"properties": {
|
|
3018
|
+
"_meta": {
|
|
3019
|
+
"additionalProperties": true,
|
|
3020
|
+
"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)",
|
|
3021
|
+
"type": ["object", "null"]
|
|
3022
|
+
},
|
|
3023
|
+
"sessionId": {
|
|
3024
|
+
"allOf": [
|
|
3025
|
+
{
|
|
3026
|
+
"$ref": "#/$defs/SessionId"
|
|
3027
|
+
}
|
|
3028
|
+
],
|
|
3029
|
+
"description": "The ID of the session this update pertains to."
|
|
3030
|
+
},
|
|
3031
|
+
"update": {
|
|
3032
|
+
"allOf": [
|
|
3033
|
+
{
|
|
3034
|
+
"$ref": "#/$defs/SessionUpdate"
|
|
3035
|
+
}
|
|
3036
|
+
],
|
|
3037
|
+
"description": "The actual update content."
|
|
3038
|
+
}
|
|
3039
|
+
},
|
|
3040
|
+
"required": ["sessionId", "update"],
|
|
3041
|
+
"type": "object",
|
|
3042
|
+
"x-method": "session/update",
|
|
3043
|
+
"x-side": "client"
|
|
3044
|
+
},
|
|
3045
|
+
"SessionResumeCapabilities": {
|
|
3046
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nCapabilities for the `session/resume` method.\n\nBy supplying `{}` it means that the agent supports resuming of sessions.",
|
|
3047
|
+
"properties": {
|
|
3048
|
+
"_meta": {
|
|
3049
|
+
"additionalProperties": true,
|
|
3050
|
+
"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)",
|
|
3051
|
+
"type": ["object", "null"]
|
|
3052
|
+
}
|
|
3053
|
+
},
|
|
3054
|
+
"type": "object"
|
|
3055
|
+
},
|
|
3056
|
+
"SessionUpdate": {
|
|
3057
|
+
"description": "Different types of updates that can be sent during session processing.\n\nThese updates provide real-time feedback about the agent's progress.\n\nSee protocol docs: [Agent Reports Output](https://agentclientprotocol.com/protocol/prompt-turn#3-agent-reports-output)",
|
|
3058
|
+
"discriminator": {
|
|
3059
|
+
"propertyName": "sessionUpdate"
|
|
3060
|
+
},
|
|
3061
|
+
"oneOf": [
|
|
3062
|
+
{
|
|
3063
|
+
"allOf": [
|
|
3064
|
+
{
|
|
3065
|
+
"$ref": "#/$defs/ContentChunk"
|
|
3066
|
+
}
|
|
3067
|
+
],
|
|
3068
|
+
"description": "A chunk of the user's message being streamed.",
|
|
3069
|
+
"properties": {
|
|
3070
|
+
"sessionUpdate": {
|
|
3071
|
+
"const": "user_message_chunk",
|
|
3072
|
+
"type": "string"
|
|
3073
|
+
}
|
|
3074
|
+
},
|
|
3075
|
+
"required": ["sessionUpdate"],
|
|
3076
|
+
"type": "object"
|
|
3077
|
+
},
|
|
3078
|
+
{
|
|
3079
|
+
"allOf": [
|
|
3080
|
+
{
|
|
3081
|
+
"$ref": "#/$defs/ContentChunk"
|
|
3082
|
+
}
|
|
3083
|
+
],
|
|
3084
|
+
"description": "A chunk of the agent's response being streamed.",
|
|
3085
|
+
"properties": {
|
|
3086
|
+
"sessionUpdate": {
|
|
3087
|
+
"const": "agent_message_chunk",
|
|
3088
|
+
"type": "string"
|
|
3089
|
+
}
|
|
3090
|
+
},
|
|
3091
|
+
"required": ["sessionUpdate"],
|
|
3092
|
+
"type": "object"
|
|
3093
|
+
},
|
|
3094
|
+
{
|
|
3095
|
+
"allOf": [
|
|
3096
|
+
{
|
|
3097
|
+
"$ref": "#/$defs/ContentChunk"
|
|
3098
|
+
}
|
|
3099
|
+
],
|
|
3100
|
+
"description": "A chunk of the agent's internal reasoning being streamed.",
|
|
3101
|
+
"properties": {
|
|
3102
|
+
"sessionUpdate": {
|
|
3103
|
+
"const": "agent_thought_chunk",
|
|
3104
|
+
"type": "string"
|
|
3105
|
+
}
|
|
3106
|
+
},
|
|
3107
|
+
"required": ["sessionUpdate"],
|
|
3108
|
+
"type": "object"
|
|
3109
|
+
},
|
|
3110
|
+
{
|
|
3111
|
+
"allOf": [
|
|
3112
|
+
{
|
|
3113
|
+
"$ref": "#/$defs/ToolCall"
|
|
3114
|
+
}
|
|
3115
|
+
],
|
|
3116
|
+
"description": "Notification that a new tool call has been initiated.",
|
|
3117
|
+
"properties": {
|
|
3118
|
+
"sessionUpdate": {
|
|
3119
|
+
"const": "tool_call",
|
|
3120
|
+
"type": "string"
|
|
3121
|
+
}
|
|
3122
|
+
},
|
|
3123
|
+
"required": ["sessionUpdate"],
|
|
3124
|
+
"type": "object"
|
|
3125
|
+
},
|
|
3126
|
+
{
|
|
3127
|
+
"allOf": [
|
|
3128
|
+
{
|
|
3129
|
+
"$ref": "#/$defs/ToolCallUpdate"
|
|
3130
|
+
}
|
|
3131
|
+
],
|
|
3132
|
+
"description": "Update on the status or results of a tool call.",
|
|
3133
|
+
"properties": {
|
|
3134
|
+
"sessionUpdate": {
|
|
3135
|
+
"const": "tool_call_update",
|
|
3136
|
+
"type": "string"
|
|
3137
|
+
}
|
|
3138
|
+
},
|
|
3139
|
+
"required": ["sessionUpdate"],
|
|
3140
|
+
"type": "object"
|
|
3141
|
+
},
|
|
3142
|
+
{
|
|
3143
|
+
"allOf": [
|
|
3144
|
+
{
|
|
3145
|
+
"$ref": "#/$defs/Plan"
|
|
3146
|
+
}
|
|
3147
|
+
],
|
|
3148
|
+
"description": "The agent's execution plan for complex tasks.\nSee protocol docs: [Agent Plan](https://agentclientprotocol.com/protocol/agent-plan)",
|
|
3149
|
+
"properties": {
|
|
3150
|
+
"sessionUpdate": {
|
|
3151
|
+
"const": "plan",
|
|
3152
|
+
"type": "string"
|
|
3153
|
+
}
|
|
3154
|
+
},
|
|
3155
|
+
"required": ["sessionUpdate"],
|
|
3156
|
+
"type": "object"
|
|
3157
|
+
},
|
|
3158
|
+
{
|
|
3159
|
+
"allOf": [
|
|
3160
|
+
{
|
|
3161
|
+
"$ref": "#/$defs/AvailableCommandsUpdate"
|
|
3162
|
+
}
|
|
3163
|
+
],
|
|
3164
|
+
"description": "Available commands are ready or have changed",
|
|
3165
|
+
"properties": {
|
|
3166
|
+
"sessionUpdate": {
|
|
3167
|
+
"const": "available_commands_update",
|
|
3168
|
+
"type": "string"
|
|
3169
|
+
}
|
|
3170
|
+
},
|
|
3171
|
+
"required": ["sessionUpdate"],
|
|
3172
|
+
"type": "object"
|
|
3173
|
+
},
|
|
3174
|
+
{
|
|
3175
|
+
"allOf": [
|
|
3176
|
+
{
|
|
3177
|
+
"$ref": "#/$defs/CurrentModeUpdate"
|
|
3178
|
+
}
|
|
3179
|
+
],
|
|
3180
|
+
"description": "The current mode of the session has changed\n\nSee protocol docs: [Session Modes](https://agentclientprotocol.com/protocol/session-modes)",
|
|
3181
|
+
"properties": {
|
|
3182
|
+
"sessionUpdate": {
|
|
3183
|
+
"const": "current_mode_update",
|
|
3184
|
+
"type": "string"
|
|
3185
|
+
}
|
|
3186
|
+
},
|
|
3187
|
+
"required": ["sessionUpdate"],
|
|
3188
|
+
"type": "object"
|
|
3189
|
+
},
|
|
3190
|
+
{
|
|
3191
|
+
"allOf": [
|
|
3192
|
+
{
|
|
3193
|
+
"$ref": "#/$defs/ConfigOptionUpdate"
|
|
3194
|
+
}
|
|
3195
|
+
],
|
|
3196
|
+
"description": "Session configuration options have been updated.",
|
|
3197
|
+
"properties": {
|
|
3198
|
+
"sessionUpdate": {
|
|
3199
|
+
"const": "config_option_update",
|
|
3200
|
+
"type": "string"
|
|
3201
|
+
}
|
|
3202
|
+
},
|
|
3203
|
+
"required": ["sessionUpdate"],
|
|
3204
|
+
"type": "object"
|
|
3205
|
+
},
|
|
3206
|
+
{
|
|
3207
|
+
"allOf": [
|
|
3208
|
+
{
|
|
3209
|
+
"$ref": "#/$defs/SessionInfoUpdate"
|
|
3210
|
+
}
|
|
3211
|
+
],
|
|
3212
|
+
"description": "Session metadata has been updated (title, timestamps, custom metadata)",
|
|
3213
|
+
"properties": {
|
|
3214
|
+
"sessionUpdate": {
|
|
3215
|
+
"const": "session_info_update",
|
|
3216
|
+
"type": "string"
|
|
3217
|
+
}
|
|
3218
|
+
},
|
|
3219
|
+
"required": ["sessionUpdate"],
|
|
3220
|
+
"type": "object"
|
|
3221
|
+
},
|
|
3222
|
+
{
|
|
3223
|
+
"allOf": [
|
|
3224
|
+
{
|
|
3225
|
+
"$ref": "#/$defs/UsageUpdate"
|
|
3226
|
+
}
|
|
3227
|
+
],
|
|
3228
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nContext window and cost update for the session.",
|
|
3229
|
+
"properties": {
|
|
3230
|
+
"sessionUpdate": {
|
|
3231
|
+
"const": "usage_update",
|
|
3232
|
+
"type": "string"
|
|
3233
|
+
}
|
|
3234
|
+
},
|
|
3235
|
+
"required": ["sessionUpdate"],
|
|
3236
|
+
"type": "object"
|
|
3237
|
+
}
|
|
3238
|
+
]
|
|
3239
|
+
},
|
|
3240
|
+
"SetSessionConfigOptionRequest": {
|
|
3241
|
+
"description": "Request parameters for setting a session configuration option.",
|
|
3242
|
+
"properties": {
|
|
3243
|
+
"_meta": {
|
|
3244
|
+
"additionalProperties": true,
|
|
3245
|
+
"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)",
|
|
3246
|
+
"type": ["object", "null"]
|
|
3247
|
+
},
|
|
3248
|
+
"configId": {
|
|
3249
|
+
"allOf": [
|
|
3250
|
+
{
|
|
3251
|
+
"$ref": "#/$defs/SessionConfigId"
|
|
3252
|
+
}
|
|
3253
|
+
],
|
|
3254
|
+
"description": "The ID of the configuration option to set."
|
|
3255
|
+
},
|
|
3256
|
+
"sessionId": {
|
|
3257
|
+
"allOf": [
|
|
3258
|
+
{
|
|
3259
|
+
"$ref": "#/$defs/SessionId"
|
|
3260
|
+
}
|
|
3261
|
+
],
|
|
3262
|
+
"description": "The ID of the session to set the configuration option for."
|
|
3263
|
+
},
|
|
3264
|
+
"value": {
|
|
3265
|
+
"allOf": [
|
|
3266
|
+
{
|
|
3267
|
+
"$ref": "#/$defs/SessionConfigValueId"
|
|
3268
|
+
}
|
|
3269
|
+
],
|
|
3270
|
+
"description": "The ID of the configuration option value to set."
|
|
3271
|
+
}
|
|
3272
|
+
},
|
|
3273
|
+
"required": ["sessionId", "configId", "value"],
|
|
3274
|
+
"type": "object",
|
|
3275
|
+
"x-method": "session/set_config_option",
|
|
3276
|
+
"x-side": "agent"
|
|
3277
|
+
},
|
|
3278
|
+
"SetSessionConfigOptionResponse": {
|
|
3279
|
+
"description": "Response to `session/set_config_option` method.",
|
|
3280
|
+
"properties": {
|
|
3281
|
+
"_meta": {
|
|
3282
|
+
"additionalProperties": true,
|
|
3283
|
+
"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)",
|
|
3284
|
+
"type": ["object", "null"]
|
|
3285
|
+
},
|
|
3286
|
+
"configOptions": {
|
|
3287
|
+
"description": "The full set of configuration options and their current values.",
|
|
3288
|
+
"items": {
|
|
3289
|
+
"$ref": "#/$defs/SessionConfigOption"
|
|
3290
|
+
},
|
|
3291
|
+
"type": "array"
|
|
3292
|
+
}
|
|
3293
|
+
},
|
|
3294
|
+
"required": ["configOptions"],
|
|
3295
|
+
"type": "object",
|
|
3296
|
+
"x-method": "session/set_config_option",
|
|
3297
|
+
"x-side": "agent"
|
|
3298
|
+
},
|
|
3299
|
+
"SetSessionModeRequest": {
|
|
3300
|
+
"description": "Request parameters for setting a session mode.",
|
|
3301
|
+
"properties": {
|
|
3302
|
+
"_meta": {
|
|
3303
|
+
"additionalProperties": true,
|
|
3304
|
+
"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)",
|
|
3305
|
+
"type": ["object", "null"]
|
|
3306
|
+
},
|
|
3307
|
+
"modeId": {
|
|
3308
|
+
"allOf": [
|
|
3309
|
+
{
|
|
3310
|
+
"$ref": "#/$defs/SessionModeId"
|
|
3311
|
+
}
|
|
3312
|
+
],
|
|
3313
|
+
"description": "The ID of the mode to set."
|
|
3314
|
+
},
|
|
3315
|
+
"sessionId": {
|
|
3316
|
+
"allOf": [
|
|
3317
|
+
{
|
|
3318
|
+
"$ref": "#/$defs/SessionId"
|
|
3319
|
+
}
|
|
3320
|
+
],
|
|
3321
|
+
"description": "The ID of the session to set the mode for."
|
|
3322
|
+
}
|
|
3323
|
+
},
|
|
3324
|
+
"required": ["sessionId", "modeId"],
|
|
3325
|
+
"type": "object",
|
|
3326
|
+
"x-method": "session/set_mode",
|
|
3327
|
+
"x-side": "agent"
|
|
3328
|
+
},
|
|
3329
|
+
"SetSessionModeResponse": {
|
|
3330
|
+
"description": "Response to `session/set_mode` method.",
|
|
3331
|
+
"properties": {
|
|
3332
|
+
"_meta": {
|
|
3333
|
+
"additionalProperties": true,
|
|
3334
|
+
"type": ["object", "null"]
|
|
3335
|
+
}
|
|
3336
|
+
},
|
|
3337
|
+
"type": "object",
|
|
3338
|
+
"x-method": "session/set_mode",
|
|
3339
|
+
"x-side": "agent"
|
|
3340
|
+
},
|
|
3341
|
+
"SetSessionModelRequest": {
|
|
3342
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nRequest parameters for setting a session model.",
|
|
3343
|
+
"properties": {
|
|
3344
|
+
"_meta": {
|
|
3345
|
+
"additionalProperties": true,
|
|
3346
|
+
"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)",
|
|
3347
|
+
"type": ["object", "null"]
|
|
3348
|
+
},
|
|
3349
|
+
"modelId": {
|
|
3350
|
+
"allOf": [
|
|
3351
|
+
{
|
|
3352
|
+
"$ref": "#/$defs/ModelId"
|
|
3353
|
+
}
|
|
3354
|
+
],
|
|
3355
|
+
"description": "The ID of the model to set."
|
|
3356
|
+
},
|
|
3357
|
+
"sessionId": {
|
|
3358
|
+
"allOf": [
|
|
3359
|
+
{
|
|
3360
|
+
"$ref": "#/$defs/SessionId"
|
|
3361
|
+
}
|
|
3362
|
+
],
|
|
3363
|
+
"description": "The ID of the session to set the model for."
|
|
3364
|
+
}
|
|
3365
|
+
},
|
|
3366
|
+
"required": ["sessionId", "modelId"],
|
|
3367
|
+
"type": "object",
|
|
3368
|
+
"x-method": "session/set_model",
|
|
3369
|
+
"x-side": "agent"
|
|
3370
|
+
},
|
|
3371
|
+
"SetSessionModelResponse": {
|
|
3372
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nResponse to `session/set_model` method.",
|
|
3373
|
+
"properties": {
|
|
3374
|
+
"_meta": {
|
|
3375
|
+
"additionalProperties": true,
|
|
3376
|
+
"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)",
|
|
3377
|
+
"type": ["object", "null"]
|
|
3378
|
+
}
|
|
3379
|
+
},
|
|
3380
|
+
"type": "object",
|
|
3381
|
+
"x-method": "session/set_model",
|
|
3382
|
+
"x-side": "agent"
|
|
3383
|
+
},
|
|
3384
|
+
"StopReason": {
|
|
3385
|
+
"description": "Reasons why an agent stops processing a prompt turn.\n\nSee protocol docs: [Stop Reasons](https://agentclientprotocol.com/protocol/prompt-turn#stop-reasons)",
|
|
3386
|
+
"oneOf": [
|
|
3387
|
+
{
|
|
3388
|
+
"const": "end_turn",
|
|
3389
|
+
"description": "The turn ended successfully.",
|
|
3390
|
+
"type": "string"
|
|
3391
|
+
},
|
|
3392
|
+
{
|
|
3393
|
+
"const": "max_tokens",
|
|
3394
|
+
"description": "The turn ended because the agent reached the maximum number of tokens.",
|
|
3395
|
+
"type": "string"
|
|
3396
|
+
},
|
|
3397
|
+
{
|
|
3398
|
+
"const": "max_turn_requests",
|
|
3399
|
+
"description": "The turn ended because the agent reached the maximum number of allowed\nagent requests between user turns.",
|
|
3400
|
+
"type": "string"
|
|
3401
|
+
},
|
|
3402
|
+
{
|
|
3403
|
+
"const": "refusal",
|
|
3404
|
+
"description": "The turn ended because the agent refused to continue. The user prompt\nand everything that comes after it won't be included in the next\nprompt, so this should be reflected in the UI.",
|
|
3405
|
+
"type": "string"
|
|
3406
|
+
},
|
|
3407
|
+
{
|
|
3408
|
+
"const": "cancelled",
|
|
3409
|
+
"description": "The turn was cancelled by the client via `session/cancel`.\n\nThis stop reason MUST be returned when the client sends a `session/cancel`\nnotification, even if the cancellation causes exceptions in underlying operations.\nAgents should catch these exceptions and return this semantically meaningful\nresponse to confirm successful cancellation.",
|
|
3410
|
+
"type": "string"
|
|
3411
|
+
}
|
|
3412
|
+
]
|
|
3413
|
+
},
|
|
3414
|
+
"Terminal": {
|
|
3415
|
+
"description": "Embed a terminal created with `terminal/create` by its id.\n\nThe terminal must be added before calling `terminal/release`.\n\nSee protocol docs: [Terminal](https://agentclientprotocol.com/protocol/terminals)",
|
|
3416
|
+
"properties": {
|
|
3417
|
+
"_meta": {
|
|
3418
|
+
"additionalProperties": true,
|
|
3419
|
+
"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)",
|
|
3420
|
+
"type": ["object", "null"]
|
|
3421
|
+
},
|
|
3422
|
+
"terminalId": {
|
|
3423
|
+
"type": "string"
|
|
3424
|
+
}
|
|
3425
|
+
},
|
|
3426
|
+
"required": ["terminalId"],
|
|
3427
|
+
"type": "object"
|
|
3428
|
+
},
|
|
3429
|
+
"TerminalExitStatus": {
|
|
3430
|
+
"description": "Exit status of a terminal command.",
|
|
3431
|
+
"properties": {
|
|
3432
|
+
"_meta": {
|
|
3433
|
+
"additionalProperties": true,
|
|
3434
|
+
"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)",
|
|
3435
|
+
"type": ["object", "null"]
|
|
3436
|
+
},
|
|
3437
|
+
"exitCode": {
|
|
3438
|
+
"description": "The process exit code (may be null if terminated by signal).",
|
|
3439
|
+
"format": "uint32",
|
|
3440
|
+
"minimum": 0,
|
|
3441
|
+
"type": ["integer", "null"]
|
|
3442
|
+
},
|
|
3443
|
+
"signal": {
|
|
3444
|
+
"description": "The signal that terminated the process (may be null if exited normally).",
|
|
3445
|
+
"type": ["string", "null"]
|
|
3446
|
+
}
|
|
3447
|
+
},
|
|
3448
|
+
"type": "object"
|
|
3449
|
+
},
|
|
3450
|
+
"TerminalOutputRequest": {
|
|
3451
|
+
"description": "Request to get the current output and status of a terminal.",
|
|
3452
|
+
"properties": {
|
|
3453
|
+
"_meta": {
|
|
3454
|
+
"additionalProperties": true,
|
|
3455
|
+
"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)",
|
|
3456
|
+
"type": ["object", "null"]
|
|
3457
|
+
},
|
|
3458
|
+
"sessionId": {
|
|
3459
|
+
"allOf": [
|
|
3460
|
+
{
|
|
3461
|
+
"$ref": "#/$defs/SessionId"
|
|
3462
|
+
}
|
|
3463
|
+
],
|
|
3464
|
+
"description": "The session ID for this request."
|
|
3465
|
+
},
|
|
3466
|
+
"terminalId": {
|
|
3467
|
+
"description": "The ID of the terminal to get output from.",
|
|
3468
|
+
"type": "string"
|
|
3469
|
+
}
|
|
3470
|
+
},
|
|
3471
|
+
"required": ["sessionId", "terminalId"],
|
|
3472
|
+
"type": "object",
|
|
3473
|
+
"x-method": "terminal/output",
|
|
3474
|
+
"x-side": "client"
|
|
3475
|
+
},
|
|
3476
|
+
"TerminalOutputResponse": {
|
|
3477
|
+
"description": "Response containing the terminal output and exit status.",
|
|
3478
|
+
"properties": {
|
|
3479
|
+
"_meta": {
|
|
3480
|
+
"additionalProperties": true,
|
|
3481
|
+
"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)",
|
|
3482
|
+
"type": ["object", "null"]
|
|
3483
|
+
},
|
|
3484
|
+
"exitStatus": {
|
|
3485
|
+
"anyOf": [
|
|
3486
|
+
{
|
|
3487
|
+
"$ref": "#/$defs/TerminalExitStatus"
|
|
3488
|
+
},
|
|
3489
|
+
{
|
|
3490
|
+
"type": "null"
|
|
3491
|
+
}
|
|
3492
|
+
],
|
|
3493
|
+
"description": "Exit status if the command has completed."
|
|
3494
|
+
},
|
|
3495
|
+
"output": {
|
|
3496
|
+
"description": "The terminal output captured so far.",
|
|
3497
|
+
"type": "string"
|
|
3498
|
+
},
|
|
3499
|
+
"truncated": {
|
|
3500
|
+
"description": "Whether the output was truncated due to byte limits.",
|
|
3501
|
+
"type": "boolean"
|
|
3502
|
+
}
|
|
3503
|
+
},
|
|
3504
|
+
"required": ["output", "truncated"],
|
|
3505
|
+
"type": "object",
|
|
3506
|
+
"x-method": "terminal/output",
|
|
3507
|
+
"x-side": "client"
|
|
3508
|
+
},
|
|
3509
|
+
"TextContent": {
|
|
3510
|
+
"description": "Text provided to or from an LLM.",
|
|
3511
|
+
"properties": {
|
|
3512
|
+
"_meta": {
|
|
3513
|
+
"additionalProperties": true,
|
|
3514
|
+
"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)",
|
|
3515
|
+
"type": ["object", "null"]
|
|
3516
|
+
},
|
|
3517
|
+
"annotations": {
|
|
3518
|
+
"anyOf": [
|
|
3519
|
+
{
|
|
3520
|
+
"$ref": "#/$defs/Annotations"
|
|
3521
|
+
},
|
|
3522
|
+
{
|
|
3523
|
+
"type": "null"
|
|
3524
|
+
}
|
|
3525
|
+
]
|
|
3526
|
+
},
|
|
3527
|
+
"text": {
|
|
3528
|
+
"type": "string"
|
|
3529
|
+
}
|
|
3530
|
+
},
|
|
3531
|
+
"required": ["text"],
|
|
3532
|
+
"type": "object"
|
|
3533
|
+
},
|
|
3534
|
+
"TextResourceContents": {
|
|
3535
|
+
"description": "Text-based resource contents.",
|
|
3536
|
+
"properties": {
|
|
3537
|
+
"_meta": {
|
|
3538
|
+
"additionalProperties": true,
|
|
3539
|
+
"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)",
|
|
3540
|
+
"type": ["object", "null"]
|
|
3541
|
+
},
|
|
3542
|
+
"mimeType": {
|
|
3543
|
+
"type": ["string", "null"]
|
|
3544
|
+
},
|
|
3545
|
+
"text": {
|
|
3546
|
+
"type": "string"
|
|
3547
|
+
},
|
|
3548
|
+
"uri": {
|
|
3549
|
+
"type": "string"
|
|
3550
|
+
}
|
|
3551
|
+
},
|
|
3552
|
+
"required": ["text", "uri"],
|
|
3553
|
+
"type": "object"
|
|
3554
|
+
},
|
|
3555
|
+
"ToolCall": {
|
|
3556
|
+
"description": "Represents a tool call that the language model has requested.\n\nTool calls are actions that the agent executes on behalf of the language model,\nsuch as reading files, executing code, or fetching data from external sources.\n\nSee protocol docs: [Tool Calls](https://agentclientprotocol.com/protocol/tool-calls)",
|
|
3557
|
+
"properties": {
|
|
3558
|
+
"_meta": {
|
|
3559
|
+
"additionalProperties": true,
|
|
3560
|
+
"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)",
|
|
3561
|
+
"type": ["object", "null"]
|
|
3562
|
+
},
|
|
3563
|
+
"content": {
|
|
3564
|
+
"description": "Content produced by the tool call.",
|
|
3565
|
+
"items": {
|
|
3566
|
+
"$ref": "#/$defs/ToolCallContent"
|
|
3567
|
+
},
|
|
3568
|
+
"type": "array"
|
|
3569
|
+
},
|
|
3570
|
+
"kind": {
|
|
3571
|
+
"allOf": [
|
|
3572
|
+
{
|
|
3573
|
+
"$ref": "#/$defs/ToolKind"
|
|
3574
|
+
}
|
|
3575
|
+
],
|
|
3576
|
+
"description": "The category of tool being invoked.\nHelps clients choose appropriate icons and UI treatment."
|
|
3577
|
+
},
|
|
3578
|
+
"locations": {
|
|
3579
|
+
"description": "File locations affected by this tool call.\nEnables \"follow-along\" features in clients.",
|
|
3580
|
+
"items": {
|
|
3581
|
+
"$ref": "#/$defs/ToolCallLocation"
|
|
3582
|
+
},
|
|
3583
|
+
"type": "array"
|
|
3584
|
+
},
|
|
3585
|
+
"rawInput": {
|
|
3586
|
+
"description": "Raw input parameters sent to the tool."
|
|
3587
|
+
},
|
|
3588
|
+
"rawOutput": {
|
|
3589
|
+
"description": "Raw output returned by the tool."
|
|
3590
|
+
},
|
|
3591
|
+
"status": {
|
|
3592
|
+
"allOf": [
|
|
3593
|
+
{
|
|
3594
|
+
"$ref": "#/$defs/ToolCallStatus"
|
|
3595
|
+
}
|
|
3596
|
+
],
|
|
3597
|
+
"description": "Current execution status of the tool call."
|
|
3598
|
+
},
|
|
3599
|
+
"title": {
|
|
3600
|
+
"description": "Human-readable title describing what the tool is doing.",
|
|
3601
|
+
"type": "string"
|
|
3602
|
+
},
|
|
3603
|
+
"toolCallId": {
|
|
3604
|
+
"allOf": [
|
|
3605
|
+
{
|
|
3606
|
+
"$ref": "#/$defs/ToolCallId"
|
|
3607
|
+
}
|
|
3608
|
+
],
|
|
3609
|
+
"description": "Unique identifier for this tool call within the session."
|
|
3610
|
+
}
|
|
3611
|
+
},
|
|
3612
|
+
"required": ["toolCallId", "title"],
|
|
3613
|
+
"type": "object"
|
|
3614
|
+
},
|
|
3615
|
+
"ToolCallContent": {
|
|
3616
|
+
"description": "Content produced by a tool call.\n\nTool calls can produce different types of content including\nstandard content blocks (text, images) or file diffs.\n\nSee protocol docs: [Content](https://agentclientprotocol.com/protocol/tool-calls#content)",
|
|
3617
|
+
"discriminator": {
|
|
3618
|
+
"propertyName": "type"
|
|
3619
|
+
},
|
|
3620
|
+
"oneOf": [
|
|
3621
|
+
{
|
|
3622
|
+
"allOf": [
|
|
3623
|
+
{
|
|
3624
|
+
"$ref": "#/$defs/Content"
|
|
3625
|
+
}
|
|
3626
|
+
],
|
|
3627
|
+
"description": "Standard content block (text, images, resources).",
|
|
3628
|
+
"properties": {
|
|
3629
|
+
"type": {
|
|
3630
|
+
"const": "content",
|
|
3631
|
+
"type": "string"
|
|
3632
|
+
}
|
|
3633
|
+
},
|
|
3634
|
+
"required": ["type"],
|
|
3635
|
+
"type": "object"
|
|
3636
|
+
},
|
|
3637
|
+
{
|
|
3638
|
+
"allOf": [
|
|
3639
|
+
{
|
|
3640
|
+
"$ref": "#/$defs/Diff"
|
|
3641
|
+
}
|
|
3642
|
+
],
|
|
3643
|
+
"description": "File modification shown as a diff.",
|
|
3644
|
+
"properties": {
|
|
3645
|
+
"type": {
|
|
3646
|
+
"const": "diff",
|
|
3647
|
+
"type": "string"
|
|
3648
|
+
}
|
|
3649
|
+
},
|
|
3650
|
+
"required": ["type"],
|
|
3651
|
+
"type": "object"
|
|
3652
|
+
},
|
|
3653
|
+
{
|
|
3654
|
+
"allOf": [
|
|
3655
|
+
{
|
|
3656
|
+
"$ref": "#/$defs/Terminal"
|
|
3657
|
+
}
|
|
3658
|
+
],
|
|
3659
|
+
"description": "Embed a terminal created with `terminal/create` by its id.\n\nThe terminal must be added before calling `terminal/release`.\n\nSee protocol docs: [Terminal](https://agentclientprotocol.com/protocol/terminals)",
|
|
3660
|
+
"properties": {
|
|
3661
|
+
"type": {
|
|
3662
|
+
"const": "terminal",
|
|
3663
|
+
"type": "string"
|
|
3664
|
+
}
|
|
3665
|
+
},
|
|
3666
|
+
"required": ["type"],
|
|
3667
|
+
"type": "object"
|
|
3668
|
+
}
|
|
3669
|
+
]
|
|
3670
|
+
},
|
|
3671
|
+
"ToolCallId": {
|
|
3672
|
+
"description": "Unique identifier for a tool call within a session.",
|
|
3673
|
+
"type": "string"
|
|
3674
|
+
},
|
|
3675
|
+
"ToolCallLocation": {
|
|
3676
|
+
"description": "A file location being accessed or modified by a tool.\n\nEnables clients to implement \"follow-along\" features that track\nwhich files the agent is working with in real-time.\n\nSee protocol docs: [Following the Agent](https://agentclientprotocol.com/protocol/tool-calls#following-the-agent)",
|
|
3677
|
+
"properties": {
|
|
3678
|
+
"_meta": {
|
|
3679
|
+
"additionalProperties": true,
|
|
3680
|
+
"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)",
|
|
3681
|
+
"type": ["object", "null"]
|
|
3682
|
+
},
|
|
3683
|
+
"line": {
|
|
3684
|
+
"description": "Optional line number within the file.",
|
|
3685
|
+
"format": "uint32",
|
|
3686
|
+
"minimum": 0,
|
|
3687
|
+
"type": ["integer", "null"]
|
|
3688
|
+
},
|
|
3689
|
+
"path": {
|
|
3690
|
+
"description": "The file path being accessed or modified.",
|
|
3691
|
+
"type": "string"
|
|
3692
|
+
}
|
|
3693
|
+
},
|
|
3694
|
+
"required": ["path"],
|
|
3695
|
+
"type": "object"
|
|
3696
|
+
},
|
|
3697
|
+
"ToolCallStatus": {
|
|
3698
|
+
"description": "Execution status of a tool call.\n\nTool calls progress through different statuses during their lifecycle.\n\nSee protocol docs: [Status](https://agentclientprotocol.com/protocol/tool-calls#status)",
|
|
3699
|
+
"oneOf": [
|
|
3700
|
+
{
|
|
3701
|
+
"const": "pending",
|
|
3702
|
+
"description": "The tool call hasn't started running yet because the input is either\nstreaming or we're awaiting approval.",
|
|
3703
|
+
"type": "string"
|
|
3704
|
+
},
|
|
3705
|
+
{
|
|
3706
|
+
"const": "in_progress",
|
|
3707
|
+
"description": "The tool call is currently running.",
|
|
3708
|
+
"type": "string"
|
|
3709
|
+
},
|
|
3710
|
+
{
|
|
3711
|
+
"const": "completed",
|
|
3712
|
+
"description": "The tool call completed successfully.",
|
|
3713
|
+
"type": "string"
|
|
3714
|
+
},
|
|
3715
|
+
{
|
|
3716
|
+
"const": "failed",
|
|
3717
|
+
"description": "The tool call failed with an error.",
|
|
3718
|
+
"type": "string"
|
|
3719
|
+
}
|
|
3720
|
+
]
|
|
3721
|
+
},
|
|
3722
|
+
"ToolCallUpdate": {
|
|
3723
|
+
"description": "An update to an existing tool call.\n\nUsed to report progress and results as tools execute. All fields except\nthe tool call ID are optional - only changed fields need to be included.\n\nSee protocol docs: [Updating](https://agentclientprotocol.com/protocol/tool-calls#updating)",
|
|
3724
|
+
"properties": {
|
|
3725
|
+
"_meta": {
|
|
3726
|
+
"additionalProperties": true,
|
|
3727
|
+
"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)",
|
|
3728
|
+
"type": ["object", "null"]
|
|
3729
|
+
},
|
|
3730
|
+
"content": {
|
|
3731
|
+
"description": "Replace the content collection.",
|
|
3732
|
+
"items": {
|
|
3733
|
+
"$ref": "#/$defs/ToolCallContent"
|
|
3734
|
+
},
|
|
3735
|
+
"type": ["array", "null"]
|
|
3736
|
+
},
|
|
3737
|
+
"kind": {
|
|
3738
|
+
"anyOf": [
|
|
3739
|
+
{
|
|
3740
|
+
"$ref": "#/$defs/ToolKind"
|
|
3741
|
+
},
|
|
3742
|
+
{
|
|
3743
|
+
"type": "null"
|
|
3744
|
+
}
|
|
3745
|
+
],
|
|
3746
|
+
"description": "Update the tool kind."
|
|
3747
|
+
},
|
|
3748
|
+
"locations": {
|
|
3749
|
+
"description": "Replace the locations collection.",
|
|
3750
|
+
"items": {
|
|
3751
|
+
"$ref": "#/$defs/ToolCallLocation"
|
|
3752
|
+
},
|
|
3753
|
+
"type": ["array", "null"]
|
|
3754
|
+
},
|
|
3755
|
+
"rawInput": {
|
|
3756
|
+
"description": "Update the raw input."
|
|
3757
|
+
},
|
|
3758
|
+
"rawOutput": {
|
|
3759
|
+
"description": "Update the raw output."
|
|
3760
|
+
},
|
|
3761
|
+
"status": {
|
|
3762
|
+
"anyOf": [
|
|
3763
|
+
{
|
|
3764
|
+
"$ref": "#/$defs/ToolCallStatus"
|
|
3765
|
+
},
|
|
3766
|
+
{
|
|
3767
|
+
"type": "null"
|
|
3768
|
+
}
|
|
3769
|
+
],
|
|
3770
|
+
"description": "Update the execution status."
|
|
3771
|
+
},
|
|
3772
|
+
"title": {
|
|
3773
|
+
"description": "Update the human-readable title.",
|
|
3774
|
+
"type": ["string", "null"]
|
|
3775
|
+
},
|
|
3776
|
+
"toolCallId": {
|
|
3777
|
+
"allOf": [
|
|
3778
|
+
{
|
|
3779
|
+
"$ref": "#/$defs/ToolCallId"
|
|
3780
|
+
}
|
|
3781
|
+
],
|
|
3782
|
+
"description": "The ID of the tool call being updated."
|
|
3783
|
+
}
|
|
3784
|
+
},
|
|
3785
|
+
"required": ["toolCallId"],
|
|
3786
|
+
"type": "object"
|
|
3787
|
+
},
|
|
3788
|
+
"ToolKind": {
|
|
3789
|
+
"description": "Categories of tools that can be invoked.\n\nTool kinds help clients choose appropriate icons and optimize how they\ndisplay tool execution progress.\n\nSee protocol docs: [Creating](https://agentclientprotocol.com/protocol/tool-calls#creating)",
|
|
3790
|
+
"oneOf": [
|
|
3791
|
+
{
|
|
3792
|
+
"const": "read",
|
|
3793
|
+
"description": "Reading files or data.",
|
|
3794
|
+
"type": "string"
|
|
3795
|
+
},
|
|
3796
|
+
{
|
|
3797
|
+
"const": "edit",
|
|
3798
|
+
"description": "Modifying files or content.",
|
|
3799
|
+
"type": "string"
|
|
3800
|
+
},
|
|
3801
|
+
{
|
|
3802
|
+
"const": "delete",
|
|
3803
|
+
"description": "Removing files or data.",
|
|
3804
|
+
"type": "string"
|
|
3805
|
+
},
|
|
3806
|
+
{
|
|
3807
|
+
"const": "move",
|
|
3808
|
+
"description": "Moving or renaming files.",
|
|
3809
|
+
"type": "string"
|
|
3810
|
+
},
|
|
3811
|
+
{
|
|
3812
|
+
"const": "search",
|
|
3813
|
+
"description": "Searching for information.",
|
|
3814
|
+
"type": "string"
|
|
3815
|
+
},
|
|
3816
|
+
{
|
|
3817
|
+
"const": "execute",
|
|
3818
|
+
"description": "Running commands or code.",
|
|
3819
|
+
"type": "string"
|
|
3820
|
+
},
|
|
3821
|
+
{
|
|
3822
|
+
"const": "think",
|
|
3823
|
+
"description": "Internal reasoning or planning.",
|
|
3824
|
+
"type": "string"
|
|
3825
|
+
},
|
|
3826
|
+
{
|
|
3827
|
+
"const": "fetch",
|
|
3828
|
+
"description": "Retrieving external data.",
|
|
3829
|
+
"type": "string"
|
|
3830
|
+
},
|
|
3831
|
+
{
|
|
3832
|
+
"const": "switch_mode",
|
|
3833
|
+
"description": "Switching the current session mode.",
|
|
3834
|
+
"type": "string"
|
|
3835
|
+
},
|
|
3836
|
+
{
|
|
3837
|
+
"const": "other",
|
|
3838
|
+
"description": "Other tool types (default).",
|
|
3839
|
+
"type": "string"
|
|
3840
|
+
}
|
|
3841
|
+
]
|
|
3842
|
+
},
|
|
3843
|
+
"UnstructuredCommandInput": {
|
|
3844
|
+
"description": "All text that was typed after the command name is provided as input.",
|
|
3845
|
+
"properties": {
|
|
3846
|
+
"_meta": {
|
|
3847
|
+
"additionalProperties": true,
|
|
3848
|
+
"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)",
|
|
3849
|
+
"type": ["object", "null"]
|
|
3850
|
+
},
|
|
3851
|
+
"hint": {
|
|
3852
|
+
"description": "A hint to display when the input hasn't been provided yet",
|
|
3853
|
+
"type": "string"
|
|
3854
|
+
}
|
|
3855
|
+
},
|
|
3856
|
+
"required": ["hint"],
|
|
3857
|
+
"type": "object"
|
|
3858
|
+
},
|
|
3859
|
+
"Usage": {
|
|
3860
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nToken usage information for a prompt turn.",
|
|
3861
|
+
"properties": {
|
|
3862
|
+
"cachedReadTokens": {
|
|
3863
|
+
"description": "Total cache read tokens.",
|
|
3864
|
+
"format": "uint64",
|
|
3865
|
+
"minimum": 0,
|
|
3866
|
+
"type": ["integer", "null"]
|
|
3867
|
+
},
|
|
3868
|
+
"cachedWriteTokens": {
|
|
3869
|
+
"description": "Total cache write tokens.",
|
|
3870
|
+
"format": "uint64",
|
|
3871
|
+
"minimum": 0,
|
|
3872
|
+
"type": ["integer", "null"]
|
|
3873
|
+
},
|
|
3874
|
+
"inputTokens": {
|
|
3875
|
+
"description": "Total input tokens across all turns.",
|
|
3876
|
+
"format": "uint64",
|
|
3877
|
+
"minimum": 0,
|
|
3878
|
+
"type": "integer"
|
|
3879
|
+
},
|
|
3880
|
+
"outputTokens": {
|
|
3881
|
+
"description": "Total output tokens across all turns.",
|
|
3882
|
+
"format": "uint64",
|
|
3883
|
+
"minimum": 0,
|
|
3884
|
+
"type": "integer"
|
|
3885
|
+
},
|
|
3886
|
+
"thoughtTokens": {
|
|
3887
|
+
"description": "Total thought/reasoning tokens",
|
|
3888
|
+
"format": "uint64",
|
|
3889
|
+
"minimum": 0,
|
|
3890
|
+
"type": ["integer", "null"]
|
|
3891
|
+
},
|
|
3892
|
+
"totalTokens": {
|
|
3893
|
+
"description": "Sum of all token types across session.",
|
|
3894
|
+
"format": "uint64",
|
|
3895
|
+
"minimum": 0,
|
|
3896
|
+
"type": "integer"
|
|
3897
|
+
}
|
|
3898
|
+
},
|
|
3899
|
+
"required": ["totalTokens", "inputTokens", "outputTokens"],
|
|
3900
|
+
"type": "object"
|
|
3901
|
+
},
|
|
3902
|
+
"UsageUpdate": {
|
|
3903
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or changed at any point.\n\nContext window and cost update for a session.",
|
|
3904
|
+
"properties": {
|
|
3905
|
+
"_meta": {
|
|
3906
|
+
"additionalProperties": true,
|
|
3907
|
+
"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)",
|
|
3908
|
+
"type": ["object", "null"]
|
|
3909
|
+
},
|
|
3910
|
+
"cost": {
|
|
3911
|
+
"anyOf": [
|
|
3912
|
+
{
|
|
3913
|
+
"$ref": "#/$defs/Cost"
|
|
3914
|
+
},
|
|
3915
|
+
{
|
|
3916
|
+
"type": "null"
|
|
3917
|
+
}
|
|
3918
|
+
],
|
|
3919
|
+
"description": "Cumulative session cost (optional)."
|
|
3920
|
+
},
|
|
3921
|
+
"size": {
|
|
3922
|
+
"description": "Total context window size in tokens.",
|
|
3923
|
+
"format": "uint64",
|
|
3924
|
+
"minimum": 0,
|
|
3925
|
+
"type": "integer"
|
|
3926
|
+
},
|
|
3927
|
+
"used": {
|
|
3928
|
+
"description": "Tokens currently in context.",
|
|
3929
|
+
"format": "uint64",
|
|
3930
|
+
"minimum": 0,
|
|
3931
|
+
"type": "integer"
|
|
3932
|
+
}
|
|
3933
|
+
},
|
|
3934
|
+
"required": ["used", "size"],
|
|
3935
|
+
"type": "object"
|
|
3936
|
+
},
|
|
3937
|
+
"WaitForTerminalExitRequest": {
|
|
3938
|
+
"description": "Request to wait for a terminal command to exit.",
|
|
3939
|
+
"properties": {
|
|
3940
|
+
"_meta": {
|
|
3941
|
+
"additionalProperties": true,
|
|
3942
|
+
"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)",
|
|
3943
|
+
"type": ["object", "null"]
|
|
3944
|
+
},
|
|
3945
|
+
"sessionId": {
|
|
3946
|
+
"allOf": [
|
|
3947
|
+
{
|
|
3948
|
+
"$ref": "#/$defs/SessionId"
|
|
3949
|
+
}
|
|
3950
|
+
],
|
|
3951
|
+
"description": "The session ID for this request."
|
|
3952
|
+
},
|
|
3953
|
+
"terminalId": {
|
|
3954
|
+
"description": "The ID of the terminal to wait for.",
|
|
3955
|
+
"type": "string"
|
|
3956
|
+
}
|
|
3957
|
+
},
|
|
3958
|
+
"required": ["sessionId", "terminalId"],
|
|
3959
|
+
"type": "object",
|
|
3960
|
+
"x-method": "terminal/wait_for_exit",
|
|
3961
|
+
"x-side": "client"
|
|
3962
|
+
},
|
|
3963
|
+
"WaitForTerminalExitResponse": {
|
|
3964
|
+
"description": "Response containing the exit status of a terminal command.",
|
|
3965
|
+
"properties": {
|
|
3966
|
+
"_meta": {
|
|
3967
|
+
"additionalProperties": true,
|
|
3968
|
+
"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)",
|
|
3969
|
+
"type": ["object", "null"]
|
|
3970
|
+
},
|
|
3971
|
+
"exitCode": {
|
|
3972
|
+
"description": "The process exit code (may be null if terminated by signal).",
|
|
3973
|
+
"format": "uint32",
|
|
3974
|
+
"minimum": 0,
|
|
3975
|
+
"type": ["integer", "null"]
|
|
3976
|
+
},
|
|
3977
|
+
"signal": {
|
|
3978
|
+
"description": "The signal that terminated the process (may be null if exited normally).",
|
|
3979
|
+
"type": ["string", "null"]
|
|
3980
|
+
}
|
|
3981
|
+
},
|
|
3982
|
+
"type": "object",
|
|
3983
|
+
"x-method": "terminal/wait_for_exit",
|
|
3984
|
+
"x-side": "client"
|
|
3985
|
+
},
|
|
3986
|
+
"WriteTextFileRequest": {
|
|
3987
|
+
"description": "Request to write content to a text file.\n\nOnly available if the client supports the `fs.writeTextFile` capability.",
|
|
3988
|
+
"properties": {
|
|
3989
|
+
"_meta": {
|
|
3990
|
+
"additionalProperties": true,
|
|
3991
|
+
"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)",
|
|
3992
|
+
"type": ["object", "null"]
|
|
3993
|
+
},
|
|
3994
|
+
"content": {
|
|
3995
|
+
"description": "The text content to write to the file.",
|
|
3996
|
+
"type": "string"
|
|
3997
|
+
},
|
|
3998
|
+
"path": {
|
|
3999
|
+
"description": "Absolute path to the file to write.",
|
|
4000
|
+
"type": "string"
|
|
4001
|
+
},
|
|
4002
|
+
"sessionId": {
|
|
4003
|
+
"allOf": [
|
|
4004
|
+
{
|
|
4005
|
+
"$ref": "#/$defs/SessionId"
|
|
4006
|
+
}
|
|
4007
|
+
],
|
|
4008
|
+
"description": "The session ID for this request."
|
|
4009
|
+
}
|
|
4010
|
+
},
|
|
4011
|
+
"required": ["sessionId", "path", "content"],
|
|
4012
|
+
"type": "object",
|
|
4013
|
+
"x-method": "fs/write_text_file",
|
|
4014
|
+
"x-side": "client"
|
|
4015
|
+
},
|
|
4016
|
+
"WriteTextFileResponse": {
|
|
4017
|
+
"description": "Response to `fs/write_text_file`",
|
|
4018
|
+
"properties": {
|
|
4019
|
+
"_meta": {
|
|
4020
|
+
"additionalProperties": true,
|
|
4021
|
+
"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)",
|
|
4022
|
+
"type": ["object", "null"]
|
|
4023
|
+
}
|
|
4024
|
+
},
|
|
4025
|
+
"type": "object",
|
|
4026
|
+
"x-method": "fs/write_text_file",
|
|
4027
|
+
"x-side": "client"
|
|
4028
|
+
}
|
|
4029
|
+
},
|
|
4030
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
4031
|
+
"anyOf": [
|
|
4032
|
+
{
|
|
4033
|
+
"anyOf": [
|
|
4034
|
+
{
|
|
4035
|
+
"allOf": [
|
|
4036
|
+
{
|
|
4037
|
+
"$ref": "#/$defs/AgentRequest"
|
|
4038
|
+
}
|
|
4039
|
+
],
|
|
4040
|
+
"title": "Request"
|
|
4041
|
+
},
|
|
4042
|
+
{
|
|
4043
|
+
"allOf": [
|
|
4044
|
+
{
|
|
4045
|
+
"$ref": "#/$defs/AgentResponse"
|
|
4046
|
+
}
|
|
4047
|
+
],
|
|
4048
|
+
"title": "Response"
|
|
4049
|
+
},
|
|
4050
|
+
{
|
|
4051
|
+
"allOf": [
|
|
4052
|
+
{
|
|
4053
|
+
"$ref": "#/$defs/AgentNotification"
|
|
4054
|
+
}
|
|
4055
|
+
],
|
|
4056
|
+
"title": "Notification"
|
|
4057
|
+
}
|
|
4058
|
+
],
|
|
4059
|
+
"description": "A message (request, response, or notification) with `\"jsonrpc\": \"2.0\"` specified as\n[required by JSON-RPC 2.0 Specification][1].\n\n[1]: https://www.jsonrpc.org/specification#compatibility",
|
|
4060
|
+
"properties": {
|
|
4061
|
+
"jsonrpc": {
|
|
4062
|
+
"enum": ["2.0"],
|
|
4063
|
+
"type": "string"
|
|
4064
|
+
}
|
|
4065
|
+
},
|
|
4066
|
+
"required": ["jsonrpc"],
|
|
4067
|
+
"title": "Agent",
|
|
4068
|
+
"type": "object"
|
|
4069
|
+
},
|
|
4070
|
+
{
|
|
4071
|
+
"anyOf": [
|
|
4072
|
+
{
|
|
4073
|
+
"allOf": [
|
|
4074
|
+
{
|
|
4075
|
+
"$ref": "#/$defs/ClientRequest"
|
|
4076
|
+
}
|
|
4077
|
+
],
|
|
4078
|
+
"title": "Request"
|
|
4079
|
+
},
|
|
4080
|
+
{
|
|
4081
|
+
"allOf": [
|
|
4082
|
+
{
|
|
4083
|
+
"$ref": "#/$defs/ClientResponse"
|
|
4084
|
+
}
|
|
4085
|
+
],
|
|
4086
|
+
"title": "Response"
|
|
4087
|
+
},
|
|
4088
|
+
{
|
|
4089
|
+
"allOf": [
|
|
4090
|
+
{
|
|
4091
|
+
"$ref": "#/$defs/ClientNotification"
|
|
4092
|
+
}
|
|
4093
|
+
],
|
|
4094
|
+
"title": "Notification"
|
|
4095
|
+
}
|
|
4096
|
+
],
|
|
4097
|
+
"description": "A message (request, response, or notification) with `\"jsonrpc\": \"2.0\"` specified as\n[required by JSON-RPC 2.0 Specification][1].\n\n[1]: https://www.jsonrpc.org/specification#compatibility",
|
|
4098
|
+
"properties": {
|
|
4099
|
+
"jsonrpc": {
|
|
4100
|
+
"enum": ["2.0"],
|
|
4101
|
+
"type": "string"
|
|
4102
|
+
}
|
|
4103
|
+
},
|
|
4104
|
+
"required": ["jsonrpc"],
|
|
4105
|
+
"title": "Client",
|
|
4106
|
+
"type": "object"
|
|
4107
|
+
},
|
|
4108
|
+
{
|
|
4109
|
+
"anyOf": [
|
|
4110
|
+
{
|
|
4111
|
+
"allOf": [
|
|
4112
|
+
{
|
|
4113
|
+
"$ref": "#/$defs/CancelRequestNotification"
|
|
4114
|
+
}
|
|
4115
|
+
],
|
|
4116
|
+
"description": "**UNSTABLE**\n\nThis capability is not part of the spec yet, and may be removed or\nchanged at any point.\n\nCancels an ongoing request.\n\nThis is a notification sent by the the side that sent a request to cancel that request.\n\nUpon receiving this notification, the receiver:\n\n1. MUST cancel the corresponding request activity and all nested activities\n2. MAY send any pending notifications.\n3. MUST send one of these responses for the original request:\n - Valid response with appropriate data (partial results or cancellation marker)\n - Error response with code `-32800` (Cancelled)\n\nSee protocol docs: [Cancellation](https://agentclientprotocol.com/protocol/cancellation)",
|
|
4117
|
+
"title": "CancelRequestNotification"
|
|
4118
|
+
}
|
|
4119
|
+
],
|
|
4120
|
+
"description": "General protocol-level notifications that all sides are expected to\nimplement.\n\nNotifications whose methods start with '$/' are messages which\nare protocol implementation dependent and might not be implementable in all\nclients or agents. For example if the implementation uses a single threaded\nsynchronous programming language then there is little it can do to react to\na `$/cancel_request` notification. If an agent or client receives\nnotifications starting with '$/' it is free to ignore the notification.\n\nNotifications do not expect a response.",
|
|
4121
|
+
"title": "ProtocolLevel"
|
|
4122
|
+
}
|
|
4123
|
+
],
|
|
4124
|
+
"title": "Agent Client Protocol"
|
|
4125
|
+
}
|