tool MCPlatest

`send_keys_batch`

send_keys_batch( onError?: "stop" | "continue", operations: Array<object>, )

tool [source]¶

Send input to a pane’s program; a shell that receives it runs it with your user’s permissions. Send an ordered batch of pane-input operations, resolving and checking each row’s configured cohort immediately before input. Stop or continue on error.

MCP request method: tools/call Send send_keys_batch as the tool name, with the arguments below.

Arguments#

onError? ("stop" | "continue") #

Whether a failed operation ends the batch. Defaults to stop.
operations (Array<object>) #

The key sends to run, in order, one pane each.

minItems
1
maxItems
64
- Items (object) #
  - enter? (boolean) #
    
    Press Enter afterwards. Default true.
  - force? (boolean) #
    
    Allow this server’s own caller pane, as on send_keys.
  - keys (string) #
    
    Keys for this pane, as on send_keys.
  - literal? (boolean) #
    
    Send the text literally rather than resolving key names.
  - paneId (string) #
    
    Stable pane id, e.g. %1.
    
    pattern
    "^%\\d+$"

Result#

Returns object

completed (integer) #

minimum
-9007199254740991
maximum
9007199254740991
failures (Array<object>) #
- Items (object) #
  - index (integer) #
    
    minimum
    -9007199254740991
    maximum
    9007199254740991
  - reason (string) #
  No other properties are accepted.
targets (Array<object>) #
- Items (object) #
  - index (integer) #
    
    minimum
    -9007199254740991
    maximum
    9007199254740991
  - resolvedPaneIds (Array<string>) #
    - Items (string) #
      
      Stable pane id, e.g. %1.
      
      pattern
      "^%\\d+$"
  No other properties are accepted.

No other properties are accepted.

Annotations#

destructiveHint: true
idempotentHint: false
openWorldHint: true
readOnlyHint: false

Protocol data#

Use the complete advertised contract for validation and client integration.

Input schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "onError": {
      "description": "Whether a failed operation ends the batch. Defaults to stop.",
      "enum": [
        "stop",
        "continue"
      ],
      "type": "string"
    },
    "operations": {
      "description": "The key sends to run, in order, one pane each.",
      "items": {
        "properties": {
          "enter": {
            "description": "Press Enter afterwards. Default true.",
            "type": "boolean"
          },
          "force": {
            "description": "Allow this server's own caller pane, as on `send_keys`.",
            "type": "boolean"
          },
          "keys": {
            "description": "Keys for this pane, as on `send_keys`.",
            "type": "string"
          },
          "literal": {
            "description": "Send the text literally rather than resolving key names.",
            "type": "boolean"
          },
          "paneId": {
            "description": "Stable pane id, e.g. %1.",
            "pattern": "^%\\d+$",
            "type": "string"
          }
        },
        "required": [
          "keys",
          "paneId"
        ],
        "type": "object"
      },
      "maxItems": 64,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operations"
  ],
  "type": "object"
}

Output schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "additionalProperties": false,
  "properties": {
    "completed": {
      "maximum": 9007199254740991,
      "minimum": -9007199254740991,
      "type": "integer"
    },
    "failures": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "index": {
            "maximum": 9007199254740991,
            "minimum": -9007199254740991,
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "required": [
          "index",
          "reason"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "targets": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "index": {
            "maximum": 9007199254740991,
            "minimum": -9007199254740991,
            "type": "integer"
          },
          "resolvedPaneIds": {
            "items": {
              "description": "Stable pane id, e.g. %1.",
              "pattern": "^%\\d+$",
              "type": "string"
            },
            "type": "array"
          }
        },
        "required": [
          "index",
          "resolvedPaneIds"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "completed",
    "failures",
    "targets"
  ],
  "type": "object"
}

Scripting & web

Compiled & native

JVM

.NET

BEAM

tmux

`send_keys_batch`

Arguments#

Result#

Annotations#

Protocol data#