Skip to main content
Glama
businessapi-mcp

businessapi-mcp

by JoeFu

Get Request Schema

get_request_schema
Read-onlyIdempotent

Fetches the JSON Schema for a lodge_* tool's request object so you can build valid lodgement payloads before submission.

Instructions

Return the JSON Schema (with $defs) for a lodge_* tool's request object. Call it before building a lodgement.

form -> tool: company_registration -> lodge_company_registration · abn_registration -> lodge_abn_registration · business_name_registration -> lodge_business_name_registration · business_name_renewal -> lodge_business_name_renewal · asic_484_form -> lodge_asic_484_form · company_name_change -> lodge_company_name_change · company_deregistration -> lodge_company_deregistration · asic_361_form -> lodge_asic_361_form · asic_362_form -> lodge_asic_362_form. Field descriptions carry the vendor's rules and enums are the ASIC/ATO code tables; cross-field "Mandatory IF" rules are enforced when you call the tool and reported as field errors. The same schema is readable at bapi://schemas/{form}.

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": {
      "form": "<form>"
    },
    "name": "get_request_schema"
  }
}

Input Schema

NameRequiredDescriptionDefault
formYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.8/5.0
Behavior5/5

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

Goes well beyond the readOnly/idempotent annotations: it discloses that field descriptions carry vendor rules, that enums are the actual ASIC/ATO code tables, and that cross-field "Mandatory IF" rules are enforced server-side at call time and surfaced as field errors. That is a real behavioral property an agent cannot get from annotations or the one-param schema.

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-loaded with the action and the call-before-building rule; the middle-dot mapping list is dense but earns its space by tying forms to tools. Slight redundancy with the enum values already in the schema and the '$defs' detail are minor noise.

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 one-parameter, read-only schema-fetch tool with an existing output schema, nothing needed to invoke it correctly is missing: trigger, alternatives, param meaning, and validation/error behavior are all covered.

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

Parameters4/5

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

The single `form` parameter has 0% schema description coverage, so the description must compensate. It does, by mapping each enum value to the lodge_* tool it drives and explaining what the enum values mean (ASIC/ATO code tables), though it never states that `form` must match the lodge tool the agent intends to call.

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 ("Return the JSON Schema ... for a lodge_* tool's `request` object") and scopes it to a named family of siblings, so an agent can distinguish it from the lodge_* tools it feeds and from the status/getter siblings.

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?

Explicitly says when to call it ("Call it before building a lodgement") and names an alternative access path ("The same schema is readable at bapi://schemas/{form}"), giving the agent both a trigger and a fallback.

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