Skip to main content
Glama

subscription_status_set_v2

Update subscription group statuses for users through Braze's V2 API, setting each group to subscribed or unsubscribed by email, phone, or external ID.

Instructions

Update subscription group status for users (V2 API with more options).

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoEmail address
phoneNoPhone number
apiKeyNoBraze REST API key
external_idNoExternal ID
restEndpointNoBraze REST endpoint URL
subscription_groupsYesSubscription groups to update

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations and no output schema, the description carries the full burden. It says 'Update', implying a mutation, but does not disclose permission requirements, whether the update is idempotent, partial failure behavior across multiple subscription groups, or confirmation that it requires a user identifier (email, phone, or external_id).

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single efficient sentence with no waste. It is appropriately sized for a short description, though the parenthetical could be expanded to add more value.

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

Completeness2/5

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

For a mutation tool with 6 parameters, no annotations, no output schema, and several sibling alternatives, the description is too thin. It does not cover authentication needs (the apiKey parameter), the required user identification method, or the V2 vs V1 distinction, leaving significant gaps an agent must infer.

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 description coverage is 100%, so the schema already documents all 6 parameters including the nested subscription_groups array with enum values. The description adds no parameter-level meaning beyond the schema; baseline 3 is appropriate.

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 (Update) and resource (subscription group status for users), and the parenthetical '(V2 API with more options)' hints at a sibling v1 version. However, it doesn't describe what makes V2 different or when to choose it over 'subscription_status_set'.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance. The '(V2 API with more options)' is a thin hint that a V1 exists, but it does not specify conditions for selecting this tool over the sibling 'subscription_status_set'.

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

Deploy Server

Other Tools