Skip to main content
Glama

Get Users Batch Job

ethora-users-batch-job-v2
Read-only

Retrieve the current status and per-user results of a batch job using its jobId. Returns job state and outcomes, eliminating the need for polling.

Instructions

Fetch the current status and per-user results of a users batch job by jobId (one-shot, no polling). Returns the job object with its state (pending/running/completed/failed) and per-user outcomes. Requires: a jobId returned by ethora-users-batch-create-v2. Auth: B2B mode (ethora-auth-use-b2b + a configured b2bToken) — must match the auth used to create the job. Errors: 401/403 not in B2B mode; 404 unknown jobId. Related: ethora-wait-users-batch-job-v2 for a blocking wait.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
jobIdYesJob id returned by `ethora-users-batch-create-v2`.
timeoutMsNoHTTP timeout for this status request, in milliseconds. Default 10000.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv26.9.3

TDQS

A4.7/5.0
Behavior5/5

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

Annotations declare readOnlyHint=true and destructiveHint=false, so the safety profile is known. The description adds valuable behavioral context: the one-shot non-polling nature, the required auth match, and the specific error codes. It also describes the return shape (job object with `state` and per-user outcomes), which is not disclosed by annotations and is critical for correct use.

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?

The description is compact yet information-dense. It front-loads the main action, then packs prerequisites, auth, errors, and a related tool into a few sentences. No filler or repetition; every sentence adds value.

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

Completeness5/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 explains the return format (job object with state and per-user outcomes). It covers auth requirements, error scenarios, and the relationship to the create and wait tools. For a one-shot status fetch, all necessary information for correct invocation is present.

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 100%, so both `jobId` and `timeoutMs` are already fully documented in the schema. The description reinforces that `jobId` must come from `ethora-users-batch-create-v2`, which is also in the schema's parameter description, so it adds no new semantic meaning. Baseline of 3 is appropriate because the schema carries the burden.

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

Purpose5/5

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

States a specific verb ('Fetch'), resource ('current status and per-user results of a users batch job'), and identifies the key input (`jobId`). It explicitly differentiates from the sibling `ethora-wait-users-batch-job-v2` by noting it is 'one-shot, no polling', making the tool's role unambiguous.

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

Usage Guidelines5/5

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

Provides explicit when-to-use context: requires a `jobId` from `ethora-users-batch-create-v2`, and contrasts with the blocking alternative `ethora-wait-users-batch-job-v2`. It also specifies auth requirements (B2B mode with matching token) and lists common error conditions (401/403, 404), giving the agent clear conditions for invocation.

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