Skip to main content
Glama

Ray notifications

Test-send template

test_send_template

Send a real test of a template's PUBLISHED version to one recipient (POST /templates/{id}/test-send; write scope). It goes through the provider for real, so use a recipient the user controls. Test sends don't count toward the monthly quota (a small daily allowance applies instead) and never appear in feeds. Returns { sendId } for get_send_status.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
paramsNoValues for the template's `{{placeholders}}`. Any JSON: strings, numbers, booleans, arrays and nested objects (arrays/objects drive `{{#section}}…{{/section}}` blocks). Missing required params are rejected with a 400 naming them.
recipientYesChannel-specific delivery target. Its shape depends on the kind of the chosen channel (list_channels returns each channel's exact `recipientSchema`): ses_email / smtp_email → `{ email, name?, cc?: [{ email, name? }], bcc?: [...], attachments?: [{ filename, content (base64), contentType?, disposition?: "attachment"|"inline", contentId? }] }`; fcm_push → `{ deviceToken }` OR `{ topic }` (exactly one; Ray keeps no device registry); telegram_bot → `{ chatId }` (numeric id as a string, or "@channelname"); slack_webhook, discord_webhook, generic_webhook → `{}` (the destination is part of the channel config).
templateIdYesThe template id (UUID).
channelConfigIdYesChannel to test through (from list_channels); its templateKind must match the template's channelKind.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=false, idempotentHint=false, destructiveHint=false, and openWorldHint=true. The description adds valuable behavioral context: the send goes through the provider for real, test sends don't count toward monthly quota but a daily allowance applies, and they never appear in feeds. It also discloses the return shape ({ sendId }). This goes beyond the annotations without contradicting them.

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 and front-loaded: the core action and endpoint appear in the first sentence, followed by the most important caveat (real send, use controlled recipient), then quota/feed behavior, then return value. Every sentence earns its place; no filler or repetition of schema details.

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?

For a tool with no output schema, the description covers the return value ({ sendId }), the real-world side effect, quota implications, feed visibility, and recipient guidance. The schema covers parameter shapes thoroughly. The only minor gap is that it doesn't explicitly state what happens on failure, but the schema's 400 note and the reference to get_send_status provide enough context. Overall, an agent has everything needed to invoke this correctly.

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?

Schema description coverage is 100%, so the baseline is 3. The description adds meaningful context beyond the schema: it explains that params drive section blocks, that missing required params are rejected with a 400 naming them, and it details the recipient shape per channel type (including that Ray keeps no device registry and webhooks use {}). This is genuinely helpful semantic enrichment.

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?

The description states a specific verb ('Send a real test'), a specific resource ('a template's PUBLISHED version'), and the exact endpoint (POST /templates/{id}/test-send). It clearly distinguishes this from send_notification and other template tools by emphasizing it tests the published version to one recipient. The write scope is also disclosed.

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?

The description explicitly says when to use this tool: to send a real test of a template's published version to one recipient. It warns to use a recipient the user controls, and notes the daily allowance vs monthly quota distinction. It also references get_send_status for follow-up, and the schema notes channelConfigId must match the template's channelKind, which guides correct selection.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.