Skip to main content
Glama

Ray notifications

by io.github.gege-mn
OverviewDiscussionsAdmin

Create template

create_template

Create a template (POST /templates; write scope). channelKind is permanent and must match the channels you'll send through (list_channels templateKind). It is saved as an unpublished draft unless publish: true; sending by templateId needs a published version (publish_template). Names are unique per workspace including archived templates: a collision returns 409, so unarchive_template the old one instead. Returns { id, requiredParams }. Designed (drag-and-drop) email templates can only be made in the dashboard.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesTemplate name, unique per workspace (archived templates included).
folderNoOptional folder path for organisation, e.g. "billing".
contentYesChannel-shaped template body; the shape is fixed by `channelKind`: email_html → `{ subject, bodyHtml, bodyText }`; fcm_basic → `{ title, body, imageUrl?, data?: { [key]: string } }`; slack_text → `{ text }`; discord_text → `{ content }` (max 2000 chars); telegram_text → `{ text, disableLinkPreview? }`; webhook_json → `{ title, body, data?: { [key]: string } }`. Use `{{name}}` placeholders and `{{#items}}…{{/items}}` sections; the required params are derived from them automatically.
publishNotrue = publish this version immediately so sends by templateId use it. Default false (saved as draft).
logTitleYesShort title shown in the in-app feed and delivery logs, e.g. "Invoice {{number}} is due". Placeholders allowed.
channelKindYesWhich channel family the template renders for. Must match the `templateKind` of the channels you will send through (list_channels). Can't be changed after creation.
logDescriptionYesOne-line description for the in-app feed and delivery logs. Placeholders allowed.
paramOverridesNoPer-param metadata keyed by param name: `{ optional?: boolean, description?: string }`. Mark a placeholder optional so sends may omit it.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only mark the operation as non-read-only, non-idempotent, and non-destructive. The description adds rich behavioral context: channelKind is permanent, templates default to unpublished drafts, names collide with archived templates returning 409, and the response shape is { id, requiredParams }.

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?

Four dense sentences deliver the endpoint, core constraints, collision behavior, return value, and a dashboard-only limitation without redundant schema repetition. The most important facts are front-loaded.

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 complex 8-parameter tool with no output schema, the description covers the operational details an agent needs: default draft behavior, publish flow, uniqueness/409 handling, channelKind permanence, and the dashboard exception. The schema covers the parameter shapes.

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?

The schema already covers all 8 parameters at 100%, so the baseline is 3. The description adds valuable semantics: channelKind must match list_channels templateKind, publish controls draft vs published state, and requiredParams are derived automatically from content placeholders.

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 and resource ('Create a template'), the HTTP endpoint, and the write scope, with enough detail to distinguish it from publish_template and update_template_draft. The operation is unambiguous and correctly named.

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

Usage Guidelines4/5

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

Provides clear routing guidance: use publish_template to make a draft sendable, unarchive_template on 409 collisions, and the dashboard for drag-and-drop email templates. It does not explicitly exclude update_template_draft, but the create-vs-update context is inferable.

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

All Ray notifications toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources