Skip to main content
Glama

Courier

by io.github.trycourier
OverviewDiscussionsAdmin

replace_preference_topic

Idempotent

Replace a topic within a section. Full document replacement: omitted optional fields are cleared, except digest, which is left untouched when omitted. Pass digest: null to turn a digest off.

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.
topic_idYesId of the subscription preference topic
section_idYesId of the preference section
topic_dataNoArbitrary metadata associated with the topic. Omit to clear.
default_statusYesDefault subscription status applied when a recipient has not set their own
routing_optionsNoDefault channels delivered for this topic. Omit to clear.
allowed_preferencesNoPreference controls a recipient may customize. Omit to clear.
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.7/5.0
Behavior5/5

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

Beyond the annotations (readOnlyHint=false, idempotentHint=true, destructiveHint=false), the description discloses that omitted optional fields are cleared, with a special exception for `digest`. It also explains how to disable a digest via `null`. This adds meaningful behavioral context that annotations alone do not convey.

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?

Two sentences, no filler. The first sentence states the primary behavior; the second clarifies an important exception. Every word earns its place.

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?

The description covers the essential behavioral contract (replacement, field clearing, digest handling) needed to invoke the tool correctly. With 100% schema coverage, no output schema, and annotations for safety, nothing critical is missing for making a correct call.

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 each parameter is already documented. The description adds cross-cutting semantics: it explains the global replacement rule for all optional fields and the digest-specific edge case. This is valuable context beyond the per-parameter schema descriptions.

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 action ('Replace a topic within a section') with a clear resource ('preference topic') and scope ('within a section'). It distinguishes from sibling tools like replace_preference_section, and the phrase 'Full document replacement' adds crucial intent.

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?

The description explicitly frames the tool as 'Full document replacement' and explains the clearing semantics for omitted fields, which tells an agent when to choose this over a partial update. It does not name alternative tools or exclusion criteria, but the context is clear enough for correct selection.

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