Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Renew Entity Monitoring

renew_entity_monitoring
Idempotent

Renews monitoring for up to 25 entities for another 12 months. Requires an idempotency key and returns order details; dry_run defaults to true to preview the charge.

Instructions

Renew monitoring for up to 25 entities for another 12 months. LIVE cost $18.00 per entity; sandbox $0.

Monitoring never auto-renews: act on monitoring.expiring webhooks (30 and 7 days before expiry) or list_monitored_entities with expires_before. idempotency_key is REQUIRED by the API (400 without it): your unique string per renewal batch, reused on retries so a timed-out retry never buys a second year. Active entities: the new term starts at the current expiry; expired: today. Expiry can't go more than 2 years ahead (renewal_too_far_ahead). A stopped entity with time left must be resumed, not renewed. Deregistered companies / cancelled ABNs can't be renewed. Any id not yours -> whole request 404, nothing charged. Response has the order shape {unitPrice, total, entities}. dry_run=true (default) returns the payload only.

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_ids": "<entity_ids>",
      "idempotency_key": "<idempotency_key>"
    },
    "name": "renew_entity_monitoring"
  }
}

Input Schema

NameRequiredDescriptionDefault
dry_runNo
entity_idsYes
idempotency_keyYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A5/5.0
Behavior5/5

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

Annotations already declare idempotentHint=true, destructiveHint=false and openWorldHint=true, but the description adds far more: per-entity cost in live vs sandbox, the mandatory idempotency_key (400 without it) and how to reuse it on retries, term-start rules for active vs expired entities, the 2-year ahead ceiling, and all-or-nothing 404 behavior with nothing charged.

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?

It is dense but front-loaded and entirely operational: cost, trigger, idempotency, term rules, failure modes, dry_run. No sentence is filler, and parenthetical error codes are compact.

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 paid mutation touching multiple entities, it covers cost, idempotency, timing, failure semantics and the output order shape even though an output schema already exists. Nothing an agent needs to call it safely 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 explains that idempotency_key is required by the API and how to construct/reuse it, that entity_ids is capped at 25, and that dry_run defaults to true and returns only the payload rather than charging.

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 opening sentence gives a specific verb (renew), resource (monitoring), scope (up to 25 entities) and duration (another 12 months). It also implicitly separates itself from start/resume by noting later that 'A stopped entity with time left must be resumed, not renewed.'

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It names concrete triggers (monitoring.expiring webhooks at 30 and 7 days, or list_monitored_entities with expires_before) and explicitly excludes a case in favor of a sibling: stopped entities with time remaining must be resumed, not renewed. Deregistered companies and cancelled ABNs are also excluded.

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