Skip to main content
Glama

create_opt_out_list

Create an SMS opt-out list to manage recipients who have unsubscribed, with configurable name, slug, and active or default settings.

Instructions

Create an SMS opt-out list. OpenAPI body is loosely documented; common fields include name/slug and optional default/active flags.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoList name
slugNoUnique slug within the account
activeNoActive flag
is_defaultNoTreat as default list
descriptionNoDescription

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.2/5.0
Behavior2/5

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It merely states that it creates a list, which implies mutation, but does not mention any side effects, required permissions, idempotency, return behavior, or failure modes. The description offers no additional behavioral context beyond the obvious fact of creation.

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 sentences, front-loaded with the primary purpose, and includes a useful caveat about documentation quality. There is no fluff or redundancy; every word contributes. It is appropriately concise for a create operation.

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?

With no output schema and no annotations, the description must cover return values, prerequisites, and error scenarios. It does none of these. For a create tool, an agent would benefit from knowing whether it returns the created object, if it requires existing account context, or how it relates to opt-out entries. The description is incomplete for an agent to invoke it confidently, especially given the 5 optional parameters and no required fields.

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?

The schema provides descriptions for all 5 parameters (100% coverage), so the baseline is 3. The description adds marginal value by noting that 'name/slug' are common and 'default/active' are optional flags, which roughly aligns with the schema. However, it does not add meaningful semantic detail beyond what the schema already documents, and it slightly under-weights the 'description' parameter.

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 verb ('Create') and resource ('SMS opt-out list'), which distinguishes it from sibling tools like list_opt_out_lists (listing) and create_opt_out_entry (creating entries within a list). The purpose is specific and unambiguous, and the caveat about OpenAPI documentation does not obscure the core function.

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 guidance on when to use this tool versus alternatives such as create_opt_out_entry or add_contacts_to_list. No explicit exclusions or conditions are provided. The description only states what it does, leaving the agent to infer usage context, which is insufficient given the presence of closely related sibling tools.

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