Skip to main content
Glama
thenavidm
by thenavidm

Get complimentary access

get_complimentary_access
Read-onlyIdempotent

Retrieve details of a specific complimentary access for a publication, optionally expanding tier information. Requires publication and complimentary access IDs.

Instructions

Get complimentary access. Reads account data. OAuth integrations require complimentary_access:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
expandNoOptional list of expandable objects. `tier` - Returns the full tier object associated with this complimentary access.
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
publication_idYesThe prefixed ID of the publication object
complimentary_access_idYesThe prefixed ID of the complimentary access object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

C2.9/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, destructiveHint=false, and openWorldHint, so the safety profile is covered. The description adds genuinely useful context beyond that: the required OAuth scope complimentary_access:read. The only weak point is the vague "Reads account data" phrasing.

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, front-loaded sentences with no padding. The auth-scope line earns its place, though "Reads account data" is filler that adds little.

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 4-parameter read tool with a fully documented schema and no output schema, the auth requirement is the key missing piece and it is present. However, the description never clarifies what the returned resource represents or how it relates to its list sibling, leaving a gap.

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%, with publication_id, complimentary_access_id, expand, and account all documented in the schema itself. The description adds nothing about parameter format or semantics, so the 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?

The description essentially restates the tool name and title ("Get complimentary access") without explaining what a complimentary access record is or how it differs from the sibling list_complimentary_access. "Reads account data" is vague and arguably inaccurate for a single-resource fetch, adding no distinguishing detail.

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 versus list_complimentary_access or any other sibling. The only conditional statement concerns OAuth scoping, not tool selection, so an agent gets no routing help.

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