Skip to main content
Glama

set_webhook

Idempotent

Save or clear the webhook URL where Signal MCP's background receiver POSTs incoming messages. Omit URL to clear; restart service for changes to apply.

Instructions

Save or clear the webhook URL that signal-mcp's background receiver (signal-mcp receive --watch, run by install-service) POSTs every incoming message to. url (optional): an http(s) URL such as 'http://localhost:5678/webhook/signal'; omit it or pass null/empty to clear. Stored in ~/.local/share/signal-mcp/webhook.json; the receiver reads it at startup, so restart the service for a change to apply. The SIGNAL_MCP_WEBHOOK environment variable overrides it. Payload: JSON {event: 'message', timestamp, sender, recipient, group_id, body, quote_id, attachments, is_read, receipt_type, expires_in_seconds, view_once}. Returns {status: 'webhook set', url} or {status: 'webhook cleared'}. Use get_webhook to check the value in effect.

Input Schema

NameRequiredDescriptionDefault
urlNoWebhook URL to POST to (e.g. 'http://localhost:5678/webhook/signal'). Omit or pass null to clear.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv1.33.3

TDQS

A4.8/5.0
Behavior5/5

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

Annotations only declare mutating, idempotent, non-destructive. The description goes well beyond: storage path (~/.local/share/signal-mcp/webhook.json), that the receiver reads it only at startup, that SIGNAL_MCP_WEBHOOK overrides it, the exact JSON payload shape, and the two possible return objects.

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?

Front-loads the core action, then layers clearing semantics, storage/lifecycle, override behavior, payload and return shape. Dense but every sentence carries operational information; the payload field list is the only slightly expendable element.

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?

No output schema exists, yet the description spells out both return objects, the file it writes, the restart requirement, and the env-var override — everything needed to call it correctly and interpret the result.

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?

Schema coverage is 100% so the baseline is 3, but the description adds meaning the schema lacks: that an empty string (not just null/omission) also clears the webhook, plus the concrete localhost URL format used by the receiver.

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: saving or clearing the webhook URL that signal-mcp's background receiver POSTs messages to. It names the sibling (get_webhook) that retrieves rather than mutates, so an agent can separate the two without opening a schema.

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

Usage Guidelines5/5

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

Explicitly covers both branches: provide a URL to set, omit/null/empty to clear, and use get_webhook to inspect the effective value. It also names the operational precondition (restart the service for the change to apply).

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