Skip to main content
Glama

get_newsletter_schema

Read-onlyIdempotent

Discover newsletter operations, merge tags, signup fields and email document blocks. OAuth scope newsletter:read. Use get_newsletter_schema for document, filter and field definitions.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
project_idYes

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, and non-destructive, and the description helpfully adds the required OAuth scope ('newsletter:read'), which is genuine auth context beyond the structured fields. It stops short of describing pagination or response shape, but an output schema exists to cover returns.

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

Conciseness3/5

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

Two compact sentences with no filler, but the second sentence ('Use get_newsletter_schema for document, filter and field definitions') is redundant with the name and the first sentence, so it does not earn its place.

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

Completeness4/5

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

For a read-only, single-parameter discovery tool with an output schema, the description covers the main content domains and adds the auth scope. The remaining gap is the unexplained project_id argument.

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?

The single parameter (project_id) has 0% schema description coverage, so the description must compensate — yet it never mentions project_id or what scope of project it expects. This leaves the only parameter unexplained in both schema and description.

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 specific verb+resource (get the newsletter schema) and enumerates the schema domains it exposes: operations, merge tags, signup fields, email document blocks, and filter/field definitions. No sibling tool serves this discovery role, so an agent can distinguish it, though the second sentence largely restates the name.

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?

Usage is only implied ('Use get_newsletter_schema for document, filter and field definitions'), which is close to tautology and gives no when/when-not guidance or routing relative to siblings like list_newsletter_lists or list_newsletter_custom_fields. The agent can infer this is a metadata-discovery call but is not told explicitly.

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