create-webhookRegister an HTTPS endpoint to receive task events. Get a one-time signing secret for verification; store it securely.
Register an HTTPS endpoint to receive task events. The signing secret is returned ONCE here and can never be read back — store it. Needs the webhooks:write scope.
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | https URL | |
| name | Yes | ||
| events | No | Defaults to a sensible set when omitted |
Changes observed during successful MCP inspections.
v0.2.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. It discloses a critical one-time secret behavior ('signing secret is returned ONCE here and can never be read back') and the required scope, which is valuable for an agent to invoke correctly. Does not cover rate limits or idempotency, but covers the key operational caveat.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
Two sentences with the core purpose, a critical one-time secret warning, and an auth requirement. Information is front-loaded and every sentence earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description covers purpose, security-critical behavior (secret returned once), and required scope. It lacks output details and explicit event semantics, but the schema covers event defaults and the tool is straightforward to invoke correctly.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
The schema already describes url and events. The description adds 'HTTPS endpoint' and mentions task events, but does not add meaningful parameter details beyond the schema. With 67% schema coveragehare, this is adequate but not enhanced by the description.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description uses a specific verb ('Register') and resource ('HTTPS endpoint to receive task events'). It clearly distinguishes this from sibling tools like list-webhooks and update-webhook by stating the creation action and its purpose.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description states the necessary scope (webhooks:write), which is a clear prerequisite, and implies this is the tool to use when registering a webhook. However, it does not explicitly say when to prefer this over alternatives or mention exclusion cases.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.