call_read_tools_batch

Run up to sixteen declared inspect operations serially under this one call; inner operations receive no separate approval. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All C++ tools · JSON · Source

Arguments

onError optional · string: Stop after the first failed operation or continue.
operations required · array: One to sixteen typed inspect-tool operations.

Schemas

The schema defines required fields, nested values, defaults, and validation constraints.

Input schema

{
  "additionalProperties": false,
  "properties": {
    "onError": {
      "description": "Stop after the first failed operation or continue.",
      "enum": [
        "continue",
        "stop"
      ],
      "type": "string"
    },
    "operations": {
      "description": "One to sixteen typed inspect-tool operations.",
      "items": {
        "oneOf": [
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "history": {
                    "description": "Capture retained history as well as the visible pane.",
                    "type": "boolean"
                  },
                  "paneId": {
                    "description": "Stable pane ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "paneId"
                ],
                "type": "object"
              },
              "tool": {
                "const": "capture_pane",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "cursor": {
                    "description": "Previously returned byte cursor.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "paneId": {
                    "description": "Stable pane ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "paneId"
                ],
                "type": "object"
              },
              "tool": {
                "const": "capture_since",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "column": {
                    "description": "Zero-based terminal column.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "row": {
                    "description": "Zero-based terminal row.",
                    "minimum": 0,
                    "type": "integer"
                  },
                  "windowId": {
                    "description": "Optional stable window ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "row",
                  "column"
                ],
                "type": "object"
              },
              "tool": {
                "const": "find_pane_by_position",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "paneId": {
                    "description": "Stable pane ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "paneId"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_pane_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {},
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "get_server_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "session": {
                    "description": "Stable session ID or name.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "session"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_session_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "names": {
                    "description": "One to thirty-two validated tmux variable names.",
                    "items": {
                      "maxLength": 128,
                      "type": "string"
                    },
                    "maxItems": 32,
                    "minItems": 1,
                    "type": "array"
                  },
                  "paneId": {
                    "description": "Optional pane context.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "names"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_tmux_variables",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "windowId": {
                    "description": "Stable window ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "windowId"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_window_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {},
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "list_panes",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {},
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "list_sessions",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "session": {
                    "description": "Stable session ID or name.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "session"
                ],
                "type": "object"
              },
              "tool": {
                "const": "list_windows",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "pattern": {
                    "description": "Bounded regular expression.",
                    "maxLength": 256,
                    "type": "string"
                  }
                },
                "required": [
                  "pattern"
                ],
                "type": "object"
              },
              "tool": {
                "const": "search_panes",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "description": "Optional exact environment name.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "session": {
                    "description": "Optional session target.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "show_environment",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "description": "Optional exact hook name.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "target": {
                    "description": "Optional tmux target.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "show_hooks",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "description": "Exact option name.",
                    "maxLength": 256,
                    "type": "string"
                  },
                  "target": {
                    "description": "Optional session, window, or pane target.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "tool": {
                "const": "show_option",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "paneId": {
                    "description": "Stable pane ID.",
                    "maxLength": 512,
                    "type": "string"
                  }
                },
                "required": [
                  "paneId"
                ],
                "type": "object"
              },
              "tool": {
                "const": "snapshot_pane",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          }
        ]
      },
      "maxItems": 16,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operations"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": true,
  "type": "object"
}

Tool annotations

{
  "destructiveHint": true,
  "idempotentHint": false,
  "openWorldHint": true,
  "readOnlyHint": false,
  "title": "Call read tools as a batch"
}

Scripting & web

Compiled & native

JVM

.NET

tmux

call_read_tools_batch

Arguments

Schemas