businessapi-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| BAPI_ENV | No | Environment to use: `test` or `live`. Inferred from the key by default; used only as a cross-check, and a mismatch is reported. | |
| BAPI_API_KEY | No | Your Business API key. Also read from ./.env or from the user config file written by `businessapi-mcp setup`. | |
| BAPI_TOOLSETS | No | Comma-separated toolset groups to expose. | all |
| BAPI_ALLOW_LIVE | No | Must be `true` before any live POST, PATCH, or DELETE request is allowed. Off by default. | off |
| BAPI_INLINE_SCHEMAS | No | Set to `true` to put the full lodgement schemas into `tools/list`. Off by default. | off |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
NO API KEY CONFIGURED: every call will fail until the user runs businessapi-mcp setup or sets BAPI_API_KEY. Tools for businessapi.com.au — Australian ASIC/ATO/ABRS company, ABN, business-name, ASIC-form, PPSR and entity-monitoring APIs. This server is in the TEST environment. Read resource bapi://docs/overview before the first call and bapi://docs/endpoints to find a path. Lodgements are asynchronous: a POST returns a requestId, then poll get_request_status (or wait_for_request) until the status is 'finished' or 'rejected' (PPSR: 'completed' or 'failed'). The lodge_* tools (company, ABN and business-name registration, business-name renewal, company name change, deregistration, ASIC Forms 484/361/362) take a fully typed request (the schema is the vendor's field reference) and default to dry_run=true, which validates and returns the payload without lodging: show it to the user, confirm fees, then call again with dry_run=false. Entity monitoring orders/renewals also default to dry_run=true and need an idempotency_key you choose. Use the typed tools when one exists; otherwise use call_endpoint with a path from the catalogue. Here the lodge_* tools take request as a plain JSON object: first call get_request_schema(form) (or read bapi://schemas/{form}) for the exact field schema, build the object, then call the tool; invalid payloads come back as a readable list of field errors.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| logging | {} |
| prompts | {
"listChanged": true
} |
| resources | {
"subscribe": false,
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| lookup_abnA | Validate an Australian Business Number (ABN) and look it up on the ABR. abn: 11 digits (spaces allowed). Free, read-only, no lodgement. Use this before any registration, PPSR or monitoring call that needs a confirmed ABN / entity name. Response (ABR data, PascalCase keys): Abn, AbnStatus (Active / Cancelled), AbnStatusEffectiveFrom, Acn, EntityName, EntityTypeCode / EntityTypeName, Gst (GST registration date, empty if none), AddressState, AddressPostcode, AddressDate, BusinessName[] (current business names), Message (non-empty when the ABN is unknown or invalid). |
| lookup_acnA | Validate an Australian Company Number (ACN) and look the company up on ASIC. acn: 9 digits (spaces allowed). Free, read-only. Response (ASIC data): name, type (e.g. Australian Proprietary Company), class, subClass, status (Registered / Deregistered …), incorporationState, registrationDate, addresses[] {type, address, suburb, postcode, state}. |
| check_company_name_availabilityA | Check whether a proposed COMPANY name (including legal elements, e.g. "ACME PTY LTD") is available with ASIC. Free helper. Call this before lodge_company_registration or a name change / reservation. |
| check_business_name_availabilityA | Check a proposed BUSINESS (trading) name against ASIC's name test. Free helper. holder_name: legal name of the entity that will hold the name (e.g. "ACME TRADING PTY LTD"). Strongly recommended:
ASIC reports a match on the holder's own company name as "Identical", and with holder_name the response adds
|
| search_business_industriesA | Search the ATO main-business-activity list by keyword (e.g. "cleaning", "software", "cafe"). Free helper. Returns {searchTerm, activitiesCount, activities: [{score, code, industryCode, fullName}]} ranked by relevance.
Use |
| get_abn_entitlement_questionnaireA | Fetch the ABN entitlement questionnaire for an ATO entity type / sub-type (e.g. 117/006 sole trader, 051/027 private company, 161/150 partnership, 212/077 trading trust, 210/196 SMSF; codes in bapi://docs/ato-codes). Free helper. Walk the applicant through the questions and record each step as {questionId, answerId, nextQuestionId} in
|
| get_business_name_registration_statusA | Status of a business-name registration. Statuses: new -> … -> "wating ASIC CC payment" (card: response has transactionPaymentUrl + transactionFee; the payer must open the link) -> finished (certificateUrl / receiptNumber, or transactionDocumentUrl for invoice payment). "cancelled" = payment link expired/declined: call refresh_business_name_payment_link, never re-lodge. "rejected" with errors["00133"] = name not available. |
| refresh_business_name_payment_linkA | Re-issue the ASIC card-payment link for a business-name application whose status is "cancelled" (link expired, cancelled or card declined). Recovers the SAME application under the same requestId; fails if already paid/registered. Returns response.transactionPaymentUrl. |
| get_business_name_renewal_statusB | Status of a business-name renewal: new -> … -> finished with response {transactionDocumentUrl, businessNameNumber, renewalTo}. |
| get_asic_484_form_statusC | Status of a Form 484 lodgement: {response: {requestId, status, documentNumber, info: {companyName, acn}}, errors}. |
| start_entity_monitoringA | Start monitoring up to 25 companies (acn) and/or ABN holders (abn) for public-register changes, prepaid 12 months each. LIVE cost $18.00 per entity (card billing required); sandbox $0. Sources: ASIC, ABR, insolvency notices and PPSR (companies),
IP Australia trade marks, ASIC licence registers, ACNC. Changes arrive as monitoring.change_detected webhooks and through
list_monitoring_events. Read bapi://docs/entity-monitoring first.
entities: [{acn}, {abn}, {acn, abn}], each with an optional |
| list_monitored_entitiesA | List monitored entities (data[] of entity objects + meta {currentPage, perPage, total, lastPage}). Filters: status, acn, abn, expires_before (YYYY-MM-DD, for renewal runs). per_page max 100. Entity object: id, acn, abn, entityName, reference, status, monitoringStatus (pending|active|degraded|inactive), startsAt, expiresAt, daysRemaining, lastEventAt, entityStatus (registered|deregistered|cancelled|external_administration| strike_off_proposed|unknown), entityType, gstRegistered, gstDate, businessNames[]. |
| get_monitored_entityA | One monitored entity (see list_monitored_entities for the object). 404 not_found if it is not yours in this environment (ids are per account and per environment; a merged ABN entity's old id also returns 404 — re-read the list). |
| stop_entity_monitoringA | Stop monitoring an entity now. Webhooks stop immediately; the paid term keeps running (no refund) and the entity can be resumed free until it ends; stopped time is not added back. Safe to repeat. 409 order_processing while an order/renewal for it is still processing — retry in a few minutes. |
| resume_entity_monitoringA | Resume a stopped entity whose paid term is still running (free). Changes that happened while stopped are not sent. 422 not_resumable = term already ended -> renew_entity_monitoring instead; 422 acn_not_eligible / abn_not_active = the company was deregistered / ABN cancelled meanwhile. |
| renew_entity_monitoringA | 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. |
| get_entity_snapshotA | The entity's current record from every monitored source, as JSON (snake_case inside |
| list_monitoring_eventsA | List detected changes (summary form: monitoringEventId, entityId, eventType, title, detectedAt, simulated). Without entity_id: ALL your events, oldest first (GET /monitoring/events). |
| get_monitoring_eventB | One monitoring event in full: description, source (asic|abr|insolvency|ppsr|trademark|register), effectiveDate, metadata (field/oldValue/newValue; documentType/documentNumber for document_lodged; businessName; previousName; noticeUrl; tradeMark*; registerLabel/registerStatus/licenseeNumber/registerUrl; gstCancelled) and the entity object. |
| simulate_monitoring_eventA | 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). |
| get_company_name_change_statusC | Status of a name change: {requestId, status, documentNumber, response {companyName, acn, proposedName}, errors}. A request that failed local validation (never reached ASIC) returns only requestId, status and errors. |
| get_company_deregistration_statusC | Status of a deregistration: {response: {requestId, status, documentNumber, info {companyName, acn, companyType, companyClass, companySubClass, jurisdictionOfRegistration, dateOfDeregistration}}, errors}. |
| request_asic_account_transactionsA | Request ASIC Form RA52 — a report of all transactions on your registered-agent ASIC account for a period (invoices, fees, direct debits, late fees, payments). Dates YYYY-MM-DD, end_date ≤ today. Billed as a registered-agent form (no legal effect). Returns {response: {requestId, documentNumber}}; then get_asic_form_status(form="ra52") / wait_for_request(kind="asic_ra52") -> finished with response.records[] {date, legend (Table 0019, e.g. Invoice, Direct Debit, Late Fee), status (Table 0020, e.g. Outstanding, Fully Allocated), value / outstandingValue (signed cents as strings, "+49500" = $495.00), reference, acn}. |
| get_asic_form_statusB | Status of a Form 361 / 362 / RA52 lodgement: {response: {requestId, status, documentNumber, info {companyName, acn, type?}, records? (RA52)}, errors}. |
| list_webhooksA | List the webhook endpoints registered for THIS API key / environment (signing secrets are never returned). |
| create_webhookA | 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 |
| update_webhookA | Update a webhook endpoint's URL, event types and/or enabled flag (PATCH). Re-enabling (enabled=true) after an automatic disable (20 consecutive failures) resets its failure count. Give at least one field. |
| delete_webhookA | Remove a webhook endpoint. Deliveries stop immediately. Prefer update_webhook(enabled=false) to pause instead. |
| rotate_webhook_secretA | Invalidate the endpoint's current signing secret and issue a new one (returned ONCE). The receiver must accept both the old and new secret until the new one is deployed everywhere. |
| verify_webhook_signatureA | Verify a Business API webhook delivery LOCALLY (no network): recompute HMAC-SHA256 over "{t}.{raw_body}" with the endpoint's whsec_ secret and compare it to v1 from the X-Bapi-Signature header ("t=1785552011,v1=") in constant time. raw_body must be the exact bytes received (re-serialised JSON breaks the hash). Returns {valid, reason, ageSeconds}. Use it to debug a receiver; in production implement the same check in the receiver itself. |
| create_ppsr_searchA | Create a PPSR (Personal Property Securities Register) search. LIVE cost: $6.00 per search. Provide exactly ONE identifier set:
Returns {requestId, status: "new"}. Then poll get_ppsr_search(request_id) until status is "completed" or "failed". |
| get_ppsr_searchA | Get the status / results of a PPSR search created with create_ppsr_search.
status: new -> processing -> completed | failed. Results are under |
| get_request_statusA | Poll any lodgement (company / ABN / tax / business-name registration, ASIC forms, deregistration…) by requestId. Lifecycle: new -> transmission ok -> validation ok | validation failed -> manual review -> finished | rejected.
On 'validation failed' / 'rejected' read errors[] ({details, target}); on 'manual review' read warnings;
on 'finished' the result (e.g. acn, abn, dateOfRegistration, documentNumber) is in |
| wait_for_requestA | Poll a request until it reaches a terminal (or action-needed) state, then return that status response. kind: "lodgement" -> GET /status/{id} (company registration, ABN); "ppsr" -> GET /ppsr/searches/{id}; "business_name" / "business_name_renewal" / "asic_484" / "company_name_change" / "company_deregistration" / "asic_361" / "asic_362" / "asic_ra52" -> that endpoint's own /{id}/status path. Stops on: finished, rejected, validation failed, completed, failed, cancelled, "wating ASIC CC payment" (business name needs the payer to open the link), or any HTTP error. timeout_seconds max 600. Returns the last status plus {"timedOut": bool, "polls": n}. Registrations in the sandbox usually finish in seconds to a few minutes; live ASIC/ATO processing can take longer — prefer webhooks for production. |
| get_account_statusA | Account / plan state for the current API key: accountName, companyName, abn, createdAt, planId, planCreatedAt, planEndsAt and stats {abnLodgementForms, taxLodgementForms, acnLodgementsForms, acnRegisteredAgentForms, bnLodgementsForms, bnRenewLodgementsForms, bapiHelpers} (usage counters). Use it to explain 403s and plan limits. |
| call_endpointA | Call any Business API v2 endpoint that has no dedicated tool (ASIC forms, entity monitoring, webhooks, staged ABN data…). path is RELATIVE to the v2 root, e.g. "/asic-484-forms", "/monitoring/entities/123", "/helpers/entitlement-questionnaire". Never include /api/v2 or /api/test/v2 — the server adds the right prefix for its environment. Find paths in resource bapi://docs/endpoints; field schemas are on https://businessapi.com.au/developers/api/. POST = lodge (returns requestId; follow with get_request_status). Live writes are blocked unless BAPI_ALLOW_LIVE=true. Prefer the typed lodge_* tools for company / ABN / business-name registrations: they validate before sending. |
| lodge_company_registrationA | Lodge ASIC Form 201 — register a new Australian company. LIVE cost ≈ $50 service fee + ASIC registration fee.
dry_run=true (default): validate locally (all "Mandatory IF" rules from the docs) and return the exact JSON that would be posted — show it and the fees to the user. dry_run=false: lodge; returns {requestId, status: "new", billing}. Then wait_for_request(requestId) -> 'finished' gives acn / registrationDate / documentNumber; certificate PDF at GET /company-registrations/{requestId}/certificate, document pack at …/documents.
|
| lodge_abn_registrationA | Apply for an Australian Business Number (ATO ABNREG). LIVE cost ≈ $25.
dry_run=true (default): validate and return the payload (the server adds testTransmissionIndicator from its env). dry_run=false: lodge -> {requestId, status: "received", billing: {price_cents, charged_cents}}; a duplicate in-progress application returns the existing requestId with a warning. Then wait_for_request(requestId) -> 'finished' gives info.abn. HTTP 400 = field errors keyed by path, nothing charged.
|
| lodge_business_name_registrationA | Register a business (trading) name with ASIC (BNREG). LIVE cost ≈ $15 service fee + ASIC fee (1 or 3 years).
dry_run=true (default): validate and return the payload. dry_run=false: lodge -> {requestId, status: "new"}. Then get_business_name_registration_status / wait_for_request(kind="business_name").
|
| lodge_business_name_renewalA | Renew an existing business name with ASIC (BNRENEW) for 1 or 3 years. LIVE cost ≈ $15 service fee + ASIC renewal fee. request: generalInformation {businessName exactly as registered, abn of the holder, term 1|3, email} and applicant {individual {familyName, givenNames}, declaresTrueAndCorrectIndicator true}. Check the current record first with lookup_abn (businessNames) if unsure of the exact name. dry_run=true (default) validates and returns the payload; dry_run=false lodges -> {requestId, status: "new"}. Then get_business_name_renewal_status / wait_for_request(kind="business_name_renewal") -> 'finished' gives response.businessNameNumber, renewalTo and transactionDocumentUrl.
|
| lodge_asic_484_formA | Lodge ASIC Form 484 — Changes to Company Details — for a company managed under your registered-agent account. One form can combine any of: registeredOffice / principalPlaceOfBusiness address change, officeHolders (appointments, cessations, name/address changes), shareIssue or shareCancellation (both need shareStructure + members), ultimateHoldingCompany, concessionalFees, annexures. Always needs generalInformation {companyName, acn} and signature {name, role DIR|SEC|ALT, date within the last 6 months, declaresTrueAndCorrectIndicator true}. Read bapi://docs/asic-484-forms first for the status / holdingStatus / cancellationProvision codes and the V455 share-totals rule (checked locally). The server upper-cases all string values (ASIC requirement). ASIC charges late fees when a change is notified more than 28 days after it took effect. Billed as a registered-agent form (Pro plan includes 2,500 forms/month). dry_run=true (default) validates and returns the payload; dry_run=false lodges -> {response: {requestId, documentNumber, documentUrl}}. Then get_asic_484_form_status / wait_for_request(kind="asic_484").
|
| lodge_company_name_changeA | Lodge ASIC Form 205A — change a registered company's name. LIVE: service fee + ASIC fee (paymentMethod DDEB or INV). Before lodging: check_company_name_availability(proposedName).
|
| lodge_company_deregistrationA | Lodge ASIC Form 6010 — VOLUNTARY DEREGISTRATION of a company (irreversible once ASIC deregisters). LIVE: service fee + ASIC fee. All six s.601AA declarations must be true (members agree, not trading, assets < $1,000, fees paid, no liabilities, no legal
proceedings) — the validator refuses otherwise.
|
| lodge_asic_361_formA | Lodge ASIC Form 361 — YOUR registered-agent account ceases to act for a company (agent-initiated). request = generalInformation {companyName, acn}, signature {name, role AGT, date, agentAuthorisedIndicator true, declaration true}. Billed as a registered-agent form. dry_run=true (default) returns the payload; dry_run=false lodges -> {response: {requestId, documentNumber, documentUrl}}. Then get_asic_form_status(form="361") / wait_for_request(kind="asic_361").
|
| lodge_asic_362_formA | Lodge ASIC Form 362 — a company appoints (type A) or ceases (type C) your registered agent number (company-initiated). Appointing links the company to your agent account, which the other ASIC form tools (484, 205A, 6010 …) need. request = generalInformation {companyName, acn, type A|C}, signature {name, role DIR|SEC, date, declaration true}. dry_run=true (default) returns the payload; dry_run=false lodges -> {response: {requestId, documentNumber, documentUrl}}. Then get_asic_form_status(form="362") / wait_for_request(kind="asic_362").
|
| get_request_schemaA | Return the JSON Schema (with $defs) for a lodge_* tool's 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}. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| lodgement_workflow | Step-by-step plan for running a lodgement end-to-end through Business API. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| Business API overview | Auth, environments, response envelope, lodgement lifecycle, pricing, webhooks. |
| Business API endpoint catalogue | Every v2 endpoint grouped by collection, with method, path, docs link and which tool covers it. |
| Company registration (Form 201) guide | Workflow, typical Pty Ltd values and the rules lodge_company_registration enforces. |
| ABN registration guide | Entity types, workflow and the ATO/vendor rules lodge_abn_registration enforces. |
| Business name registration guide | Holder types, payment flow (card link / invoice), cancelled-link recovery, name test guidance. |
| PPSR search field reference | Request-body fields and result shape for /ppsr/searches. |
| ASIC Form 484 guide | Change sections, status/holding codes, V455 share-totals rule and responses for Form 484. |
| Entity monitoring guide | What is monitored, lifecycle, idempotency/charging, limits, error codes, sandbox simulation. |
| Name change, deregistration and agent forms guide | Form 205A, 6010, 361, 362, RA52 shapes, statuses, code tables, and which endpoints have no public docs. |
| Webhooks guide | Endpoint management, event table, delivery payload, signature verification, retries. |
| ASIC code tables | Company type/class/sub-class codes and valid combinations, jurisdictions, legal elements, roles. |
| ATO code tables | ABN entity types/sub-types, application reasons, associate position codes per sub-type, GST/PAYG/LCT codes. |
TDQS
Scored across 46 tools
Most tools target distinct resources/actions, but `call_endpoint` overlaps with every dedicated tool, and `get_request_status` / `wait_for_request` overlap with the many form-specific status getters. The descriptions clarify boundaries, but an agent still has multiple plausible choices for checking or calling the same lifecycle.
Tool names consistently use snake_case verb_resource patterns such as `lodge_company_registration`, `get_webhook` variants, and `create_ppsr_search`. Numeric form names like `lodge_asic_484_form` are still predictable and aligned with the domain.
46 tools is heavy for an agent-facing surface, especially with many form-specific lodge/status pairs that could be consolidated behind form parameters. The domain is broad, but the count exceeds a well-scoped set and increases selection burden.
The surface covers lookups, registrations, ASIC forms, PPSR searches, entity monitoring, webhooks, account status, schemas, and a generic endpoint fallback. Lifecycle coverage is strong, with lodgement, status polling, waiting, and webhook alternatives all represented.