You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`url`| string | The URL that the user should navigate to. |
342
+
|`elicitationId`| string | A unique identifier for the elicitation. |
344
343
345
-
The `url` parameter **MUST** contain a valid URL. The `message` parameter **MUST NOT** contain a URL.
346
-
347
-
The `notifiesOnCompletion` parameter indicates whether the server commits to sending a `notifications/elicitation/complete` notification:
348
-
349
-
- When `notifiesOnCompletion` is `true`: The server **MUST** send the notification once it determines the out-of-band interaction has completed (whether successfully or not).
350
-
- When `notifiesOnCompletion` is `false` or absent: Servers **SHOULD NOT** send the notification, and clients **MUST NOT** rely on receiving it.
344
+
The `url` parameter **MUST** contain a valid URL.
351
345
352
346
#### Example: Request Sensitive Data
353
347
@@ -365,8 +359,7 @@ The same request could direct the user into an OAuth authorization flow, or a pa
"message": "Please provide your API key to continue.",
369
-
"notifiesOnCompletion": true
362
+
"message": "Please provide your API key to continue."
370
363
}
371
364
}
372
365
```
@@ -389,32 +382,24 @@ of band and the client is not aware of the outcome until and unless the server s
389
382
390
383
### Completion Notifications for URL Mode Elicitation
391
384
392
-
Servers can send a `notifications/elicitation/complete` notification when an
385
+
<Note>
386
+
**Experimental**: This mechanism to notify clients of completed out-of-band
387
+
interactions could change or be removed in upcoming releases.
388
+
</Note>
389
+
390
+
Servers **MAY** send a `notifications/elicitation/complete` notification when an
393
391
out-of-band interaction started by URL mode elicitation is completed. This allows clients to react programmatically if appropriate.
394
392
395
393
Servers sending notifications:
396
394
397
395
-**MUST** only send the notification to the client that initiated the elicitation request.
398
396
-**MUST** include the `elicitationId` established in the original `elicitation/create` request.
399
397
400
-
Clients receiving notifications:
398
+
Clients:
401
399
402
400
-**MUST** ignore notifications referencing unknown or already-completed IDs.
403
-
404
-
The `notifiesOnCompletion` parameter in the `elicitation/create` request indicates whether the server commits to sending a `notifications/elicitation/complete` notification,
405
-
and whether the client can expect to receive it.
406
-
407
-
When a server includes `notifiesOnCompletion: true` in an `elicitation/create` request:
408
-
409
-
- The server **MUST** send a `notifications/elicitation/complete` notification once it determines the out-of-band interaction has completed (whether successfully or not).
410
-
- Clients **MAY** wait for this notification to automatically retry requests that received a [URLElicitationRequiredError](#error-handling), update the user interface, or otherwise continue an interaction.
411
-
- Clients **SHOULD** still provide manual controls that let the user retry or cancel the original request (or otherwise resume interacting with the client) if the notification never arrives.
412
-
413
-
When a server includes `notifiesOnCompletion: false` in an `elicitation/create` request:
414
-
415
-
- The server **SHOULD NOT** send a `notifications/elicitation/complete` notification.
416
-
- Clients **MUST NOT** rely on receiving a notification.
417
-
- Clients **SHOULD** provide a manual way for the user to continue the interaction.
401
+
-**MAY** wait for this notification to automatically retry requests that received a [URLElicitationRequiredError](#error-handling), update the user interface, or otherwise continue an interaction.
402
+
-**SHOULD** still provide manual controls that let the user retry or cancel the original request (or otherwise resume interacting with the client) if the notification never arrives.
418
403
419
404
#### Example
420
405
@@ -451,8 +436,7 @@ Any elicitations returned in the error **MUST** be URL mode elicitations and hav
0 commit comments