Skip to main content
Glama

get_webhook_event

Get a BitPal webhook event's payload schema (envelope {id, event, created_at, data} plus data fields). Events: checkout.session.created, checkout.session.deposit_detected, checkout.session.paid, checkout.session.settled, checkout.session.unresolved, checkout.session.expired, checkout.refund.recorded, x402.payment.resolved.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "event": "<event>"
    },
    "name": "get_webhook_event"
  }
}

Input Schema

NameRequiredDescriptionDefault
eventYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

No annotations are supplied, so the description carries the full burden. It does disclose the key behavioral trait — that the response is a payload schema with envelope {id, event, created_at, data} plus data fields, rather than live event data — but it says nothing about permissions, error behavior for unknown events, or rate limits.

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?

The first sentence is efficient and front-loaded with the most useful fact (this returns a schema, plus the envelope shape). The second sentence duplicates the enum values already present in the input schema, consuming roughly half the description without adding information.

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 one-parameter lookup with no output schema, the description covers what is returned (schema, envelope structure, data fields) and which events are addressable. Only the enum repetition and absent permission/error guidance keep it from being fully complete.

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 0%, but the single parameter is a self-explanatory enum. The description re-lists the same eight event values verbatim, which adds no meaning beyond the schema and does not explain per-event payload differences or format expectations.

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 uses a specific verb+resource ("Get a BitPal webhook event's payload schema") and immediately clarifies that the result is a schema, not an event instance, which separates it from a data-fetching interpretation. It does not explicitly contrast with siblings like get_api_operation or get_doc, so it stops short of a 5.

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: an agent can infer it should call this when it needs to know the payload shape for a given event type. There is no stated when-not-to-use, no mention of alternatives such as get_api_operation, and no prerequisites or auth context.

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