call_read_tools_batch

Calls up to sixteen eligible inspect tools serially; inner tools receive no separate approval, and its nested authority is disclosed. The complete JSON-RPC response is capped at 1,000,000 bytes; a removed nested envelope is marked on its row and counted in truncatedBytes. Read pane output; accepts no client-supplied executable input. Returned content may be sensitive or untrusted.

All Java tools · JSON · Source

Arguments

onError optional · string: stop or continue; defaults to stop.
operations required · array: Typed calls within the disclosed nested authority.

Schemas

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

Input schema

{
  "additionalProperties": false,
  "properties": {
    "onError": {
      "description": "stop or continue; defaults to stop.",
      "enum": [
        "stop",
        "continue"
      ],
      "type": "string"
    },
    "operations": {
      "description": "Typed calls within the disclosed nested authority.",
      "items": {
        "oneOf": [
          {
            "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_id": {
                    "description": "Only windows in this session, such as $1.",
                    "type": "string"
                  },
                  "session_name": {
                    "description": "Only windows in the session with this exact name.",
                    "type": "string"
                  }
                },
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "list_windows",
                "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": "get_server_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "session_id": {
                    "description": "The session ID, such as $1.",
                    "type": "string"
                  }
                },
                "required": [
                  "session_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_session_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "window_id": {
                    "description": "The window ID, such as @1.",
                    "type": "string"
                  }
                },
                "required": [
                  "window_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_window_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "pane_id": {
                    "description": "The pane to act on, such as %1. Every listing tool returns these.",
                    "type": "string"
                  }
                },
                "required": [
                  "pane_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_pane_info",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "history": {
                    "default": false,
                    "description": "Include scrollback rather than only the visible screen. Defaults to false.",
                    "type": "boolean"
                  },
                  "max_lines": {
                    "default": 200,
                    "description": "Maximum lines, keeping the newest. Defaults to 200.",
                    "type": "integer"
                  },
                  "pane_id": {
                    "description": "The pane to act on, such as %1. Every listing tool returns these.",
                    "type": "string"
                  }
                },
                "required": [
                  "pane_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "capture_pane",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "cursor": {
                    "description": "A cursor returned by an earlier capture.",
                    "type": "string"
                  },
                  "max_lines": {
                    "default": 200,
                    "description": "Maximum new lines, keeping the newest. Defaults to 200.",
                    "type": "integer"
                  },
                  "pane_id": {
                    "description": "The pane to act on, such as %1. Every listing tool returns these.",
                    "type": "string"
                  }
                },
                "required": [
                  "pane_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "capture_since",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "history": {
                    "default": false,
                    "description": "Include scrollback rather than only the visible screen. Defaults to false.",
                    "type": "boolean"
                  },
                  "max_lines": {
                    "default": 200,
                    "description": "Maximum lines, keeping the newest. Defaults to 200.",
                    "type": "integer"
                  },
                  "pane_id": {
                    "description": "The pane to act on, such as %1. Every listing tool returns these.",
                    "type": "string"
                  }
                },
                "required": [
                  "pane_id"
                ],
                "type": "object"
              },
              "tool": {
                "const": "snapshot_pane",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "max_lines": {
                    "default": 200,
                    "description": "Maximum matches across all panes. Defaults to 200.",
                    "type": "integer"
                  },
                  "max_matches_per_pane": {
                    "default": 5,
                    "description": "Maximum matching lines per pane. Defaults to 5.",
                    "type": "integer"
                  },
                  "pattern": {
                    "description": "The bounded text or regular expression to search for.",
                    "maxLength": 4096,
                    "type": "string"
                  },
                  "regex": {
                    "default": false,
                    "description": "Treat pattern as a regular expression. Defaults to false.",
                    "type": "boolean"
                  }
                },
                "required": [
                  "pattern"
                ],
                "type": "object"
              },
              "tool": {
                "const": "search_panes",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "position": {
                    "description": "top-left, top-right, bottom-left or bottom-right.",
                    "type": "string"
                  },
                  "window_id": {
                    "description": "The window ID, such as @1.",
                    "type": "string"
                  }
                },
                "required": [
                  "window_id",
                  "position"
                ],
                "type": "object"
              },
              "tool": {
                "const": "find_pane_by_position",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "names": {
                    "description": "One to thirty-two variable names matching [A-Za-z][A-Za-z0-9_]*. One value may be sent on its own, without a list.",
                    "items": {
                      "maxLength": 128,
                      "type": "string"
                    },
                    "maxItems": 32,
                    "type": [
                      "array",
                      "string"
                    ]
                  },
                  "pane": {
                    "description": "An optional pane context.",
                    "type": "string"
                  }
                },
                "required": [
                  "names"
                ],
                "type": "object"
              },
              "tool": {
                "const": "get_tmux_variables",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "effective": {
                    "default": true,
                    "description": "Include an inherited value. Defaults to true.",
                    "type": "boolean"
                  },
                  "name": {
                    "description": "The exact option name.",
                    "type": "string"
                  },
                  "scope": {
                    "description": "global, server, session, window or pane.",
                    "type": "string"
                  },
                  "target": {
                    "description": "Required for session scope (an ID such as $1, or a name), window scope (@1) and pane scope (%1).",
                    "type": "string"
                  }
                },
                "required": [
                  "name"
                ],
                "type": "object"
              },
              "tool": {
                "const": "show_option",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "session_id": {
                    "description": "A session, such as $1; omit both for the global environment.",
                    "type": "string"
                  },
                  "session_name": {
                    "description": "A session's exact name, in place of session_id.",
                    "type": "string"
                  }
                },
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "show_environment",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          },
          {
            "additionalProperties": false,
            "properties": {
              "arguments": {
                "additionalProperties": false,
                "properties": {
                  "name": {
                    "description": "One hook name; omit to read all hooks in the scope.",
                    "type": "string"
                  },
                  "scope": {
                    "description": "global, server, session, window or pane.",
                    "type": "string"
                  },
                  "target": {
                    "description": "Required for session scope (an ID such as $1, or a name), window scope (@1) and pane scope (%1).",
                    "type": "string"
                  }
                },
                "required": [],
                "type": "object"
              },
              "tool": {
                "const": "show_hooks",
                "type": "string"
              }
            },
            "required": [
              "tool"
            ],
            "type": "object"
          }
        ]
      },
      "maxItems": 16,
      "minItems": 1,
      "type": "array"
    }
  },
  "required": [
    "operations"
  ],
  "type": "object"
}

Output schema

{
  "additionalProperties": false,
  "properties": {
    "failed": {
      "type": "integer"
    },
    "onError": {
      "type": "string"
    },
    "results": {
      "items": {
        "additionalProperties": false,
        "properties": {
          "error": {
            "oneOf": [
              {
                "type": "string"
              },
              {
                "type": "null"
              }
            ]
          },
          "index": {
            "type": "integer"
          },
          "result": {
            "oneOf": [
              {
                "additionalProperties": false,
                "properties": {
                  "_meta": {
                    "type": "object"
                  },
                  "content": {
                    "items": {
                      "type": "object"
                    },
                    "type": "array"
                  },
                  "isError": {
                    "type": "boolean"
                  },
                  "structuredContent": {
                    "type": "object"
                  }
                },
                "required": [
                  "content",
                  "isError"
                ],
                "type": "object"
              },
              {
                "type": "null"
              }
            ]
          },
          "resultTruncated": {
            "type": "boolean"
          },
          "success": {
            "type": "boolean"
          },
          "tool": {
            "type": "string"
          }
        },
        "required": [
          "index",
          "tool",
          "success",
          "error",
          "result",
          "resultTruncated"
        ],
        "type": "object"
      },
      "type": "array"
    },
    "stoppedAt": {
      "oneOf": [
        {
          "type": "integer"
        },
        {
          "type": "null"
        }
      ]
    },
    "succeeded": {
      "type": "integer"
    },
    "truncated": {
      "type": "boolean"
    },
    "truncatedBytes": {
      "type": "integer"
    }
  },
  "required": [
    "results",
    "succeeded",
    "failed",
    "stoppedAt",
    "truncated",
    "truncatedBytes",
    "onError"
  ],
  "type": "object"
}

Tool annotations

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

Scripting & web

Compiled & native

JVM

.NET

tmux

call_read_tools_batch

Arguments

Schemas