Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Create Webhook

create_webhook

Register an HTTPS webhook endpoint for an API key to receive notifications for selected Australian business registry events, such as status changes and monitoring alerts.

Instructions

Register a webhook endpoint for this API key (max 10 per key). url must be HTTPS on a public host.

event_types: one or more of company_registration.status_changed, abn_registration.status_changed, business_name_registration.status_changed, business_name_renewal.status_changed, ppsr.alert.grantor_registration_changed, monitoring.change_detected, monitoring.expiring, monitoring.expired — or ["*"] for everything. The response includes the signing secret (whsec_…) ONCE: give it to the user to store immediately; GET never returns it (rotate_webhook_secret issues a new one). Read bapi://docs/webhooks for the delivery payload, signature check and retries.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "url": "<url>",
      "event_types": "<event_types>"
    },
    "name": "create_webhook"
  }
}

Input Schema

NameRequiredDescriptionDefault
urlYes
event_typesYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.7/5.0
Behavior5/5

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

Annotations only say this is a non-idempotent, non-destructive write with open-world effects. The description goes well beyond that: it discloses the per-key limit, the HTTPS/public-host validation, that the signing secret (whsec_…) is returned exactly once and never again via GET, and points to bapi://docs/webhooks for payload, signature and retry behavior.

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?

The action and its key constraint are front-loaded, and the secret-handling warning is placed where it will be read before the call. The full event-type list restates the schema enum verbatim, which is mild redundancy, though it usefully makes the valid set readable in one place.

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 two-parameter creation tool with an output schema already defined, the description covers the remaining agent-facing needs: preconditions, quota, the one-time secret and where to find delivery/signature/retry documentation. Nothing needed to invoke or handle the result correctly is missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 0%, so the description must carry the load, and it does: it constrains url to HTTPS on a public host and enumerates every accepted event_type plus the wildcard form. Both required parameters gain validation semantics the bare JSON schema does not convey.

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?

The description opens with a specific verb and resource plus scope: 'Register a webhook endpoint for this API key (max 10 per key)'. It also names related operations (GET never returns the secret; rotate_webhook_secret issues a new one), so an agent can distinguish creation from retrieval and rotation without opening another 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 gives concrete preconditions for use: the endpoint must be HTTPS on a public host, there is a cap of 10 per key, and event_types must be one or more named events or ["*"]. It stops short of directing the agent to update_webhook when a hook already exists, which is the one gap.

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