Skip to main content
Glama

replace_preference_topic

Idempotent

Replace a topic within a section. Full document replacement; missing optional fields are cleared.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYesHuman-readable name for the preference topic
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

TDQS

B3.2/5.0
Behavior1/5

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

The description states that missing optional fields are cleared, which is a destructive overwrite of existing data, yet the annotations declare destructiveHint=false. This directly contradicts the annotation's safety signal. Without that contradiction, the description would be strong, but as written it is misleading about the operation's destructiveness.

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 short sentences that front-load the core action and then add the most important behavioral caveat. Every word earns its place; there is no repetition or filler.

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

Completeness3/5

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

For an 8-parameter replacement tool with nested objects and no output schema, the description is largely adequate because the schema documents all parameters. However, the contradiction with destructiveHint=false leaves the agent with a confused safety model, and the description does not mention expected return behavior or side effects on existing topic data beyond clearing omitted fields.

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 coverage is 100%, with optional fields already documenting 'Omit to clear.' The description adds a cross-cutting rule that all omitted optional fields are cleared, which clarifies behavior beyond any single parameter description and is especially useful for booleans like include_unsubscribe_header that do not independently say 'Omit to clear.'

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 states a specific verb and resource: replace a topic within a section. 'Full document replacement' adds a precise semantic that distinguishes it from partial-update siblings, though it does not explicitly name an alternative or clarify that this is a preference-topic admin operation rather than a user-preference operation.

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 clearly implies usage: use this when you need a full replacement where omitted optional fields are cleared. However, it does not explicitly state when not to use it or name alternatives such as update_user_preference_topic or replace_preference_section, leaving some routing to the agent's inference.

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.

TDQS

B3.1/5.0
Disambiguation3/5

Tools are mostly organized as distinct resource/action pairs, but several clusters are easy to confuse: list subscription tools (add_subscribers_to_list vs bulk_subscribe_to_list vs subscribe_user_to_list), message vs message-content vs message-history retrieval, and the many journey/journey-template list/get tools. Detailed descriptions rescue most selections, but the sheer number of near-identical verb/resource names creates real misselection risk.

Naming Consistency4/5

Almost all tools follow a snake_case verb_noun pattern (create_, get_, list_, replace_, send_, publish_, archive_). Minor deviations keep it from a perfect score: courier_installation_guide is noun-first, and add_bulk_users sits awkwardly next to the bulk_add_* family, but the overall convention is predictable and readable.

Tool Count1/5

144 tools is an extreme working-set size for an agent to hold and choose from, far beyond the reasonable 3–15 range. Even for a broad platform like Courier, this should be split into focused sub-servers (templates, journeys, users, lists, preferences, etc.) to remain usable.

Completeness4/5

The surface is remarkably comprehensive, covering sending, templates, journeys, automations, users, tenants, lists, preferences, providers, routing, brands, audiences, translations, digests, bulk jobs, and audit events. Notable gaps exist—automation template CRUD and digest schedule management are missing—but most workflows can still be completed with workarounds.