Skip to main content
Glama
oborseth

Official Porkbun MCP Server

List Webhooks

list_webhooks
Read-onlyIdempotent

Retrieve all webhook endpoints registered on the authenticated Porkbun account, including their IDs, URLs, subscribed events, status, failure counts, timestamps, last errors, and signing secrets.

Instructions

List the webhook endpoints registered on the authenticated account. Each endpoint includes its id, URL, subscribed events, status (ACTIVE|DISABLED), consecutive failure count, last success/failure timestamps, last error, and signing secret. Porkbun POSTs a signed JSON payload to each endpoint when subscribed events occur; deliveries are signed with the endpoint's secret via HMAC-SHA256 over {timestamp}.{rawBody} and sent in the X-Porkbun-Signature header.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.39.4

TDQS

A3.7/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety is covered. The description goes beyond them by explaining the webhook delivery model, the HMAC-SHA256 signing scheme over `{timestamp}.{rawBody}`, and the `X-Porkbun-Signature` header — genuinely useful context an agent could not get from annotations alone.

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?

Purpose is front-loaded in the first sentence and the response fields are enumerated compactly. The second sentence on signing mechanics is longer than strictly needed for a listing tool, but it is informative rather than filler.

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

Completeness5/5

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

With no output schema present, the description carries the return-value burden and does so thoroughly — id, URL, events, status enum, failure count, timestamps, last error, and secret are all named. Together with the delivery semantics, an agent has everything needed to call and interpret this tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The tool takes zero parameters, so the baseline is 4; there is nothing for the description to disambiguate. It correctly does not invent parameter detail.

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?

States a specific verb (List) and resource (webhook endpoints) with an explicit scope constraint ('registered on the authenticated account'), and enumerates the returned fields. However, it never distinguishes itself from close siblings like get_webhook or list_webhook_deliveries, so the agent must infer the boundary from the name alone.

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, no indication of when to prefer get_webhook or list_webhook_deliveries, and no mention of prerequisites or pagination behavior. The zero-parameter list shape implies basic usage, but nothing is stated.

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