Skip to main content
Glama

create_newsletter_custom_field

Define a subscriber attribute before collecting it in forms. OAuth scope newsletter:write. Pass a stable idempotency_key for this intended action; reuse it on retries. Use get_newsletter_schema for document, filter and field definitions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
keyYes
labelYes
optionsNo
data_typeYes
project_idYes
idempotency_keyYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A3.6/5.0
Behavior4/5

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

Annotations only declare the generic safety profile (readOnlyHint=false, destructiveHint=false, openWorldHint=false); the description adds real behavioral content beyond them: the required OAuth scope newsletter:write and the retry-safe idempotency_key contract. It stops short of describing side effects such as whether the field is immediately available in forms or what happens on a key collision.

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?

Three tight sentences, front-loaded with the action and scope, then the idempotency contract, then cross-tool routing. No filler, though the trailing get_newsletter_schema pointer is the least essential sentence.

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?

An output schema exists so return values need no explanation, and annotations cover the safety profile, but with 0% schema coverage the description should have covered the enum data_type and the options object. Auth scope, idempotency and routing are present; parameter semantics are largely absent.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0% and six parameters exist, so the description must carry the load. It explains idempotency_key well (stable value, reuse on retries) but leaves key, label, data_type, options and project_id entirely undocumented — notably the enum data_type and the options object, which clearly interact.

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 names a concrete verb and resource ('Define a subscriber attribute') and adds ordering context ('before collecting it in forms'), which separates it from the read-only list_newsletter_custom_fields. It does not, however, explicitly distinguish itself from update_newsletter_custom_field, leaving the create-vs-modify boundary to inference.

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?

It gives clear usage context ('before collecting it in forms') and names the complementary tool to consult for definitions (get_newsletter_schema). It never states when not to use this tool, e.g. that modifying an existing field should go through update_newsletter_custom_field.

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.

Resources