Skip to main content
Glama

BatchBegin

Starts batch mode to record multiple tool calls under sequential numbers and returns a state handle required for each subsequent call.

Instructions

[read-only] Starts batch mode on this server. In batch mode each call of a tool marked recordable is recorded under the next number, starting at 1, and answers with empty content. Answers the state_handle: over Streamable HTTP send it as the state_handle argument of every call of the batch (or in the x-mcp-state-handle header).

Input Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv20.1.0

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations exist, so the description carries the full burden, and it discloses genuinely important behavior: recordable tools return empty content while batching, and the returned state_handle must be threaded through Streamable HTTP as an argument or header. It also self-declares read-only. Missing is what happens on error or repeated BatchBegin calls.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three tight sentences, front-loaded with the verb and purpose, followed by the mechanism and then the transport-specific detail. Nothing is repeated and nothing is filler, so the agent can stop reading at any sentence and still act correctly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema, the description correctly fills the gap by explaining that state_handle is returned and how to use it. What is left out is the lifecycle tail, i.e. how the batch is closed or its answers retrieved, which matters for an agent that has only this tool and its siblings to reason about.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the baseline is 4 and there is no parameter ambiguity to resolve. The description instead spends its words on the state_handle output, which is useful value-add even though it is not a parameter concern.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ("Starts batch mode on this server") and then defines what batch mode does: recordable tool calls are recorded under sequential numbers and answer with empty content. That is enough to distinguish it from BatchEnd/BatchAnswers, though those siblings are never named, so the differentiation is inferred rather than explicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explains the operating context and the requirement to pass state_handle on every subsequent batch call, which implicitly tells the agent this is the entry point of a workflow. However, it never states when to use this versus BatchEnd or BatchAnswers, nor what happens if a batch is already open, leaving the workflow routing implied.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools