Skip to main content
Glama
Pletopay MCP Server

Pletopay MCP Server

Official
by pletopay

Register a webhook endpoint. The signing secret is returned only in this response.

create_webhook_endpoint

Register a webhook endpoint to receive events and choose event subscriptions; the signing secret is returned only in this response for verifying payload signatures.

Instructions

Register a webhook endpoint. The signing secret is returned only in this response.

Register a publicly reachable endpoint to receive events (https is required for live mode; private network addresses are refused). Subscribe to specific enabled_events or * for all. The signing secret (whsec_…) is returned only in this response: store it to verify X-PletoPay-Signature. You can have up to 16 endpoints per mode (400 webhook_endpoint_limit_reached).

Input Schema

NameRequiredDescriptionDefault
urlYes
descriptionNo
enabled_eventsYes
idempotency_keyNoOptional. A unique key for this request; retrying with the same key returns the original result instead of acting twice. One is generated if omitted.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

The description adds substantial behavior beyond the annotations: public reachability is required, HTTPS is mandatory in live mode, private network addresses are refused, and the signing secret appears only in the creation response. It also explains how the secret is used, discloses the 16-endpoint-per-mode limit, and supplies the exact quota error.

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?

The important operational constraints are front-loaded and expressed compactly. Repeating the title's opening and then restating the one-time-secret warning introduces noticeable redundancy, preventing a perfect conciseness score.

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?

Despite the absence of an output schema, the description discloses the most important response behavior: the `whsec_…` secret is available only once and must be stored for signature verification. Combined with the schema, it covers required inputs, event selection, idempotent retries, endpoint validation, limits, and a relevant failure mode, which is sufficient for correct invocation and result handling.

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

Parameters5/5

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

With only 25% schema description coverage, the description compensates well by explaining the reachability and protocol constraints on `url` and the wildcard behavior of `enabled_events`. Together with the schema's event enum and idempotency-key documentation, this gives the agent enough meaning to populate all consequential parameters correctly.

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 clearly states the verb and resource: registering a publicly reachable webhook endpoint to receive subscribed events. It does not explicitly contrast creation with siblings such as update_webhook_endpoint, test_webhook_endpoint, or rotate_webhook_secret, so sibling differentiation remains implicit.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It provides clear usage context: create an endpoint to receive either selected events or all events using `*`. However, it gives no explicit when-not guidance or alternatives, such as updating an existing endpoint or rotating the secret of one already created.

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