Skip to main content
Glama
thenavidm
by thenavidm

Get webhook

get_webhook
Read-onlyIdempotent

Retrieve a specific Beehiiv webhook by publication ID and endpoint ID to inspect its configuration and destination. Requires webhooks:read for OAuth integrations.

Instructions

Get webhook. Reads account data. OAuth integrations require webhooks:read.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
accountNoNamed private account from BEEHIIV_ACCOUNTS. Defaults to BEEHIIV_DEFAULT_ACCOUNT or the first configured account.
endpoint_idYesThe prefixed ID of the webhook object
publication_idYesThe prefixed ID of the publication object

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

B3.1/5.0
Behavior4/5

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

Annotations already cover the safety profile (readOnlyHint, idempotentHint, destructiveHint=false, openWorldHint), so the description's job is to add context. It does add one genuinely useful behavior: the OAuth scope requirement webhooks:read. It does not describe error behavior (e.g. what happens with an unknown endpoint_id), which keeps it from a 5.

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 filler or redundancy. The only weak sentence is "Reads account data," which is vague and borders on generic boilerplate rather than earning its place.

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?

There is no output schema, so the description could reasonably say something about the returned webhook object, but it does not. Auth scope and the read-only safety profile are covered via description and annotations, leaving mainly the return shape and failure modes unspecified for an otherwise simple lookup.

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 three parameters (account, endpoint_id, publication_id) are already documented with patterns and defaults in the schema. The description adds no format, default, or constraint information beyond that, so the baseline 3 applies.

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

Purpose3/5

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

The first sentence, "Get webhook," is effectively a restatement of the tool name and title, contributing no new information. "Reads account data" adds a hint of scope but does not specify that this fetches a single webhook by endpoint ID, nor does it distinguish the tool from siblings like list_webhooks, create_webhook, update_webhook, or delete_webhook.

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 list_webhooks (fetch many) or the create/update/delete webhook siblings. The required publication_id + endpoint_id pairing implies a single-object lookup, but the description never states that the agent must already have the endpoint ID from a list call.

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