Skip to main content
Glama
Sign In

skanfirmy.pl

by io.github.bartosz-kuc
OverviewDiscussionsAdmin

set_webhook

Destructive

Set (or clear) a push webhook URL for your monitoring, instead of or in addition to polling. When we detect a change for a monitored NIP, we send a POST signed with HMAC-SHA256 (X-Skanfirmy-Signature header). Returns the secret ONCE. Pass an empty url to disable. Requires a skanfirmy API key. Public https addresses only (port 443).

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "set_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlNoPublic https URL of the receiver (empty = disable the webhook).
api_keyNoskanfirmy API key (optional, if not in the header).

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.7/5.0
Behavior5/5

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

Adds substantial behavior beyond the annotations: the delivery is a POST signed with HMAC-SHA256 in an X-Skanfirmy-Signature header, the secret is returned only once, and the receiver must be a public https address on port 443. These are exactly the facts an agent needs to set this up correctly, and the 'secret ONCE' note is consistent with idempotentHint=false and destructiveHint=true.

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?

Purpose is front-loaded in the first sentence, and each remaining sentence carries a distinct operational fact (signature scheme, one-time secret, disable method, auth, URL constraints) with no filler.

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?

For a 2-param, no-output-schema mutation tool, the definition covers auth, delivery mechanism, secret handling, disabling, and address constraints, plus the return of the secret. Nothing an agent needs to invoke it correctly is missing.

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; the description still adds meaning by stating that an empty url disables the webhook, that the address must be public https on port 443, and that an API key is required. The api_key/header distinction is partially already in the schema, so it's not a full 5.

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 ('Set (or clear) a push webhook URL') plus its scope ('for your monitoring, instead of or in addition to polling'), which cleanly separates it from the polling/query siblings like changes_since and list_observations.

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?

Explains the when: use it instead of or in addition to polling, and how to turn it off ('Pass an empty url to disable'). It gives clear context but doesn't explicitly say when not to use a webhook or name a sibling as the alternative.

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

All skanfirmy.pl toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources