|
402 | 402 | }
|
403 | 403 | ]
|
404 | 404 | },
|
| 405 | + "CreateElicitationRequestParam": { |
| 406 | + "description": "Parameters for creating an elicitation request to gather user input.\n\nThis structure contains everything needed to request interactive input from a user:\n- A human-readable message explaining what information is needed\n- A JSON schema defining the expected structure of the response", |
| 407 | + "type": "object", |
| 408 | + "properties": { |
| 409 | + "message": { |
| 410 | + "description": "Human-readable message explaining what input is needed from the user.\nThis should be clear and provide sufficient context for the user to understand\nwhat information they need to provide.", |
| 411 | + "type": "string" |
| 412 | + }, |
| 413 | + "requestedSchema": { |
| 414 | + "description": "JSON Schema defining the expected structure and validation rules for the user's response.\nThis allows clients to validate input and provide appropriate UI controls.\nMust be a valid JSON Schema Draft 2020-12 object.", |
| 415 | + "type": "object", |
| 416 | + "additionalProperties": true |
| 417 | + } |
| 418 | + }, |
| 419 | + "required": [ |
| 420 | + "message", |
| 421 | + "requestedSchema" |
| 422 | + ] |
| 423 | + }, |
| 424 | + "CreateElicitationResult": { |
| 425 | + "description": "The result returned by a client in response to an elicitation request.\n\nContains the user's decision (accept/decline/cancel) and optionally their input data\nif they chose to accept the request.", |
| 426 | + "type": "object", |
| 427 | + "properties": { |
| 428 | + "action": { |
| 429 | + "description": "The user's decision on how to handle the elicitation request", |
| 430 | + "allOf": [ |
| 431 | + { |
| 432 | + "$ref": "#/definitions/ElicitationAction" |
| 433 | + } |
| 434 | + ] |
| 435 | + }, |
| 436 | + "content": { |
| 437 | + "description": "The actual data provided by the user, if they accepted the request.\nMust conform to the JSON schema specified in the original request.\nOnly present when action is Accept." |
| 438 | + } |
| 439 | + }, |
| 440 | + "required": [ |
| 441 | + "action" |
| 442 | + ] |
| 443 | + }, |
405 | 444 | "CreateMessageRequestMethod": {
|
406 | 445 | "type": "string",
|
407 | 446 | "format": "const",
|
|
480 | 519 | "maxTokens"
|
481 | 520 | ]
|
482 | 521 | },
|
| 522 | + "ElicitationAction": { |
| 523 | + "description": "Represents the possible actions a user can take in response to an elicitation request.\n\nWhen a server requests user input through elicitation, the user can:\n- Accept: Provide the requested information and continue\n- Decline: Refuse to provide the information but continue the operation\n- Cancel: Stop the entire operation", |
| 524 | + "oneOf": [ |
| 525 | + { |
| 526 | + "description": "User accepts the request and provides the requested information", |
| 527 | + "type": "string", |
| 528 | + "const": "accept" |
| 529 | + }, |
| 530 | + { |
| 531 | + "description": "User declines to provide the information but allows the operation to continue", |
| 532 | + "type": "string", |
| 533 | + "const": "decline" |
| 534 | + }, |
| 535 | + { |
| 536 | + "description": "User cancels the entire operation", |
| 537 | + "type": "string", |
| 538 | + "const": "cancel" |
| 539 | + } |
| 540 | + ] |
| 541 | + }, |
| 542 | + "ElicitationCreateRequestMethod": { |
| 543 | + "type": "string", |
| 544 | + "format": "const", |
| 545 | + "const": "elicitation/create" |
| 546 | + }, |
483 | 547 | "EmptyObject": {
|
484 | 548 | "description": "This is commonly used for representing empty objects in MCP messages.\n\nwithout returning any specific data.",
|
485 | 549 | "type": "object"
|
|
683 | 747 | },
|
684 | 748 | {
|
685 | 749 | "$ref": "#/definitions/RequestNoParam2"
|
| 750 | + }, |
| 751 | + { |
| 752 | + "$ref": "#/definitions/Request2" |
686 | 753 | }
|
687 | 754 | ],
|
688 | 755 | "required": [
|
|
1306 | 1373 | "params"
|
1307 | 1374 | ]
|
1308 | 1375 | },
|
| 1376 | + "Request2": { |
| 1377 | + "description": "Represents a JSON-RPC request with method, parameters, and extensions.\n\nThis is the core structure for all MCP requests, containing:\n- `method`: The name of the method being called\n- `params`: The parameters for the method\n- `extensions`: Additional context data (similar to HTTP headers)", |
| 1378 | + "type": "object", |
| 1379 | + "properties": { |
| 1380 | + "method": { |
| 1381 | + "$ref": "#/definitions/ElicitationCreateRequestMethod" |
| 1382 | + }, |
| 1383 | + "params": { |
| 1384 | + "$ref": "#/definitions/CreateElicitationRequestParam" |
| 1385 | + } |
| 1386 | + }, |
| 1387 | + "required": [ |
| 1388 | + "method", |
| 1389 | + "params" |
| 1390 | + ] |
| 1391 | + }, |
1309 | 1392 | "RequestNoParam": {
|
1310 | 1393 | "type": "object",
|
1311 | 1394 | "properties": {
|
|
1545 | 1628 | {
|
1546 | 1629 | "$ref": "#/definitions/ListToolsResult"
|
1547 | 1630 | },
|
| 1631 | + { |
| 1632 | + "$ref": "#/definitions/CreateElicitationResult" |
| 1633 | + }, |
1548 | 1634 | {
|
1549 | 1635 | "$ref": "#/definitions/EmptyObject"
|
1550 | 1636 | }
|
|
0 commit comments