Skip to main content
Glama

Courier

by io.github.trycourier
OverviewDiscussionsAdmin

create_preference_topic

Create a subscription preference topic inside a section. The topic id is generated and returned. Fails with 404 if the section does not exist.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name for the preference topic
digestNoBatch this topic's notifications into a scheduled digest. Omit to leave any existing digest untouched; pass null to turn it off.
section_idYesId of the preference section to create the topic in
topic_dataNoArbitrary metadata associated with the topic
default_statusYesDefault subscription status applied when a recipient has not set their own
routing_optionsNoDefault channels delivered for this topic. Defaults to empty if omitted.
allowed_preferencesNoPreference controls a recipient may customize for this topic
include_unsubscribe_headerNoWhether to include a list-unsubscribe header on emails for this topic

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedInput schema / properties / digest
      Added value: +{
+  "anyOf": [
+    {
+      "additionalProperties": false,
+      "properties": {
+        "audience_id": {
+          "description": "Optional audience the digest is scoped to",
+          "type": "string"
+        },
+        "categories": {
+          "description": "Retention rules per category key. Defaults to a single `digest` category.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "category_key": {
+                "description": "Key identifying the category within the digest",
+                "type": "string"
+              },
+              "limit": {
+                "description": "How many collected events reach the rendered digest. Defaults to 10.",
+                "type": "integer"
+              },
+              "retain": {
+                "description": "Which collected events survive the limit",
+                "enum": [
+                  "FIRST",
+                  "LAST",
+                  "HIGHEST",
+                  "LOWEST",
+                  "NONE"
+                ],
+                "type": "string"
+              },
+              "sort_key": {
+                "description": "Data key to rank events by. Required when retain is HIGHEST or LOWEST.",
+                "type": "string"
+              }
+            },
+            "required": [
+              "category_key"
+            ],
+            "type": "object"
+          },
+          "type": "array"
+        },
+        "schedules": {
+          "description": "The cadences this digest delivers on. At least one is required.",
+          "items": {
+            "additionalProperties": false,
+            "properties": {
+              "day_of_month": {
+                "description": "Required when frequency is monthly",
+                "type": "integer"
+              },
+              "day_of_week": {
+                "description": "Required when frequency is weekly",
+                "enum": [
+                  "sunday",
+                  "monday",
+                  "tuesday",
+                  "wednesday",
+                  "thursday",
+                  "friday",
+                  "saturday"
+                ],
+                "type": "string"
+              },
+              "days_of_week": {
+                "description": "Required when frequency is custom_days",
+                "items": {
+                  "enum": [
+                    "sunday",
+                    "monday",
+                    "tuesday",
+                    "wednesday",
+                    "thursday",
+                    "friday",
+                    "saturday"
+                  ],
+                  "type": "string"
+                },
+                "type": "array"
+              },
+              "disabled": {
+                "description": "Whether the schedule is disabled",
+                "type": "boolean"
+              },
+              "frequency": {
+                "description": "How often the digest delivers. `instant` delivers each event immediately.",
+                "enum": [
+                  "instant",
+                  "daily",
+                  "weekdays",
+                  "weekly",
+                  "custom_days",
+                  "monthly"
+                ],
+                "type": "string"
+              },
+              "is_default": {
+                "description": "The schedule recipients are placed on when they have not chosen one",
+                "type": "boolean"
+              },
+              "schedule_id": {
+                "description": "Id of an existing schedule to update. Omit to create a new one.",
+                "type": "string"
+              },
+              "time": {
+                "description": "24-hour local delivery time, HH:MM. Required for every frequency except instant.",
+                "type": "string"
+              },
+              "timezone": {
+                "description": "IANA timezone for `time` and the day fields, e.g. America/New_York",
+                "type": "string"
+              }
+            },
+            "required": [
+              "frequency"
+            ],
+            "type": "object"
+          },
+          "minItems": 1,
+          "type": "array"
+        },
+        "template_id": {
+          "description": "The notification template that renders the digest",
+          "type": "string"
+        },
+        "trigger_empty": {
+          "description": "Deliver the digest even when nothing was collected",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "template_id",
+        "schedules"
+      ],
+      "type": "object"
+    },
+    {
+      "type": "null"
+    }
+  ],
+  "description": "Batch this topic's notifications into a scheduled digest. Omit to leave any existing digest untouched; pass null to turn it off."
+}
  2. Added

TDQS

A4/5.0
Behavior4/5

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

Beyond the annotations (readOnly false, destructive false, idempotent false), the description adds that the topic id is generated and returned, and that it fails with a 404 if the section does not exist. This gives useful behavioral context about side effects and error conditions.

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 two concise sentences, front-loaded with the core action, followed by a key result and an error condition. No unnecessary words or redundancy; every sentence earns its place.

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

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (8 parameters, nested objects) and no output schema, the description is minimal but sufficient because the schema already documents all parameters thoroughly. It covers the essential behavioral points (creation, return value, error condition) and relies on annotations for safety and idempotency. It could mention idempotency but that's covered by annotations.

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 coverage is 100%, so the baseline is 3. The description does not elaborate on any parameters; it only references section existence implicitly. It adds no extra meaning beyond what the schema already provides, so a 3 is appropriate.

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 clearly states the tool creates a subscription preference topic within a section, using a specific verb and resource. It implicitly distinguishes from create_preference_section by specifying 'inside a section', and the generated id and 404 behavior add precision.

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

Usage Guidelines3/5

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

The description does not explicitly mention when to use this tool versus alternatives like create_preference_section or update tools. It implies usage context by noting the dependency on an existing section, but provides no exclusions or routing guidance to sibling tools.

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

All Courier 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