Skip to main content
Glama

Batches Create

batches_create

Create a new batch for an organisation by posting a complete JSON:API payload verbatim to the batches endpoint.

Instructions

Create a new batch. POST /organisations/{organisationId}/batches

payload is the full JSON:API document (CreateBatchPOST), sent verbatim.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "organisation_id": "<organisation_id>",
      "payload": "<payload>"
    },
    "name": "batches_create"
  }
}

Input Schema

NameRequiredDescriptionDefault
payloadYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose one non-obvious behavior: the payload is sent verbatim, so no field coercion or partial-update merging happens. It says nothing about authentication/permission requirements, side effects of creating a batch, or what is returned, which are material gaps for a mutation tool with zero annotation coverage.

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?

Two short sentences, front-loaded with the action, followed by the endpoint and the one formatting rule that matters. No filler and nothing buried.

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

Completeness2/5

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

The tool takes a free-form nested payload, has no output schema and no annotations, so the description is the only source of behavioral and structural information — yet it stops at naming the document type without characterizing required content, error behavior, or the response. For a create-a-batch mutation whose whole complexity lives inside the payload argument, this leaves the agent under-equipped.

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

Parameters3/5

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

Schema description coverage is 0%, so the description must compensate, and it partly does: it names the payload's expected document type (CreateBatchPOST) and clarifies verbatim pass-through semantics, and the URL template implies organisation_id is the owning organisation. That is meaningful added meaning, but it is not enough for an opaque nested object with additionalProperties: true — the agent still has no idea which fields a valid batch document requires.

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 clear verb+resource ("Create a new batch") and anchors it to the concrete endpoint POST /organisations/{organisationId}/batches, which separates it from batches_list, batches_show, batches_send and batches_cancel. It does not explicitly contrast with the other *_create siblings, but the resource noun is unambiguous.

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

Usage Guidelines2/5

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

No when-to-use or when-not-to-use guidance: nothing says whether a batch must be created before batches_send or batches_edit can be used, nor what preconditions the organisation must satisfy. The only usage-relevant information is implicit, derived from the endpoint path.

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