Skip to main content
Glama

get_preference_topic

Read-only

Retrieve a topic within a section. Returns 404 if the section or topic does not exist, or the topic belongs to a different section.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
topic_idYesId of the subscription preference topic
section_idYesId of the preference section

TDQS

A4.1/5.0
Behavior4/5

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

The annotations already declare readOnlyHint=true, so the description's main contribution is the 404 behavior: it specifies that a missing section or topic, or a topic owned by a different section, results in a 404. This goes beyond the annotation and helps the agent anticipate failure states. It does not describe the success response format, but given the read-only nature and no output schema, the 404 details are valuable and add transparency.

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 short sentences, effectively front-loaded with the core action ('Retrieve a topic within a section') followed by the key error condition. There is no redundant wording or filler, and every sentence contributes useful information.

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 a simple retrieval tool with two required parameters and readOnly annotation, the description covers the access scope and failure modes. However, it does not state what a successful call returns (e.g., the topic object), which is notable since there is no output schema. An agent might infer it returns the topic, but explicit mention of the success payload would make it more complete. The 404 details are helpful, but the absence of success-response description is a minor gap.

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%, with both parameters having clear ID descriptions. The description adds the contextual relationship that the topic must belong to the given section, which is a semantic hint beyond the schema's simple ID labels. However, it does not elaborate on parameter formats, types, or constraints beyond what the schema states, so it only marginally supplements the schema.

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 ('Retrieve') and resource ('a topic within a section'), clearly distinguishing it from sibling tools like get_preference_section (retrieves a whole section) and list_preference_topics (lists topics). The phrase 'within a section' clarifies the hierarchical relationship, leaving no ambiguity about what the tool does.

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 gives clear context that the tool requires both a section and a topic, and implies it is used when you have both IDs. However, it does not explicitly name any alternative tool or state when not to use it. The 404 condition about a topic belonging to a different section adds usage nuance, but no direct comparison to siblings like get_preference_section or list_preference_topics. This is clear context without explicit exclusions.

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.