Skip to main content
Glama

Batches Edit

batches_edit

Update an existing batch by sending a complete JSON:API payload to the Pingen API, allowing changes to batch details within an organisation.

Instructions

Edit a batch. PATCH /organisations/{organisationId}/batches/{batchId}

payload is the full JSON:API document (BatchEditPATCH), 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>",
      "batch_id": "<batch_id>",
      "payload": "<payload>"
    },
    "name": "batches_edit"
  }
}

Input Schema

NameRequiredDescriptionDefault
payloadYes
batch_idYes
organisation_idYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations present, the description carries the full burden. It does disclose one genuinely useful behavioral fact beyond the schema: the payload is sent verbatim as a full JSON:API document rather than merged field-by-field, implying a whole-document replacement semantics. It omits permissions/auth requirements, what happens to omitted fields, whether the edit is reversible, and what the response contains.

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

Conciseness4/5

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

Two short sentences, front-loaded with the verb and resource, followed by the endpoint and then the one non-obvious constraint about payload. Little waste, though the endpoint path largely restates the three parameter names.

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?

This is a mutation tool with no annotations, no output schema, and a free-form nested payload. The description names a document type (BatchEditPATCH) but gives no indication of that document's structure, required fields, or error behavior, so an agent cannot construct a valid call from this definition alone. Naming the type is a hint, not sufficient coverage for a nested verbatim payload.

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. It clarifies the most complex parameter (payload is a complete JSON:API document of type BatchEditPATCH, passed through unchanged), which is real added meaning over an opaque object with additionalProperties:true. organisation_id and batch_id receive no explanation, though their names and the endpoint template make them reasonably self-evident.

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?

The description names a specific verb and resource ("Edit a batch") and anchors it to the concrete endpoint PATCH /organisations/{organisationId}/batches/{batchId}, so an agent knows exactly which operation this is. It does not explicitly distinguish itself from siblings like batches_create or batches_cancel, leaving that inference to the verb alone.

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?

There is no when-to-use guidance, no statement of prerequisites (e.g. the batch must already exist, must be in an editable state), and no mention of alternatives such as batches_cancel or batches_create. The only usage signal is the HTTP verb PATCH, which the agent must interpret on its own.

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