Skip to main content
Glama
thenavidm
by thenavidm

Get segment

get_segment
Read-onlyIdempotent

Fetch a Beehiiv segment by publication and segment ID to read its data, with optional stats expansion for recently calculated segment metrics.

Instructions

Get segment. Reads account data. OAuth integrations require segments:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
expandNoOptionally expand the response to include additional data. `stats` - Requests the most recently calculated statistics for a segment. Segment stats are recalculated once daily around 7 a.m. UTC for dynamic segments, but can be manually recalculated at any time in the dashboard. Manual and static segments only calculate once upon upload or creation.
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
segment_idYesThe prefixed ID of the segment object
publication_idYesThe prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.7/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, covering the safety profile. The description adds one genuinely new fact — the required OAuth scope segments:read — which is useful auth context, though "Reads account data" merely echoes the readOnly annotation.

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 short sentences with the auth requirement front-loaded and no wasted filler. The only redundancy is the opening "Get segment," which duplicates the title rather than adding content.

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 read-only tool with complete annotations and 100% schema coverage, the minimum is largely met, and no output schema means return values need not be explained. However, it omits sibling differentiation and any note on the expand=stats option, which materially affects the response.

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 all four parameters (including the expand enum and the account selector) are already fully documented in the schema. The description adds no syntax, format, or default behavior beyond that, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose2/5

Does the description clearly state what the tool does and how it differs from similar tools?

"Get segment" restates the tool name and title verbatim, adding no distinguishing information. It does not differentiate from close siblings such as get_segment_subscribers, list_segments, or segments_expand_results, leaving the agent to infer what a "segment" object retrieval returns versus these alternatives.

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 when-to-use guidance and no named alternative. "Reads account data" is a generic statement that does not help an agent decide between this tool and get_segment_subscribers or list_segments. No exclusions or prerequisites are given.

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