Skip to main content
Glama
getplatform

GetMailer MCP Server

by getplatform

get_batch

Check batch job status and progress for email operations by providing a batch ID.

Instructions

Get batch job status and progress

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesBatch ID

Implementation Reference

  • Handler for get_batch tool: fetches batch job status from the GetMailer API using the provided batch ID and returns the JSON result as text content.
    case 'get_batch': {
      const result = await apiRequest(`/api/batch/${args?.id}`);
      return {
        content: [{ type: 'text' as const, text: JSON.stringify(result, null, 2) }],
      };
    }
  • Input schema definition for the get_batch tool, requiring a 'id' string parameter.
      name: 'get_batch',
      description: 'Get batch job status and progress',
      inputSchema: {
        type: 'object' as const,
        properties: {
          id: {
            type: 'string',
            description: 'Batch ID',
          },
        },
        required: ['id'],
      },
    },
Behavior2/5

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is a 'Get' operation, implying it's read-only, but doesn't confirm safety aspects like whether it requires authentication, has rate limits, or what happens with invalid IDs. The description adds minimal behavioral context beyond the basic action, leaving gaps for a tool that likely interacts with batch processing systems.

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 a single, efficient sentence with zero waste. It's front-loaded with the core purpose ('Get batch job status and progress'), and every word earns its place by specifying what is retrieved. No unnecessary details or redundancy are present.

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?

Given the complexity of batch job operations, the lack of annotations, and no output schema, the description is incomplete. It doesn't explain what 'status and progress' entails (e.g., success/failure states, percentage completion, error messages) or the return format. For a tool with potential behavioral nuances, this minimal description leaves too much unspecified.

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?

The input schema has 100% description coverage, with the 'id' parameter documented as 'Batch ID'. The description doesn't add any meaning beyond this (e.g., explaining where to find the ID or its format). According to scoring rules, when schema coverage is high (>80%), the baseline is 3 even with no param info in the description, which applies here.

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 clearly states the verb ('Get') and resource ('batch job status and progress'), making the purpose immediately understandable. It doesn't specifically differentiate from sibling tools like 'list_batches' or 'create_batch', but the focus on retrieving status/progress for a specific batch is clear. No tautology or misleading elements are present.

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?

The description provides no guidance on when to use this tool versus alternatives like 'list_batches' (which likely lists multiple batches) or 'create_batch' (which creates new batches). There's no mention of prerequisites (e.g., needing a batch ID from a previous operation) or context for when this specific retrieval is appropriate. Usage is implied but not explicitly stated.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/getplatform/getmailer-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server