Skip to main content
Glama

Set Webhook

webhook_set

Create or update a webhook subscription (upsert). If id is provided the call updates that webhook (PUT). If omitted it creates a new one (POST) — url and events are then required. Use this for declarative 'ensure webhook X exists' workflows.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idNoWebhook ID. Present → updates that webhook (PUT). Omitted → creates a new one (POST).
urlNoHTTPS endpoint URL that will receive event payloads. Required on create; optional on update.
activeNoWhether the webhook is active. Defaults to true on create.
eventsNoList of event types to subscribe to (e.g. 'message.received', 'email.bounced'). Required on create; optional on update.
authConfigNoAuth the platform presents to your endpoint IN ADDITION to the always-on X-Anima-Signature HMAC — a bearer token, HTTP basic, or a custom header. Pass { type: 'none' } to remove it.
descriptionNoOptional human-readable label
maxAttemptsNoMax delivery attempts before dead-lettering (default 3)
rateLimitPerMinuteNoMax deliveries per minute to this endpoint; omit for unlimited

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already declare write (readOnlyHint=false), non-destructive, and closed-world operation. The description adds meaningful behavior beyond that: the upsert semantics, the PUT/POST selection rule, and the create-time required fields. It omits auth requirements and side effects of updates, but adds real value over the structured fields.

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?

Three tight sentences, front-loaded with the upsert framing. Every clause earns its place and none is filler.

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 an 8-parameter write tool with 100% schema coverage and an output schema, the description covers the essential mode-selection semantics and the declarative use case. It could mention auth/signature expectations, but those live in the schema, so nothing critical is missing.

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 the schema already documents id, url, events, and the rest. The description restates the id→PUT/omitted→POST rule and the create-time required fields, but adds no syntax or format detail beyond what the schema provides. Baseline 3 is correct.

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?

States a specific verb+resource ('Create or update a webhook subscription') and immediately clarifies the upsert branch logic: id present = PUT update, id omitted = POST create. An agent can tell exactly what the tool does and how the mode is selected without opening the schema.

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?

Explicitly frames the tool for declarative 'ensure webhook X exists' workflows, which tells the agent when this is the right choice versus a plain create. It doesn't name the alternatives (e.g., webhook_delete for removal, webhook_test for verification), so it stops short of full when-not guidance.

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.