Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Simulate Monitoring Event

simulate_monitoring_event

Triggers a sandbox test entity event or lifecycle webhook to verify monitoring behavior, and refuses live use.

Instructions

SANDBOX ONLY: make a sandbox entity emit a test event + webhook. Give exactly one of: event_type — a change event such as document_lodged, address_change, status_change, gst_change, trade_mark_filed … (returns the event); simulate — expiring_30 | expiring_7 | expired (lifecycle webhooks) or deregistered (permanently marks the test entity deregistered; renew/resume are then refused). Refused in the live environment (the API returns 404 there too).

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": {
      "entity_id": "<entity_id>"
    },
    "name": "simulate_monitoring_event"
  }
}

Input Schema

NameRequiredDescriptionDefault
simulateNo
entity_idYes
event_typeNo

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.6/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing sandbox gating, the 404 in live, the permanent 'deregistered' consequence and the resulting refusal of renew/resume, and that event_type returns the event. The only tension is that annotations declare destructiveHint=false while 'deregistered' permanently alters a test entity, but the description's disclosure makes that effect explicit rather than contradicting the annotation's intent.

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 sandbox constraint, then branches into the two mutually exclusive parameter paths in a compact list. The terse 'Give exactly one of' phrasing and trailing ellipsis example are slightly cryptic but nothing is wasted.

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 an output schema, it covers the sandbox restriction, failure behavior, side effects and the distinction between the two modes. The one gap is not stating that entity_id must reference a sandbox/test entity, which an agent could get wrong.

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?

With 0% schema description coverage, the description does the full job: it names concrete event_type values, explains each simulate enum (lifecycle timing vs. permanent deregistration) and enforces the 'exactly one of' exclusivity that the schema does not encode. Only entity_id is left unexplained, which is acceptable for an obvious identifier.

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 ('make a sandbox entity emit a test event + webhook') plus the sandbox-only scope, which cleanly separates it from real monitoring tools like get_monitoring_event or start_entity_monitoring. The purpose is unambiguous 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?

Explicitly says 'SANDBOX ONLY' and 'Refused in the live environment (the API returns 404 there too)', which tells the agent when the call is appropriate. It also notes that deregistered blocks renew/resume, but it does not point to the sibling that inspects results (e.g. get_monitoring_event), so alternatives are only partially covered.

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