UserInputRequestParams

Full params shared by userInput/request and userInput/requested.

Fields and variants

• autoResolutionMs
• itemId
• questions
• sessionId
• sourceRange
• toolCallId
• toolName
• turnId
• userInputId
• viewCursor

Source

schema/msp/experimental/msp.schema.json#/types/UserInputRequestParams

{
  "description": "Full params shared by `userInput/request` and `userInput/requested`.",
  "properties": {
    "autoResolutionMs": {
      "description": "The auto-resolution time per question, in milliseconds: a prompt nobody\nengages with settles as `timedOut` after this value times the number of\nquestions.",
      "type": "integer"
    },
    "itemId": {
      "description": "The `toolCall` view item of the tool call waiting on this prompt.",
      "type": "string"
    },
    "questions": {
      "description": "The questions to ask, one to three, in order.",
      "items": {
        "$ref": "#/$defs/UserInputQuestion"
      },
      "type": "array"
    },
    "sessionId": {
      "description": "The session that owns the prompt.",
      "type": "string"
    },
    "sourceRange": {
      "$ref": "#/$defs/SourceRange",
      "description": "The stored records this prompt was folded from, when sent: an opaque\ntoken clients must not interpret."
    },
    "toolCallId": {
      "description": "The provider's id for the tool call that opened the prompt.",
      "type": "string"
    },
    "toolName": {
      "description": "The name of the tool that opened the prompt.",
      "type": "string"
    },
    "turnId": {
      "description": "The turn whose tool call is waiting on this prompt.",
      "type": "string"
    },
    "userInputId": {
      "description": "The prompt's stable id. Pass it to `userInput/answer`,\n`userInput/cancel`, `userInput/clarify` and `userInput/interrupt`, and\nuse it to match the later `userInput/settled`.",
      "type": "string"
    },
    "viewCursor": {
      "description": "The cursor of the `userInput/requested` event for this prompt. A client\nthat missed the request can read the same payload at this cursor with\n`view/page`.",
      "type": "string"
    }
  },
  "required": [
    "itemId",
    "questions",
    "sessionId",
    "toolCallId",
    "toolName",
    "turnId",
    "userInputId",
    "viewCursor"
  ],
  "type": "object"
}