Skip to main content
Glama

Create webhook

loyverse_create_webhook

Subscribe an HTTPS endpoint to a Loyverse event so it receives live merchant business data. Use only URLs provided by the user.

Instructions

Subscribe an https endpoint to a Loyverse event. The endpoint will receive the merchant's live business data, so only register a URL the user has given you.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesThe https endpoint Loyverse will POST to.
typeYesWhich event to subscribe to.
statusNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already indicate this is a write operation and not idempotent, so the description does not need to restate that. It adds valuable behavioral context beyond the annotations: the endpoint will receive live merchant data and therefore requires user-provided consent. No contradiction with the annotations was found.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is two sentences with no wasted words. The core action is front-loaded in the first sentence, and the second sentence delivers an important user-consent caveat that earns its place.

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 simple creation tool with three parameters and no output schema, the description provides the key operational consequence (live data delivery) and the critical authorization guardrail. It could be slightly more complete by addressing the status parameter, but the schema and enums cover the remaining essentials.

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?

The input schema already describes the url and type parameters with useful detail, and the description loosely mirrors those semantics. However, the description does not clarify the optional status parameter or its default behavior, so it adds limited meaning beyond the schema and enum constraints.

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

Purpose5/5

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

The description uses a specific verb ('Subscribe') with a clear resource ('an https endpoint') and target ('a Loyverse event'), making the tool's function immediately recognizable. It also distinguishes this from sibling tools like loyverse_list_webhooks by describing the creation of a live-data subscription rather than a read or listing operation.

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?

The description gives a clear practical usage condition: only register a URL the user has provided, because the endpoint will receive live business data. It does not explicitly name alternatives or exclusions, but the context is strong enough for an agent to know when invoking this tool is appropriate.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.