Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Get Entity Snapshot

get_entity_snapshot
Read-only

Retrieves an active entity's current record from every monitored source as JSON, including details, registrations, trade marks, insolvency notices, and PPSR data.

Instructions

The entity's current record from every monitored source, as JSON (snake_case inside snapshot): entity_details (ASIC/ABR names, addresses, statuses, business_names), registrations (AFS/credit licences, ACNC), trade_marks, insolvency_notices, ppsr. Active entities only: 409 entity_not_active / snapshot_not_ready (new entity, wait a few minutes) / not_available_in_sandbox (sandbox entities have no live data); 503 snapshot_unavailable -> retry later. 20 requests/min. The same record as a dated PDF: GET /monitoring/entities/{id}/report?includeRecent=true (binary; fetch outside MCP).

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": "get_entity_snapshot"
  }
}

Input Schema

NameRequiredDescriptionDefault
entity_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.1/5.0
Behavior5/5

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

Beyond the readOnlyHint/openWorldHint annotations, the description discloses a concrete rate limit (20 requests/min), the failure modes with their HTTP-style codes and remedies (retry later on 503, wait on snapshot_not_ready), and sandbox limitations. That is exactly the operational context annotations cannot convey.

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 definition is dense but front-loaded: payload shape first, then error conditions, then rate limit, then the alternative delivery format. Every clause carries information, though the sentence-per-idea packing with semicolons and abbreviations (ASIC/ABR/AFS/PPSR) makes it slightly harder to scan.

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?

An output schema exists and the description still summarizes the returned structure, while also covering error codes, rate limiting, sandbox behavior, and the PDF alternative. For a single-parameter read tool, nothing an agent needs to call it correctly appears to be missing.

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

Parameters3/5

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

The single entity_id parameter has 0% schema description coverage, so the description must compensate; it indirectly constrains the parameter by requiring an active, monitored entity and by referencing the /monitoring/entities/{id}/report path. It never states the type/format of entity_id or that it is an internal entity id rather than an ABN/ACN, leaving a real gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb and resource ('The entity's current record from every monitored source, as JSON') and enumerates the sections returned (entity_details, registrations, trade_marks, insolvency_notices, ppsr), which makes the scope concrete. It does not explicitly distinguish itself from the similarly named sibling get_monitored_entity, so an agent must infer the difference, keeping it below a 5.

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 provides clear usage context: only active entities work, and specific failures (409 entity_not_active, snapshot_not_ready for a new entity with 'wait a few minutes', not_available_in_sandbox) are spelled out. It also routes the agent to an external endpoint for the dated PDF form. What's missing is any explicit statement of when to prefer this over get_monitored_entity or get_monitoring_event.

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