Skip to main content
Glama

remove_hook

Removes an inbound webhook so its address stops answering; retries are idempotent. Use it to deactivate a deployed app's hook without clearing its signing secret.

Instructions

Remove an inbound webhook; its address stops answering. Idempotent.

    The signing secret stays set (remove it with ``remove_secret``). A
    webhook still declared in nerdit.toml comes back with a NEW address on
    the next deploy.
    

Input Schema

NameRequiredDescriptionDefault
nameYesName (or row id) of an existing deployed app — only kind 'service' can be exposed: ``share_service``/``add_domain`` refuse a model or database with 422 ``*.kind_unsupported``, while the remove tools just find nothing to undo.
hook_nameYesWebhook name: lowercase letters, digits and '-', 1-32 characters, starting with a letter (e.g. ``stripe``); maps to ``NERDIT_HOOK_<NAME>_SECRET`` and ``NERDIT_HOOK_<NAME>_URL``.
idempotency_keyNoCaller-chosen key: a retry with the same key replays the first result instead of acting twice. Omit and a fresh key is minted per call, so each call acts.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.2/5.0
Behavior4/5

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

No annotations are provided, so the description carries the burden and does well: it discloses idempotency, that the endpoint stops answering, that the signing secret survives, and the non-obvious redeploy resurrection with a fresh address. It omits auth/permission requirements and any indication of what the call returns, which keeps it below a 5.

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 core action and effect lead the description, with the two caveats following as short, self-contained notes. Every sentence conveys a distinct behavioral fact; nothing is redundant with the name or the schema.

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 three-parameter mutation tool with no annotations and no output schema, the description covers the consequential behaviors (idempotency, secret persistence, redeploy recreation) that an agent would otherwise get wrong. The remaining gap is what a successful call returns or errors on, which is minor given full schema coverage.

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 both required parameters and idempotency_key are fully documented in the schema itself. The description adds only indirect context ('a webhook still declared in nerdit.toml' hints at hook_name) and no syntax or semantics beyond the schema, so baseline 3 applies.

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 and resource ('Remove an inbound webhook') plus the observable effect ('its address stops answering'), which distinguishes it from add_hook/list_hooks and from remove_secret. An agent can tell exactly what this tool does 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?

It explicitly routes the secret-removal case to remove_secret and warns that a webhook still declared in nerdit.toml will be recreated with a NEW address on the next deploy, which is precisely the condition an agent needs before calling. It stops short of stating 'use this when you want to stop receiving deliveries' or naming list_hooks for discovery, so it is clear context rather than full when/when-not coverage.

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