Skip to main content

MCP Server Tools

Every tool available to Bigfoot in the client portal is also available through the custom connector.

The Northwest MCP server exposes account capabilities as tools. Your AI client chooses tools, Northwest executes them against your live account, and the client answers in plain language. This page covers all 131 tools, grouped by task.

New to the connector? Start with get_account_summary_tool and get_action_items_tool. To set up your AI client, see Connect.

How to read this catalog

  • Tool name is the identifier your MCP client lists. Some clients show account tools with a v2_client__ prefix, such as v2_client__get_invoices_tool; this page leaves that prefix off. You don’t have to type tool names. Ask in plain language.
  • Each group starts with a table of its tools and a sample prompt for each. Select a tool name for its full entry. Sample prompts are starting points; the client may call more than one tool to finish a job.
  • Access says what a tool can do. Read-only tools never change anything. Tools that add to your cart never charge you; only checkout and the tools marked as charging a saved payment method do.
  • Who can run it, Confirmation, Interface, and Where it works appear when a tool is limited to the company owner, waits for your approval in chat, opens an in-chat app so card data and passwords never go through the model as raw text, or depends on the portal page you have open.
  • ⚠️ marks a tool that deletes or cancels something, or makes a change you can’t undo.
  • Parameters are filled in by your AI client from the conversation and earlier tool results. Internal IDs for companies, services, products, and payment methods stay behind the scenes.

Tool groups

Account & companies

Look up your account, companies, and company profile, see what still needs your attention, and add companies to your account.

Tool What it does Sample prompt
get_account_summary_tool Summarize the account, its services, recent orders, and invoices. Give me a snapshot of my account.
get_companies_tool List the companies on your account. Which companies are on my account?
get_company_details_tool Show a company’s entity type, home state, officials, and key dates. Show me the details for my Wyoming LLC.
get_company_ein_tool Look up a company’s EIN, or the status of a pending EIN filing. What is the EIN for my LLC?
get_company_state_status_tool Show the state registration status on record for a company. Is my Texas LLC still active with the state?
get_action_items_tool List tasks that still need your attention. What do I still need to finish?
get_account_shipping_address_tool Show the shipping address on file for physical orders. What shipping address do you have for me?
get_site_contact_information_tool Show support contact details for your brand. How do I contact support?
company_entity_catalog_tool List entity types and the name suffixes a state allows. What suffixes can a Wyoming LLC use?
create_company_tool Add a company to your account. Add a new company for a Texas LLC.
update_company_details_tool Update profile fields such as addresses, officials, or NAICS code. Update my LLC’s principal address to 123 Main St, Spokane, WA 99201.

get_account_summary_tool

Access: Read-only

Returns a snapshot of the signed-in account, including account information, active subscriptions, active services, recent orders, and recent invoices.

Parameters: None.

Key features

  • Combines account, subscription, service, order, and invoice activity in one call.

Use cases

  • Get oriented at the start of a conversation before you drill into one company or service.
  • Review recent orders and invoices without opening several portal pages.

get_companies_tool

Access: Read-only

Lists the companies on your account with a total count. Most other tools need a company, so your client usually calls this one first.

Best practices

  • If you have more than one company, name the one you mean. Your client asks rather than guessing.

Parameters

Parameter Required Description
name Optional Case-insensitive partial match on the company name.
page Optional Pagination object with number (zero-indexed, default 0) and size (1 to 100, default 10).

Key features

  • Returns the total number of companies so your client knows when to fetch another page.

Limitations

  • Company IDs are used behind the scenes and are never shown to you.

Use cases

  • See every business on your account.
  • Match “my Wyoming LLC” or a partial name to the right company before another tool runs.

get_company_details_tool

Access: Read-only

Returns a company’s identity and structure: legal name, entity type, home state, state entity number, management type and member structure, officials (members, managers, directors, and officers), formation date, NAICS code, issued shares for corporations, customer-since date, the states where Northwest serves as registered agent or handles compliance, and counts of other active services.

Parameters

Parameter Required Description
company_id Required The company to look up.
include_mailing_address Optional Set to true to include the company mailing address on file. Default: false.

Key features

  • Returns a fixed set of profile fields, never the full internal company record.

Limitations

  • The mailing address appears only when requested. Leaving it out doesn’t mean no address is on file.
  • The company mailing address is often a registered agent address, so it’s never used for shipping. See get_account_shipping_address_tool.
  • For the EIN, use get_company_ein_tool.

Use cases

  • Answer “Who are the members of my LLC?” or “What’s my state entity number?”
  • Confirm the home state before you start an amendment.

get_company_ein_tool

Access: Read-only

Returns the EIN (federal tax ID) on file for a company. If no EIN is on file but an EIN filing is in progress, it reports a pending status with a summary of that filing.

Parameters

Parameter Required Description
company_id Required The company to look up.

Key features

  • Reports one of three outcomes: EIN on file, pending with filing status, or not found.

Limitations

  • Reads the company’s federal registration only. It doesn’t search documents or filing orders.

Use cases

  • Retrieve your EIN for a bank application or tax form.
  • Check whether an EIN filing you ordered has finished.

get_company_state_status_tool

Access: Read-only

Returns the state registration status on record for a company, by jurisdiction, from records refreshed within the last month.

Parameters

Parameter Required Description
company_id Required The company to check.

Limitations

  • This isn’t a live Secretary of State lookup. Registrations that haven’t been refreshed in the last month are left out, and federal (EIN) registrations aren’t included.
  • Statuses are quoted as recorded, not interpreted. When there’s no recent verified status, none is reported.

Use cases

  • Confirm a company shows as active before you order a filing.
  • Check on a company you think was dissolved or closed.

get_action_items_tool

Access: Read-only

Returns the open action items on your account or one company: orders to verify or complete, services waiting on your input, unpaid invoices, unread documents and service of process, documents you started but haven’t finished, address corrections, setup steps, and two-factor authentication.

Parameters

Parameter Required Description
company_id Optional Limit results to one company. Omit to cover the whole account.

Key features

  • Returns only items that still need you. Completed checks are left out.
  • Each item points to where you finish it, and many can be completed with help in the same chat, such as paying an invoice or filling out an order form.

Limitations

  • Two-factor authentication is listed as a recommended security step. Passwords and codes are never collected in chat.

Use cases

  • Start a session with a to-do list across all of your companies.
  • Confirm nothing is outstanding after you finish a task.

get_account_shipping_address_tool

Access: Read-only

Returns the shipping destination on file for the account owner: the shipping (mailing) address if one is set, otherwise the primary address.

Best practices

  • Confirm the returned address before you order something that ships, such as a corporate seal or GoBook.

Parameters: None.

Key features

  • Reports which address it used, shipping or primary, or that none is on file.

Limitations

  • Never uses a company mailing address, which is often a registered agent address.

Use cases

  • Check where a physical product will ship before you order it.

get_site_contact_information_tool

Access: Read-only

Returns support contact information for your brand’s website: the brand name, primary address, billing phone number, and billing or support email.

Parameters: None.

Key features

  • Detects the right site from your account, so you never need to say which brand you use.

Use cases

  • Find the phone number or email address for support.

company_entity_catalog_tool

Access: Read-only

Lists the entity types you can choose when adding a company, and the legal name suffixes (such as LLC or L.L.C.) a state allows for a given entity type.

Parameters

Parameter Required Description
operation Required entity_types lists selectable entity types. entity_suffixes lists allowed suffixes.
entity_type Required for entity_suffixes Entity type name, abbreviation, or ID.
state Required for entity_suffixes Home state name or abbreviation.

Key features

  • Entity types are tiered as common or extended, so the most popular options are shown first.

Limitations

  • Suffix lists are state-specific. An empty list means none is configured, and the full legal name is used as you give it.

Use cases

  • Explore entity types beyond LLC and corporation.
  • Pick a valid suffix before you create a company.

create_company_tool

Access: Write
Confirmation: Runs only after you approve it in chat

Adds a company to your account with a domestic registration in the state you choose. Use it to add an existing business to your account, or as the first step in legally forming a new one.

Best practices

  • Your client asks whether you’re adding an existing business or forming a new one, collects the state, entity type, name, and suffix one at a time, and confirms the details before creating the company.
  • To file with the state after creating a new company, continue with list_formation_filing_options_tool and add_formation_to_cart_tool.

Parameters

Parameter Required Description
company_name Required Base legal name without the suffix when entity_suffix is used. Otherwise, the full legal name.
entity_type Required Entity type name, abbreviation, alias (such as llc, corp, or nonprofit), or ID.
state Required Home state name or two-letter abbreviation.
entity_suffix Optional Required when the state lists allowed suffixes for the entity type. Must match one of them.

Limitations

  • Creating a company record doesn’t file anything with the state. Formation is a separate purchase.

Use cases

  • Add a business you formed elsewhere so you can manage it in your account.
  • Start a new LLC or corporation, then add Business Formation Service.

update_company_details_tool

Access: Write

Updates specific fields on the company profile in your account. Every entity type can update its NAICS code and principal and mailing addresses. LLCs can also update management type, members, managers, and shareholders. Corporations can also update the president, secretary, treasurer, directors, and issued shares.

Best practices

  • Your client reads the current details first and sends complete addresses and complete lists of officials, not partial changes.
  • Find a NAICS code with search_naics_codes_tool and confirm it before saving.

Parameters

Parameter Required Description
company_id Required The company to update.
fields Optional List of {name, value} pairs using allowed field names, such as naics_code, company_principal_address, official.member, or official.director.
naics_code Optional Shortcut for saving a single six-digit NAICS code.

Limitations

  • Changes the profile in your Northwest account only. It doesn’t change the state record. An official change requires an amendment filing.
  • Fields outside the allowed list, and roles that don’t match the entity type, can’t be written.
  • When a filing or service form is open in the portal, the form tools are used for that form instead.

Use cases

  • Record a new principal address or manager on your profile.
  • Save the NAICS code for your business.

Filings, orders & compliance

Track state filings and annual reports, find orders that need you, and look up filing options and NAICS codes.

Tool What it does Sample prompt
get_filing_statuses_tool Track formation, annual report, and amendment filings. What is the status of my articles of organization?
get_annual_reports_tool See annual report due dates, status, and autopay. When is my annual report due?
get_oi_req_attention List orders waiting for you to verify or complete them. Which of my orders need my attention?
open_order_item_requiring_attention_tool Open an order that needs you in the portal. Open my Alaska formation order so I can finish it.
get_order_details_tool Show what’s left on an order awaiting verification or input. What’s left to do on my formation order?
list_formation_filing_options_tool Compare standard and expedited formation options and prices. How much is it to form my Idaho LLC, and is expedited available?
list_amendment_filing_options_tool List amendment filing options and fees for a state. How much does it cost to amend my LLC’s name in Wyoming?
list_ein_filing_options_tool List EIN filing options and prices. What are my options for getting an EIN?
search_naics_codes_tool Find NAICS codes by keyword or number. What NAICS code should I use for a coffee shop?

get_filing_statuses_tool

Access: Read-only

Returns the status of state filing orders for a company, such as formations, annual reports, and amendments, newest activity first. Each row shows the product, status, jurisdiction, company, last update, and estimated completion date when one is set.

Parameters

Parameter Required Description
company_id Optional The company whose filings to list. Required unless order_item_id is provided.
order_item_id Optional Return a single filing order.
limit Optional Number of filings to return. Default: 25. Max: 50.

Key features

  • Reports how many filings match in total and whether more exist than were returned.

Limitations

  • Summary only. It doesn’t include intake questions or missing fields. For annual report due dates, use get_annual_reports_tool.
  • Estimated completion dates are estimates, not guarantees, and can move.

Use cases

  • Check whether your articles of organization have been filed.
  • Get an estimated completion date for a filing in progress.

get_annual_reports_tool

Access: Read-only

Returns annual report and other compliance events for a company, with due dates, filing descriptions, jurisdiction, completion status, and whether autopay is on for each renewal.

Parameters

Parameter Required Description
company_id Required The company to check.
upcoming_only Optional Return only reports due today or later. Default: false.
limit Optional Number of events to return. Default: 25. Max: 100.

Key features

  • Flags filings that are late.

Use cases

  • Find out when your next annual report is due.
  • Confirm autopay is on for an upcoming renewal.

get_oi_req_attention

Access: Read-only

Lists the filing orders that need your action across the companies you own: orders waiting for you to verify them, and orders waiting on your input.

Best practices

Parameters

Parameter Required Description
company_id Optional Limit results to one company. Omit to cover every company you own.

Key features

  • Returns the same list as the portal’s orders requiring attention view.

Limitations

Use cases

  • See every order that’s waiting on you before it can go to the state.

open_order_item_requiring_attention_tool

Access: Navigation (opens a page in the client portal)
Where it works: Bigfoot (client portal)

Opens a specific order that needs your attention in the client portal and takes you to the right form: Verify Order for orders awaiting verification, or the order requiring attention form for orders waiting on your input.

Parameters

Parameter Required Description
order_item_id Required The order to open, from get_oi_req_attention.
current_page Required The portal page you’re on. Bigfoot supplies it automatically.

Use cases

  • Jump from the list of orders waiting on you to the form you need to finish.

get_order_details_tool

Access: Read-only

Returns the details of an order that needs verification or your input, including the company, a snapshot of the form data, fields still needing input, completion notes, and the estimated completion date.

Parameters

Parameter Required Description
order_item_id Optional The order to look up.
company_id Optional Load the latest order awaiting verification for this company.

Key features

  • With no parameters, it finds your newest order awaiting verification, the same one the Verify Order page opens.
  • Completion notes explain what’s left, including any unpaid invoice tied to the order.

Limitations

  • Field-by-field help is available only while that order’s form is open in the portal.
  • An empty list of missing fields doesn’t mean the order is finished. You still need to review, save, and submit it.

Use cases

  • Find out what’s left before a formation can be filed.
  • Get the estimated completion date for an order you’re verifying.

list_formation_filing_options_tool

Access: Read-only

Lists the formation filing options for a company’s home state, such as standard and expedited processing, with the price of each.

Parameters

Parameter Required Description
company_id Required The company being formed. It must already have a home state.

Key features

  • Indicates when you need to choose between standard and expedited before anything goes in the cart.

Limitations

  • Option prices cover the formation package and state filing fee, not the full cart total. Other items, including free or trial items, may also appear in your cart.

Use cases

  • Compare standard and expedited filing before you form a company.

list_amendment_filing_options_tool

Access: Read-only

Lists amendment filing options and fees for a company in the state you choose, for changes such as a name, members or managers, an address, or the business purpose on the state record.

Best practices

  • Your client can suggest the company’s home state, but waits for you to choose where to amend.

Parameters

Parameter Required Description
company_id Required The company to amend.
jurisdiction Required The state you chose, by name or abbreviation.

Limitations

  • The company doesn’t need an existing formation or registration in that state.

Use cases

  • Price a name-change amendment before you commit.

list_ein_filing_options_tool

Access: Read-only

Lists the EIN (federal tax ID) filing options for a company, so you can choose one when more than one is available.

Parameters

Parameter Required Description
company_id Required The company the EIN is for.
responsible_party_has_ssn Required true if the responsible party has an SSN or ITIN, false if not.

Limitations

  • You’re only asked whether the responsible party has an SSN or ITIN. The number itself is never collected in chat.

Use cases

  • See EIN filing options and prices before you order.

search_naics_codes_tool

Access: Read-only

Looks up NAICS industry codes by keyword or by digits. Use it on its own, or to find the code a filing or your company profile needs.

Parameters

Parameter Required Description
mode Optional code searches full six-digit NAICS codes. industry lists the top-level industry sectors. Default: code.
query Optional A keyword such as “coffee shop”, or digits (a full code or a prefix). Optional in industry mode.

Key features

  • Ranks results by best match and handles word order and singular or plural forms.

Limitations

  • Only codes returned by the search are used. Codes are never made up.

Use cases

  • Find the NAICS code for your type of business.
  • Pick the right code for a filing or your company profile.

Filing & service forms

Get help finishing a filing or service form while it’s open in the client portal. These tools use the page you have open, so they work in Bigfoot. They never fill in Social Security numbers, dates, or signatures. You complete those fields on the form.

Tool What it does Sample prompt
get_filing_field_help_tool Explain the fields on an open filing form. What should I put for business purpose on this form?
apply_filing_field_suggestions_tool Save values you confirm to an open filing form. Add Jane Smith as a second member with the same address as me.
save_or_submit_filing_form_tool Save, submit, or continue an open filing form. Save this form for now.
update_company_name_tool Change the business name on an in-progress formation. Rename my company to Cedar & Pine LLC.
get_service_field_help_tool Explain the fields on an open service form. What does this field on my service form mean?
apply_service_field_suggestions_tool Save values you confirm to an open service form. Add John Lee as a member on this form.
save_or_submit_service_form_tool Save, submit, or continue an open service form. Submit this form.

get_filing_field_help_tool

Access: Read-only
Where it works: Bigfoot, while the form is open in the client portal

Returns official help text, labels, options, and current requirements for the fields on a filing form, including which fields are required right now and where each field sits on a multi-step form.

Parameters

Parameter Required Description
order_item_id Required The filing order whose form is open.
field_name Optional Narrow results to fields whose name or path contains this text. Separate several terms with commas.

Key features

  • Official help text is quoted as written, not paraphrased.
  • Identifies read-only fields, so you’re never offered changes that can’t be saved.

Use cases

  • Ask what “management type” means on your formation form.
  • Find out which fields are still required on the step you’re on.

apply_filing_field_suggestions_tool

Access: Write
Confirmation: Runs only after you approve it in chat
Where it works: Bigfoot, while the form is open in the client portal

Saves values you’ve confirmed to an in-progress filing form, such as a business purpose, member names and addresses, a NAICS code, or an industry. The form refreshes automatically after the save.

Best practices

  • Your client explains what’s missing, suggests values, and saves only after you confirm them.
  • For NAICS code or industry fields, search_naics_codes_tool finds the code first.

Parameters

Parameter Required Description
order_item_id Required The filing order whose form is open.
fields Required List of {qualified_name, value} pairs, using the field paths from get_filing_field_help_tool.
append_official_rows Optional Role keys, such as official.member, that should get a new row instead of updating the first one.

Key features

  • Saves members and officials as individuals or as companies, and can apply the “Use our address. Keep yours private.” option to an official’s address.

Limitations

  • Never writes Social Security numbers, date fields, or the responsible party signature. You enter those on the form.
  • Read-only fields can’t be changed. On multi-step forms, choosing a principal or mailing address option happens on the form itself.

Use cases

  • Add a second member to your LLC formation.
  • Save a tailored business purpose you drafted in chat.

save_or_submit_filing_form_tool

Access: Write
Where it works: Bigfoot (client portal)

Saves, submits, or continues a filing form by pressing the form’s own Save or primary button, so all of the portal’s validation and checkout steps still run.

Parameters

Parameter Required Description
order_item_id Required The filing order whose form to act on.
action Required save for a draft save, or submit or continue for the form’s primary action.

Key features

  • If the form isn’t open, the portal navigates to it first.

Limitations

  • A successful result means the action was attempted, not that the form passed validation. Check the page for errors.

Use cases

  • Save your progress on a long formation form.

update_company_name_tool

Access: Write
Confirmation: Runs only after you approve it in chat
Where it works: Bigfoot, while the formation is open on the Verify Order page

Changes the business name or entity suffix on an in-progress formation. Because this changes the legal name across the filing, it runs only after you confirm the exact wording.

Parameters

Parameter Required Description
order_item_id Required The formation order open on Verify Order.
name Optional The distinctive name without the suffix, such as “Acme Widgets”. Omit to keep the current name.
entity_suffix Optional A suffix the entity type allows in that state, such as “LLC”. Omit to keep the current suffix.

Limitations

  • Works only while the formation can still be edited, before it’s processed or sent to the state.
  • Used on multi-step Verify Order forms. On single-page forms, the name field is saved with apply_filing_field_suggestions_tool.

Use cases

  • Fix a typo in your company name before the formation is filed.

get_service_field_help_tool

Access: Read-only
Where it works: Bigfoot, while the form is open in the client portal

Returns official labels, help text, options, current values, and conditional requirements for a service form that needs your input.

Parameters

Parameter Required Description
service_id Required The service whose form is open.
field_name Optional A field name, title, or path fragment to narrow results.

Limitations

  • Hidden and disabled fields are shown for context but can’t be written.

Use cases

  • Understand what a service intake form is asking for.

apply_service_field_suggestions_tool

Access: Write
Confirmation: Runs only after you approve it in chat
Where it works: Bigfoot, while the form is open in the client portal

Saves values you’ve confirmed to a service form that needs your input.

Parameters

Parameter Required Description
service_id Required The service whose form is open.
fields Required List of {qualified_name, value} pairs from get_service_field_help_tool. Add edit_row_index (zero-based) to edit an existing row in a repeatable section.

Key features

  • In repeatable sections such as Members, a new row is added by default. An existing row changes only when you ask to edit it.

Limitations

  • Saves values only. It doesn’t submit the form. It never writes Social Security numbers, dates, or signatures.

Use cases

  • Fill in member details on a service intake form.

save_or_submit_service_form_tool

Access: Write
Where it works: Bigfoot (client portal)

Saves, submits, or continues a service form by pressing the form’s own Save or primary button, keeping the portal’s validation and address review intact.

Parameters

Parameter Required Description
service_id Required The service whose form to act on.
action Required save, submit, or continue.

Limitations

Use cases

  • Submit a service form you’ve finished.

Documents

Find, read, and unlock documents in your portal, and request physical copies.

Tool What it does Sample prompt
get_documents_tool List documents in your portal, newest first. Show me the documents for my LLC.
get_document_details_tool Explain why a document is locked and how to unlock it. Why is this document locked?
get_document_content_tool Read the text of an unlocked document. What does the latest letter for my LLC say?
create_document_unlock_invoice_tool Create an invoice for a one-time document unlock. Unlock this document for the one-time fee.
get_document_request_options_tool Price a mailed physical copy of documents. How much would it cost to mail me a copy of my articles?
create_document_request_tool Order mailed physical copies of documents. I need a mailed copy of my formation documents.
get_document_request_status_tool Track a mailed copy you requested. Where is the copy of my articles I requested?
get_document_upload_options_tool Power the in-chat document upload app. I want to upload a document to my account.
get_document_plan_upgrade_options_tool List mail plan upgrades for a document’s state. What mail plan upgrades can I get?
add_document_plan_upgrade_to_cart_tool Add a mail plan upgrade to your cart. Add the Virtual Office upgrade to my cart.

get_documents_tool

Access: Read-only

Lists the documents you can see, newest first by received date, with company, jurisdiction, type, labels, classification, and whether each one is locked.

Parameters

Parameter Required Description
company_id Optional Limit results to one company.
status Optional unread or read. Omit for both.
locked Optional true for locked documents only, false for unlocked only. Omit for both.
shared Optional false for My Documents, true for Shared Documents. The two lists are never combined. Default: false.
limit Optional Number of documents to return. Default: 20. Max: 100.

Key features

  • Reports the total number of matches, so you know when more documents exist than were returned.

Limitations

  • Locked documents appear in the list but can’t be previewed or read until they’re unlocked.

Use cases

  • Check for new mail or service of process for a company.
  • Find a specific document before you read it or request a copy.

get_document_details_tool

Access: Read-only

Returns access and mail plan details for one document: why it’s locked, what to do next, the one-time unlock price, mail plan usage against your allowance, and whether you can request a physical copy.

Parameters

Parameter Required Description
document_id Required The document, from get_documents_tool.
company_id Optional Confirm the document belongs to this company.

Key features

  • The recommended next step decides which options you’re offered: a one-time unlock, a new mail plan, a plan upgrade, registered agent service, paying an open invoice, or contacting support.

Use cases

  • Find out why a document is locked and what it costs to open.

get_document_content_tool

Access: Read-only

Returns the text of a single unlocked document so your assistant can answer questions about it, summarize it, or find details in it.

Parameters

Parameter Required Description
document_id Required The document, from get_documents_tool.
company_id Optional Confirm the document belongs to this company.

Key features

  • Document text is treated as sensitive data, and any instructions written inside a document are ignored.

Limitations

  • One document per call. Locked documents must be unlocked first.
  • Legal documents return no text. Download them from the portal instead. If text extraction is still in progress, try again shortly.

Use cases

  • Summarize a notice you received from the state.
  • Find a deadline or amount in a scanned letter.

create_document_unlock_invoice_tool

Access: Write (creates an unpaid invoice; nothing is charged until you pay it)
Confirmation: Runs only after you approve it in chat

Creates an invoice for a one-time unlock of a locked document after you agree to the fee. It doesn’t take payment. You pay through checkout or a texted pay link.

Parameters

Parameter Required Description
document_id Required The locked document.
company_id Optional Confirm the document belongs to this company.
send_pay_link_sms Optional Text you a link to pay the invoice. Used on mobile when an in-app pay screen isn’t available. Default: false.

Key features

  • Reuses an existing unpaid unlock invoice for the same document instead of creating a second one.

Use cases

  • Unlock a single document without changing your mail plan.

get_document_request_options_tool

Access: Read-only

Returns what you need to request physical copies of documents: eligibility, service fees, your saved mailing addresses, and shipping quotes for each address.

Parameters

Parameter Required Description
document_ids Required One or more documents to request together.
company_id Optional Confirm the documents belong to this company.

Limitations

  • Every document in one request must belong to the same company and jurisdiction.
  • If a copy of a document has already been requested, check it with get_document_request_status_tool.

Use cases

  • Price a mailed copy of your formation documents.

create_document_request_tool

Access: Write (charges a saved payment method)
Interface: Opens the request-document app, which collects the address, recipient, shipping, and payment

Submits a request for physical copies of documents and charges the payment method you select.

Parameters

Parameter Required Description
document_ids Required The documents to send.
mailing_address_id Required A saved mailing address from get_document_request_options_tool.
recipient Required company, personal, or both.
service_and_shipping Required The service and shipping option you selected.
payable_id Required The payment method you selected in the app.
company_id Optional Confirm the documents belong to this company.

Limitations

  • Address, shipping, and payment details are entered in the app, never in plain chat.

Use cases

  • Get a mailed copy of your formation documents for a bank.

get_document_request_status_tool

Access: Read-only

Returns delivery status and tracking for a physical copy request on one document.

Parameters

Parameter Required Description
document_id Required The document you requested.
company_id Optional Confirm the document belongs to this company.

Key features

  • Tells you plainly when no physical copy has been requested yet.

Use cases

  • Track a mailed copy you ordered.

get_document_upload_options_tool

Access: Read-only
Interface: Used by the upload-document app; it isn’t called directly from chat

Returns the document upload choices shown in the upload-document app.

Parameters: None.

Use cases

  • Upload a document to your account from the in-chat app.

get_document_plan_upgrade_options_tool

Access: Read-only

Lists the higher mail plan tiers you can upgrade to for an existing mail service in a document’s jurisdiction, such as scanning, forwarding, or Virtual Office plans, sorted by monthly price.

Parameters

Parameter Required Description
document_id Required The document that prompted the upgrade.
company_id Optional Confirm the document belongs to this company.

Key features

  • Shows each tier’s document upload limit when one is defined.

Limitations

Use cases

  • Compare plans when you keep going over your document allowance.

add_document_plan_upgrade_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a mail plan upgrade for an existing mail service to your cart after you choose a tier.

Parameters

Parameter Required Description
company_id Required The company that owns the mail service.
service_id Required The existing mail service.
product_id Required The plan you chose from get_document_plan_upgrade_options_tool.

Use cases

  • Upgrade to a plan with a higher document allowance.

Products, cart & checkout

Find products and filings, add them to your cart, and check out. Adding to your cart never charges you; only checkout does.

Tool What it does Sample prompt
discover_products_tool Search the catalog for a product by name or need. Do you sell certified copies?
get_products_tool Show full catalog details for a product or category. Show me the details on the GoBook.
select_product_tool Collect the choices a product needs before it goes in the cart. I want to order a business license for Spokane.
add_product_to_cart_tool Add a catalog product or filing to your cart. Add a DBA filing for my LLC to my cart.
add_formation_to_cart_tool Add a business formation filing to your cart. Add standard formation for Cedar & Pine LLC to my cart.
add_amendment_filing_to_cart_tool Add a state amendment filing to your cart. Add an amendment to change my LLC’s name in Wyoming.
add_ein_to_cart_tool Add an EIN filing to your cart. Get an EIN for my new LLC.
get_cart_items_tool Show what’s in your cart and the total. What is in my cart?
remove_from_cart_tool Remove an item from your cart. Remove the mail plan from my cart.
checkout_cart_tool Check out your cart with a saved payment method. Check out with my Visa ending in 4242.
checkout_cart_invoice_only_tool Place your order and get a texted pay link. Place my order and text me the pay link.

discover_products_tool

Access: Read-only

Searches the Hire Us catalog from a short phrase and returns up to 10 matching products with names, prices, and descriptions. It’s the starting point whenever you ask about something Northwest might sell.

Parameters

Parameter Required Description
query Required One to six topic words, as you typed them, such as “apostille” or “registered agent”.
company_id Optional The company you’re shopping for, when you have one company or have named it.
company_id_source Optional Where the company came from: sole_company, user_named, or page_context. Required when company_id is passed on an account with several companies.
conversation_context Optional shopping when you’re exploring or buying, informational when you’re asking what something is. Default: shopping.

Key features

  • Checks availability for the specific company, and acknowledges products you already have instead of pitching them.

Limitations

  • On accounts with several companies, your assistant asks which company before searching.

Use cases

  • Ask whether Northwest offers a product, filing, or form.

get_products_tool

Access: Read-only

Returns full Hire Us catalog cards for your website, for one product or for one category or bucket, including the states available for filings and whether you’re eligible for a free trial.

Parameters

Parameter Required Description
product_id Optional Return a single product card. Preferred when the product came from discover_products_tool.
category_id Optional List one Hire Us category.
bucket_id Optional List one Hire Us bucket.
company_id Optional The company you’re shopping for. Optional when you have exactly one company.
limit Optional Cap the number of cards when listing a category or bucket. Max: 100.
site_id Optional Your website. Defaults to your account’s site.

Limitations

  • Requires at least one of product_id, category_id, or bucket_id.
  • Lists only products that can be checked out through your assistant. Nothing is added to your cart.

Use cases

  • See the details and price of a product you found.

select_product_tool

Access: Read-only

Collects the choices a product needs before it can go in your cart, such as a state, county or city, filing method, plan, or form fields, and tells your assistant what to ask next. It never adds anything to your cart.

Parameters

Parameter Required Description
company_id Required The company that will own the product.
product_id Required The product you picked.
selections Optional Answers collected so far, keyed by field, such as jurisdiction, local_jurisdiction, filing_method_id, or a form field name.

Key features

  • Returns one of three statuses: needs input (ask you a question), handoff (use a product-specific add-to-cart tool), or ready (add to cart).
  • Offers only the states, cities, and filing methods that are actually available, and shows an itemized preview, including any required Registered Agent Service, before anything is added.

Limitations

  • Values already on file are suggested to you, never used silently. Shipping addresses are confirmed with you first.

Use cases

  • Order a DBA or business license that’s filed at the county or city level.

add_product_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a Hire Us product to your cart once select_product_tool reports it’s ready. For filings packaged with registered agent service, such as registering a company in another state or changing registered agents, Registered Agent Service and, when eligible, Renewal Service are added alongside.

Parameters

Parameter Required Description
company_id Required The company buying the product.
product_id Required The product to add.
data Optional The product’s configuration from select_product_tool.
filing_method_id Optional Required for filing products.
local_filing_method_id Optional The city or county filing method for business licenses.
include_registered_agent_service Optional Registered Agent Service is required with these filings and stays included. Default: true.

Limitations

  • Formation, EIN, mail, phone, hosting, registered agent, and domain purchases use their own add-to-cart tools.
  • Renewal filing service can’t be purchased twice for the same state.

Use cases

  • Add a DBA filing, corporate seal, or GoBook to your cart.

add_formation_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a business formation (state filing) to your cart for a company that’s already on your account with a home state, and returns an itemized summary right away.

Best practices

Parameters

Parameter Required Description
company_id Required The company to form.
filing_method_id Optional The option you chose. Required when both standard and expedited exist.
filing_speed Optional standard or expedited, used when no choice was required.
include_renewal_service Optional Set to false only if you opt out of Renewal Service. Default: true when eligible.

Key features

  • The summary lists every cart line, including free items such as a Free Initial Report where one applies.

Limitations

  • Payment happens in checkout, never in chat.

Use cases

  • Legally form the company you just added.

add_amendment_filing_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a state amendment filing to your cart for a company in the state you choose, for changes such as a name, members or managers, an address, or the business purpose on the state record.

Best practices

Parameters

Parameter Required Description
company_id Required The company to amend.
jurisdiction Required The state to amend in, by name or abbreviation.
filing_method_id Optional The option you chose. Defaults to the lowest-cost option.

Key features

  • You can add more than one amendment. A pending amendment doesn’t block a new one.

Limitations

  • This is a state filing, not a change to your company’s display name in the portal.

Use cases

  • File a name change after a rebrand.

add_ein_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds an EIN (federal tax ID) filing to your cart for a company.

Best practices

Parameters

Parameter Required Description
company_id Required The company the EIN is for.
responsible_party_has_ssn Required Whether the responsible party has an SSN or ITIN.
filing_method_id Optional The option you chose. Defaults to the lowest-cost option.

Limitations

  • Not added when the company already has an EIN on file or an EIN filing in progress.
  • The SSN or ITIN itself is never collected in chat.

Use cases

  • Order an EIN for a newly formed LLC.

get_cart_items_tool

Access: Read-only

Returns the items in a company’s cart and the authoritative cart total, with an itemized list that includes $0 items and any promo code discount.

Parameters

Parameter Required Description
company_id Required The company whose cart to show.

Key features

  • The total already reflects any promo code discount.
  • Shows which lines can be checked out through your assistant and which need to be completed in the portal cart.

Use cases

  • Review your cart and total before checkout.

remove_from_cart_tool

Access: Write
Confirmation: Runs only after you approve it in chat

Removes an item from your cart, then shows the updated cart.

Parameters

Parameter Required Description
item_id Required The cart item to remove.

Limitations

  • Runs only when you ask to remove a specific item.

Use cases

  • Remove something you added by mistake.

checkout_cart_tool

Access: Write (charges a saved payment method)
Confirmation: Runs only after you approve it in chat
Interface: Opens the cart checkout app, where you pick the payment method, in clients that support in-chat apps

Checks out everything in a company’s cart with a saved payment method.

Parameters

Parameter Required Description
company_id Required The company whose cart to check out.
expected_item_count Required The number of items your assistant expects in the cart.
payable_id Required The saved payment method to charge.
payable_type Required card or automatedClearingHouse (bank account).
card_cvv Optional Required when an item needs a CVV or the cart has more than one domain registration.

Key features

  • If the cart changed since it was last checked, checkout stops and shows you the current contents.

Limitations

  • Every line must be eligible for assistant checkout. Ineligible lines are named so you can remove them or finish in the portal cart.
  • Items that don’t accept bank accounts must be paid by card.

Use cases

  • Pay for a formation and registered agent service in one step.

checkout_cart_invoice_only_tool

Access: Write (places the order and creates an unpaid invoice)
Confirmation: Runs only after you approve it in chat

Places the order for everything in a company’s cart without taking payment. An unpaid invoice is created, and a link to pay it is texted to you. Used where an in-app checkout screen isn’t available.

Parameters

Parameter Required Description
company_id Required The company whose cart to order.
expected_item_count Required The item count from the latest cart check. The order is rejected if the cart changed.

Limitations

  • You aren’t charged until you pay the invoice from the texted link.
  • Every line must be eligible for assistant checkout.

Use cases

  • Place an order from your phone and pay from the text link.

Invoices & payments

Review invoices, pay bills, check refunds, and manage how you pay.

Tool What it does Sample prompt
get_invoices_tool List open and paid invoices. Do I have any unpaid invoices?
pay_invoice_tool Pay an invoice with a saved payment method. Pay invoice 104829 with my card on file.
send_invoice_pay_link_sms_tool Text yourself a link to pay an invoice. Text me a link to pay that invoice.
get_refund_status_tool Check the status of a refund. Where’s my refund for invoice 104829?
get_payment_methods_tool List the cards and bank accounts on file. What payment methods do I have saved?
get_add_payment_method_options_tool Check which payment method types you can add. Can I add a bank account as a payment method?
enable_autopay_tool Turn on autopay for a service. Turn on autopay for registered agent service.

get_invoices_tool

Access: Read-only

Lists invoices for the account, most recent first, with invoice number, company, description, status, amounts, and payment information.

Parameters

Parameter Required Description
unpaid_only Optional Return only unpaid invoices. Default: false.
paid_only Optional Return only paid invoices. Can’t be combined with unpaid_only. Default: false.
company_id Optional Limit results to one company.
invoice_id Optional Return a single invoice.
invoice_number Optional Return the invoice with this number.
limit Optional Number of invoices to return. Default: 25. Max: 100.

Key features

  • Your balance due is the total of your unpaid invoices.

Use cases

  • Check whether you owe anything.

pay_invoice_tool

Access: Write (charges a saved payment method)
Confirmation: Runs only after you approve it in chat
Interface: Opens the checkout app, where you pick the payment method, in clients that support in-chat apps

Pays one unpaid invoice with a saved payment method and returns a confirmation number.

Best practices

  • Your client lists your unpaid invoices first and asks which one to pay when there’s more than one.

Parameters

Parameter Required Description
invoice_id Required The unpaid invoice to pay.
payable_id Required The saved payment method to use.
payable_type Required card or automatedClearingHouse.
card_cvv Optional Required when the invoice needs a CVV.

Limitations

  • Requires a saved payment method. Card details are never collected in chat.
  • Invoices that don’t accept bank accounts, or that need a CVV, must be paid by card.

Use cases

  • Pay an outstanding registered agent invoice.

Access: Write

Texts you a link to pay an existing unpaid invoice. Used where an in-app pay screen isn’t available.

Parameters

Parameter Required Description
invoice_id Required The unpaid invoice.

Limitations

  • Used only when you want to pay or want the link, not when you’re just reviewing invoices.

Use cases

  • Get a pay link on your phone for an outstanding bill.

get_refund_status_tool

Access: Read-only

Returns the status of a refund on an invoice, including the refund invoice number and amount when a refund has been issued or is in progress.

Parameters

Parameter Required Description
invoice_id Optional The invoice. Preferred when available.
invoice_number Optional The invoice number shown to you.
order_item_id Optional Look up the invoice linked to an order.

Limitations

  • Read-only. It can’t start, approve, or cancel a refund. New refund requests go to live support.

Use cases

  • Check on a refund you already requested.

get_payment_methods_tool

Access: Read-only

Lists the cards and bank accounts saved on your account, with masked details for choosing one.

Parameters

Parameter Required Description
limit Optional Number of payment methods to return. Default: 25. Max: 100.

Limitations

  • Full card and account numbers are never returned, and payment method IDs stay behind the scenes.

Use cases

  • Confirm which card is on file before checkout.

get_add_payment_method_options_tool

Access: Read-only

Returns which payment method types you can add to your account, including whether bank accounts (ACH) are allowed.

Parameters: None.

Limitations

  • Payment details are entered in the secure add-payment-method app or on the Payment Methods page, never in chat.

Use cases

  • Check whether you can add a bank account before you try.

enable_autopay_tool

Access: Write (future renewals charge the payment method you choose)
Who can run it: Company owner only; shared collaborators can’t
Interface: Opens the autopay app, where you pick the payment method

Turns on autopay for a service by assigning a saved payment method to its renewals. If the service already has a different payment method, this replaces it.

Parameters

Parameter Required Description
service_id Required A service where autopay is available, from get_services_tool.
payable_id Required The payment method you chose in the app.

Limitations

  • Requires at least one saved payment method, and only services marked as eligible for autopay qualify.

Use cases

  • Keep your registered agent service from lapsing at renewal.

Registered agent, services & mail

Manage registered agent service, renewal filing service, mail plans, and the other services on your account.

Tool What it does Sample prompt
get_registered_agents_tool Show registered agent services by company and state. Who is the registered agent on my companies?
add_ra_service_to_cart Add registered agent service in a state to your cart. Add registered agent service in Florida for my LLC.
get_services_tool List the services on a company. What services are on my Wyoming LLC?
get_service_status_tool Check the status of a specific service. Is my registered agent service active?
cancel_service_tool Cancel a service. Cancel my mail forwarding service.
purchase_compliance_service_tool Start free renewal filing service in a state. Start renewal filing service for my Idaho LLC.
activate_monitoring_service_tool Activate Brand Protection monitoring. Activate my Brand Protection monitoring.
get_mail_plans_tool Compare mail forwarding and Virtual Office plans for a state. What mail plans do you offer in Delaware?
get_mail_service_plan_details_tool Show your current mail plan and suite number. Which mail plan am I on?
add_mail_plan_to_cart_tool Add a mail or Virtual Office plan to your cart. Add the mail scanning plan in Delaware to my cart.

get_registered_agents_tool

Access: Read-only

Lists your registered agent services, grouped by company, so you can see who your registered agent is in each state.

Parameters

Parameter Required Description
company_id Optional Limit results to one company.
jurisdiction Optional A state name or abbreviation, matched exactly.
active_only Optional Include only active services: active, new, awaiting your input, or awaiting payment. Default: true.
service_id Optional Return a single registered agent service.
limit Optional Number of services to return. Default: 50. Max: 100.

Use cases

  • Confirm Northwest is your registered agent in Florida.

add_ra_service_to_cart

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds registered agent service for a company in a specific state to your cart. If the company isn’t registered in that state yet, a registration is created.

Best practices

  • Your client first checks for existing registered agent service in that exact state.

Parameters

Parameter Required Description
company_id Required The company.
jurisdiction Required The state you asked for, by name or abbreviation. It’s never swapped for a different state.

Limitations

  • Not added when the company already has active or pending service in that state. Service in other states doesn’t block it.

Use cases

  • Add a registered agent before you register to do business in a new state.

get_services_tool

Access: Read-only

Lists the services for a company, or returns one service, with status, product details, and whether autopay is available and turned on.

Parameters

Parameter Required Description
company_id Optional The company. Required unless service_id is provided.
service_id Optional Return a single service.
cancellable_only Optional Return only services that can be cancelled now. Default: false.
limit Optional Number of services to return. Default: 25. Max: 100.

Use cases

  • See every service on a company.
  • Find which services can be cancelled or put on autopay.

get_service_status_tool

Access: Read-only

Returns the current status of a specific service (such as active, cancelled, or pending), its cancellation status when a cancellation is in progress, and its product details.

Parameters

Parameter Required Description
service_id Required The service to check.

Key features

  • Shows whether a cancelled email hosting service can still be reactivated.

Use cases

  • Check whether a service is active.

cancel_service_tool

Access: Write
Confirmation: Asks why you’re cancelling, then asks for your first and last name as a signature before it runs

Cancels a service that’s in a cancellable state. (⚠️ destructive)

Best practices

  • Your client confirms which service you mean, asks for a reason, and summarizes the cancellation before asking for your signature.

Parameters

Parameter Required Description
service_id Required The service to cancel.
cancellation_reason Required One of the listed reasons, such as “I no longer need the service” or “My business never started or closed”, or your own words if you choose Other.
user_confirmation_signature Required Your first and last name.

Limitations

  • Returns an error when the service doesn’t exist or can’t be cancelled.

Use cases

  • Cancel a service you no longer need.

purchase_compliance_service_tool

Access: Write (no charge, but the payment method you choose goes on autopay)
Confirmation: Runs only after you approve it in chat

Starts renewal filing service, Northwest’s compliance service for state renewals such as annual reports, for a company in a state. The service is free, but checkout requires a saved payment method, which is placed on autopay.

Best practices

  • Your client checks for existing compliance service in that state and confirms which payment method to use.

Parameters

Parameter Required Description
company_id Required The company.
jurisdiction Required The state, by name or abbreviation.
payable_id Required The saved payment method.
payable_type Required card or automatedClearingHouse.

Limitations

  • Not available when the company already has compliance service in that state.
  • Creates a registration in the state if the company doesn’t have one.

Use cases

  • Have Northwest handle renewal filings for a state.

activate_monitoring_service_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t

Activates a Brand Protection monitoring service that’s waiting to be activated, after you’ve chosen the keywords to monitor.

Parameters

Parameter Required Description
company_id Optional Required when more than one monitoring service is awaiting activation.

Limitations

  • The keywords must already be set up. This tool only activates the service.
  • Requires a monitoring service awaiting activation.

Use cases

  • Turn on Brand Protection after you pick keywords during setup.

get_mail_plans_tool

Access: Read-only

Lists mail forwarding and Virtual Office plan tiers and prices for a company in a state, including open-and-scan and forward-only options, with document upload limits where they’re defined.

Parameters

Parameter Required Description
company_id Required The company.
jurisdiction Optional Preferred. State name or abbreviation, such as Delaware or DE.
jurisdiction_id Optional The state’s ID, if already known.
state Optional Deprecated. Alias for jurisdiction.

Key features

  • Every plan includes a unique suite number at the service address. Virtual Office adds a month-to-month office lease.

Limitations

Use cases

  • Compare mail plans before you sign up.

get_mail_service_plan_details_tool

Access: Read-only

Returns your current plan for an active mail service: plan name, price, billing period, allowance reset period, delivery method, whether physical forwarding is available, saved shipping destinations, state, and suite number.

Parameters

Parameter Required Description
service_id Required A mail forwarding service from get_services_tool.

Limitations

  • Reads active mail services only.

Use cases

  • Check which mail plan you have and your suite number.

add_mail_plan_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a mail forwarding or Virtual Office plan to your cart for a company and state, after you choose a tier from get_mail_plans_tool.

Parameters

Parameter Required Description
company_id Required The company.
jurisdiction Optional Preferred. State name or abbreviation. One state source is required.
jurisdiction_id Optional The state’s ID, if already known. An alternative to jurisdiction.
state Optional Deprecated. Alias for jurisdiction.
order_item_id Optional Use the state from an in-progress filing.
product_id Optional The plan you chose. Required when more than one plan is available.

Limitations

Use cases

  • Sign up for mail scanning in your formation state.

Domains

Search for, buy, renew, transfer, and secure domains.

Tool What it does Sample prompt
search_domains_tool Check whether domain names are available. Is cedarandpine.com available?
get_domains_tool List your domains with expiration, lock status, and add-ons. Which domains do I have with you?
get_domain_detail_tool Show registrar, WHOIS, and recent activity for a domain. Show me the details for cedarandpine.com.
add_new_domain_to_cart_tool Add a new domain registration to your cart. Add cedarandpine.com to my cart.
add_domain_renewal_to_cart_tool Add a domain renewal to your cart. Renew cedarandpine.com for 3 years.
add_domain_transfer_to_cart_tool Add a transfer from another registrar to your cart. Transfer mybusiness.com to Northwest. Here’s my authorization code.
submit_domain_transfer_tool Transfer in a domain with an included domain voucher. Use my included domain to transfer in mybusiness.com.
search_domain_for_accounts_stage_tool Search domains to redeem an included domain voucher. Help me pick the domain included with my package.
create_domain_for_accounts_stage_tool Register the domain you picked with an included voucher. Register cedarandpine.com with my included domain.
update_domain_lock_tool Lock or unlock a domain. Unlock cedarandpine.com.
set_domain_auto_renew_tool Turn domain auto-renew on or off. Turn on auto-renew for cedarandpine.com.
set_domain_privacy_tool Turn WHOIS privacy on or off. Turn on domain privacy for cedarandpine.com.

search_domains_tool

Access: Read-only

Checks whether one or more domain names are available to register.

Parameters

Parameter Required Description
domains Required One to 10 full domain names, including the extension, such as cedarandpine.com.
external_check Optional Run an external WHOIS check for more accurate results. Default: false.
free_search Optional Return only domains eligible for a free domain included with your services. Default: false.

Key features

  • When you want a domain based on your business name, your assistant pulls your company names instead of asking you to type them.

Limitations

  • In clients that support in-chat apps, shopping for a domain may open an interactive search-and-cart app instead.

Use cases

  • Check whether a name is taken before you register it.

get_domains_tool

Access: Read-only

Lists the domains on your account, including domains with a transfer in progress, with expiration date, lock status, auto-renew setting, and add-ons such as SSL, email hosting, and website hosting.

Parameters

Parameter Required Description
company_id Optional Limit results to one company.
include_cancelled Optional Include cancelled domains. Default: false.
limit Optional Number of domains to return. Default: 25. Max: 100.

Key features

  • The authoritative source for domains with a transfer in progress.
  • Names the company a domain is registered under when it isn’t the one you’re working with.

Use cases

  • See when your domains expire.
  • Check whether a domain has SSL or email hosting.

get_domain_detail_tool

Access: Read-only

Returns registrar information, forwarding rules, WHOIS contacts, recent activity, and parking page settings for one domain.

Parameters

Parameter Required Description
domain_name Required The domain to look up.

Limitations

Use cases

  • Review a domain’s WHOIS contacts and recent changes.

add_new_domain_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds an available domain to your cart for a company, registered for one year.

Parameters

Parameter Required Description
company_id Required The company to register the domain under.
domain_name Required The full domain name.

Limitations

  • Checks that the company’s contact information is complete before adding the domain.

Use cases

  • Register a domain you just found available.

add_domain_renewal_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a renewal for a domain you already own to the cart of the company that owns it.

Best practices

  • For an active domain, your client asks for an exact number of years before adding the renewal.

Parameters

Parameter Required Description
company_id Required The company that owns the domain, from get_domains_tool.
domain_name Required The domain to renew.
duration Required Years to renew, from 1 to 9.

Limitations

  • An expired domain can be renewed for one year only.
  • A domain can’t be registered more than nine years ahead. If your request goes past that, the term is shortened and you’re told.

Use cases

  • Extend a domain that expires soon.

add_domain_transfer_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)
Confirmation: Runs only after you approve it in chat

Adds a transfer to your cart for a domain registered with another registrar.

Best practices

  • Get the authorization code from your current registrar, and unlock the domain there, before you start.

Parameters

Parameter Required Description
domain_name Required The domain to transfer.
auth_code Required The authorization (EPP) code from your current registrar.
company_id Required The company to transfer the domain to.
transfer_dns Required true to “Use our nameservers and DNS records” (recommended when your website or email is hosted here), or false to “Keep existing nameservers”.

Use cases

  • Move a domain from another registrar to Northwest.

submit_domain_transfer_tool

Access: Write

Transfers in a domain using an unused domain voucher already on your account, such as one included with a package, instead of buying a transfer.

Parameters

Parameter Required Description
domain_name Required The domain to transfer.
auth_code Required The authorization (EPP) code from your current registrar.
company_id Required The company that has the unused domain voucher.

Limitations

  • Only for redeeming an unused voucher. To buy a transfer, use add_domain_transfer_to_cart_tool.
  • Requires complete contact information on file. Premium domains need billing help from a representative, and domains already registered here can’t be transferred in.

Use cases

  • Redeem an included domain for a domain you already own elsewhere.

search_domain_for_accounts_stage_tool

Access: Read-only

Searches available domain names when you’re redeeming a domain voucher during account setup, with optional AI-suggested names. Prices are left out because the voucher covers registration.

Parameters

Parameter Required Description
company_id Required The company with the unused domain voucher.
search_term Required A name or domain, such as mybusiness or mybusiness.com. Searches across the default extensions.
include_suggestions Optional Include AI-suggested domain names. Default: true.

Limitations

Use cases

  • Pick the domain included with your package.

create_domain_for_accounts_stage_tool

Access: Write
Confirmation: Runs only after you approve it in chat

Registers the domain you chose with your unused domain voucher and, during account setup, saves your choice to that setup step.

Parameters

Parameter Required Description
company_id Required The company with the voucher.
domain_name Required The full domain name you picked.
accounts_stage_id Optional The setup step to save your choice to.

Limitations

  • Checks your contact information before registering the domain.

Use cases

  • Finish the “choose your domain” setup step.

update_domain_lock_tool

Access: Write

Locks or unlocks a domain at the registrar. A lock prevents transfers. Unlock a domain before you transfer it to another registrar.

Best practices

  • Lock the domain again if you decide not to transfer it.

Parameters

Parameter Required Description
domain_name Required The domain.
lock_action Required lock or unlock.

Use cases

  • Unlock a domain so you can move it to another registrar.

set_domain_auto_renew_tool

Access: Write (when turned on, renewals charge the payment method you choose)
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Turns auto-renew on or off for a domain. Turning it on requires a saved payment method for renewals.

Parameters

Parameter Required Description
domain_name Required The domain.
auto_renew Required “true” to turn on, “false” to turn off.
payable_id Optional A saved payment method. Required when turning auto-renew on.

Use cases

  • Make sure an important domain never lapses.

set_domain_privacy_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Turns WHOIS privacy on or off for a domain.

Parameters

Parameter Required Description
domain_name Required The domain.
domain_privacy Required “true” to turn on, “false” to turn off.

Use cases

  • Keep your contact details out of public WHOIS lookups.

DNS & nameservers

Read and manage DNS records and nameservers. For email setup and delivery questions, the email tools are used instead.

Tool What it does Sample prompt
get_domain_dns_records_tool Show the DNS records for a domain. Show me the DNS records for my domain.
create_domain_dns_zone_tool Create a DNS zone for a domain. Create a DNS zone for cedarandpine.com.
create_domain_dns_record_tool Add a DNS record. Add a TXT record for Google site verification.
update_domain_dns_record_tool Change a DNS record. Point my www record to 203.0.113.10.
delete_domain_dns_record_tool Delete a DNS record. Delete the old TXT record on my domain.
get_domain_nameservers_tool Show the nameservers a domain uses. What nameservers is my domain using?
update_domain_nameservers_tool Change a domain’s nameservers. Switch my domain to your nameservers.

get_domain_dns_records_tool

Access: Read-only

Returns the DNS zone records for a domain from the registrar.

Parameters

Parameter Required Description
domain_name Required The domain.

Key features

  • Records come back in the exact form that the update and delete tools need.

Use cases

  • Review your A, CNAME, MX, and TXT records.

create_domain_dns_zone_tool

Access: Write

Creates the DNS zone for a domain at the registrar when one doesn’t exist yet, optionally with initial records.

Parameters

Parameter Required Description
domain_name Required The domain.
records Optional Initial records, each with name, type, data, and ttl, plus priority, port, and weight where the record type uses them. Defaults to the platform’s NS records only.

Key features

  • TTL accepts Auto, 1 min, 2 min, 5 min, 10 min, 15 min, 30 min, 1 hr, 2 hr, 5 hr, 12 hr, or 1 day.

Use cases

  • Set up DNS for a domain that doesn’t have a zone.

create_domain_dns_record_tool

Access: Write

Adds a DNS record to an existing zone.

Parameters

Parameter Required Description
domain_name Required The domain.
record Required The record, with name (relative to the domain), type, and data, an optional ttl, and priority, port, or weight for MX and SRV records.

Use cases

  • Add a TXT record to verify your domain with another service.
  • Point a subdomain to another host with a CNAME record.

update_domain_dns_record_tool

Access: Write

Changes a single DNS record. Your assistant passes the record exactly as it was returned, along with the new values.

Parameters

Parameter Required Description
domain_name Required The domain.
current_record Required The record as returned by get_domain_dns_records_tool, used to find it.
record Required The record with the updated values.

Limitations

  • Replaces the record’s current values. DNS changes can take time to take effect.

Use cases

  • Change where your website’s A record points.

delete_domain_dns_record_tool

Access: Write

Deletes a single DNS record. Your assistant passes the exact record from the latest lookup. (⚠️ destructive, irreversible)

Best practices

  • Review the record before you confirm. Deleting MX or verification records can break email or connected services.

Parameters

Parameter Required Description
domain_name Required The domain.
record Required The record to delete, as returned by get_domain_dns_records_tool.

Use cases

  • Remove an old record left behind by a previous host.

get_domain_nameservers_tool

Access: Read-only

Returns the nameservers a domain publicly resolves to right now.

Parameters

Parameter Required Description
domain_name Required The domain.

Use cases

  • Confirm whether a domain uses Northwest’s nameservers or another provider’s.

update_domain_nameservers_tool

Access: Write

Sets the nameservers for a domain at the registrar, in one of three modes: Northwest’s nameservers, personalized nameservers on your own domain, or external nameservers from another provider.

Parameters

Parameter Required Description
domain_name Required The domain.
nameserver_mode Required use_our_nameservers, personalized_nameservers, or external_nameservers.
glue_subdomains Personalized mode only Two subdomain labels. Hostnames become ns1.{label}.{domain} and ns2.{label}.{domain}. Defaults to HOSTING when you don’t choose labels.
nameservers External mode only Two to four full nameserver hostnames.

Limitations

  • One mode per call.
  • Switching nameservers moves where your DNS is managed, so your website and email records need to exist with the new provider.

Use cases

  • Point a domain to a website builder’s nameservers.

Domain forwarding

Forward a domain or subdomain to another web address with a URL redirect.

Tool What it does Sample prompt
show_domain_forwarding_tool List the URL redirects on a domain. Where does cedarandpine.com forward?
set_domain_forwarding_tool Forward a domain or subdomain to another URL. Forward cedarpine.net to cedarandpine.com.
update_domain_forwarding_tool Change an existing domain redirect. Change where www.cedarpine.net forwards.
delete_domain_forwarding_tool Remove a domain redirect. Remove the forwarding on cedarpine.net.
set_bulk_domain_forwarding_tool Forward several domains at once. Forward all my extra domains to cedarandpine.com.
get_forwarding_domains_tool List the domains that forward to a domain. Which domains forward to cedarandpine.com?

show_domain_forwarding_tool

Access: Read-only

Lists the URL forwarding (redirect) records on a domain.

Parameters

Parameter Required Description
domain_name Required The domain.

Key features

  • The company owner and shared collaborators who can view the domain can read its forwarding records.

Use cases

  • Check where a domain or subdomain redirects before you change it.

set_domain_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t

Creates a forwarding (redirect) record, so a domain or subdomain forwards to another URL.

Parameters

Parameter Required Description
domain_name Required The domain.
redirect Required The destination URL or hostname. The protocol is optional.
subdomain Optional The subdomain to forward, such as www. Omit to forward the root domain.

Use cases

  • Forward a spare domain to your main website.

update_domain_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Changes the destination or subdomain of an existing forwarding record.

Parameters

Parameter Required Description
domain_name Required The domain.
old_subdomain Required The subdomain of the record to change. Use an empty string for the root domain.
redirect Required The new destination.
subdomain Optional A new subdomain. Omit to keep the current one.

Use cases

  • Point a redirect at your new website.

delete_domain_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Removes a forwarding record from a domain. (⚠️ destructive, irreversible)

Parameters

Parameter Required Description
domain_name Required The domain.
old_subdomain Required The subdomain of the record to remove. Use an empty string for the root domain.

Use cases

  • Stop a domain from redirecting.

set_bulk_domain_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Lists every domain and destination, then runs only after you approve the whole plan

Sets up forwarding for several domains in one operation, using permanent (HTTP 301) redirects with SSL.

Parameters

Parameter Required Description
domains Required A list of entries, each with a domain_id (from get_domains_tool), a redirect, and an optional subdomain.

Limitations

  • If any domain in the request isn’t authorized, the whole request is rejected.

Use cases

  • Forward all of your spare domains to your main site at once.

get_forwarding_domains_tool

Access: Read-only
Who can run it: Company owner only; shared collaborators can’t

Lists the other domains on your account that forward to a given domain.

Parameters

Parameter Required Description
domain_name Required The destination domain.

Use cases

  • See which domains point at your main site before you change it.

Business email

Buy and manage business email: plans, inboxes, passwords, email app setup, usage, and forwarding. Tools that handle passwords open an in-chat app, so passwords never pass through chat.

Tool What it does Sample prompt
get_email_hosting_tool Show the email plan and status on a domain. What email plan is on my domain?
get_email_hosting_plans_tool Compare email hosting plans and prices. How much is email hosting?
add_email_hosting_to_cart_tool Add email hosting for a domain to your cart. Add the basic email plan for cedarandpine.com to my cart.
activate_email_hosting_addon_tool Activate email hosting included with your services. Activate the email that came with my package.
change_email_hosting_plan_tool Upgrade or downgrade an email plan. Upgrade my email to the pro plan.
reactivate_email_hosting_tool Reactivate cancelled email hosting. Reactivate my email on cedarandpine.com.
get_email_inboxes_tool List email inboxes and their status. What email inboxes do I have?
create_email_inbox_tool Create a business email inbox. Set up a hello@ address on cedarandpine.com.
change_email_inbox_password_tool Reset an inbox password. Reset the password for my business email.
get_email_inbox_login_url_tool Get a short-lived webmail sign-in link. Log me into webmail for my hello@ inbox.
get_email_inbox_storage_usage_tool Show how full each inbox is. How full is my inbox?
get_email_inbox_send_usage_tool Show daily sending counts for each inbox. How many emails have I sent today?
get_email_smtp_settings_tool Get IMAP, POP3, and SMTP settings for email apps. How do I set up my business email on my iPhone?
check_webmail_server_reachability_tool Check whether webmail is reachable. Can you check whether webmail is up for my domain?
get_email_forwarding_tool List email forwarding rules. Where does info@ on cedarandpine.com forward?
create_email_forwarding_tool Forward an address to an outside inbox. Forward info@ on cedarandpine.com to my Gmail address.
update_email_forwarding_tool Change where a forwarding rule sends email. Forward info@ to Sam’s address instead.
delete_email_forwarding_tool Delete an email forwarding rule. Stop forwarding info@ on cedarandpine.com.

get_email_hosting_tool

Access: Read-only

Returns the business email hosting on a domain, including the plan, limits, service status, and cancellation status.

Parameters

Parameter Required Description
domain_name Required The domain.

Limitations

Use cases

  • Check your email plan and inbox limit.

get_email_hosting_plans_tool

Access: Read-only

Lists email hosting plan tiers and prices for a domain, including the price you’d actually pay after any free trial or website hosting discount.

Parameters

Parameter Required Description
domain_name Required The domain the email is for.

Key features

  • Free trial eligibility and the effective price are calculated for that domain’s company.

Limitations

  • Some plans require website hosting on the domain and are free with it. Nothing is added to your cart.

Use cases

  • Compare email plans before you buy or switch tiers.

add_email_hosting_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)

Adds an email hosting plan to your cart for a domain that doesn’t have email hosting yet.

Parameters

Parameter Required Description
domain_name Required The domain.
hosting_email_product_id Required The plan you chose from get_email_hosting_plans_tool.

Limitations

  • For first-time purchases only. To change an existing plan, use change_email_hosting_plan_tool.
  • After checkout, the plan may need to be activated and an inbox created before you can send email.

Use cases

  • Add business email to a new domain.

activate_email_hosting_addon_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t

Activates an email hosting voucher on a domain by redeeming email service that’s waiting to be activated, such as email included with a package.

Parameters

Parameter Required Description
domain_name Required The domain.

Limitations

  • Requires an unused email hosting voucher.

Use cases

  • Turn on included email before you create your first inbox.

change_email_hosting_plan_tool

Access: Write (upgrades charge a saved payment method)
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Summarizes the domain, current and new plan, price, and any inboxes to suspend, then runs only after you approve

Upgrades or downgrades the email hosting plan on a domain that already has business email. Upgrades charge a saved payment method directly, with no separate invoice to pay.

Parameters

Parameter Required Description
domain_name Required The domain.
new_product_id Required The new plan, from get_email_hosting_plans_tool.
confirmed_intent Required Must be true. Set only after you approve.
payable_id Optional A saved payment method. Required for upgrades.
mailboxes_to_suspend Optional The inboxes to suspend when you downgrade to a plan with fewer inboxes than you have.

Key features

  • Also changes plans while a cancellation is pending, which reactivation can’t do.

Limitations

  • Plans that don’t accept bank accounts must be paid by card.

Use cases

  • Upgrade to a plan with more inboxes.

reactivate_email_hosting_tool

Access: Write (charges a saved payment method)
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Summarizes the plan and price, then runs only after you reply yes in a later message

Reactivates cancelled or pending-cancellation email hosting on its existing plan, charging a saved payment method and undoing the cancellation.

Parameters

Parameter Required Description
domain_name Required The domain.
payable_id Required A saved payment method for the reactivation charge.
confirmed_intent Required Must be true. Set only after you approve.

Limitations

  • Available only while the cancellation is pending or the service is suspended, and not while it’s waiting on payment.
  • Restores the same plan. To choose a different plan, use change_email_hosting_plan_tool.

Use cases

  • Keep your email running after you cancelled by mistake.

get_email_inboxes_tool

Access: Read-only

Lists the inboxes on a domain with each address, username, and status (Active or Suspended), plus the domain’s email hosting status and cancellation status.

Parameters

Parameter Required Description
domain_name Required The domain.

Use cases

  • See every email address on a domain.
  • Check whether an inbox is suspended or email hosting needs reactivation.

create_email_inbox_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Interface: Opens an in-chat app that collects the username and password

Creates a business email inbox on a domain and returns the new address and a webmail link.

Parameters

Parameter Required Description
domain_name Required The domain.
username Required The part of the address before the @, entered in the app.
password Required The mailbox password, entered in the app.

Limitations

  • Not available when email hosting is expiring, suspended, or waiting on payment.
  • Passwords are never returned or logged.

Use cases

  • Create hello@ or support@ addresses for your business.

change_email_inbox_password_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Interface: Opens an in-chat app that collects the new password

Resets the password for an existing inbox.

Parameters

Parameter Required Description
hosting_email_inbox_id Required The inbox, from get_email_inboxes_tool.
password Required The new password, entered in the app.

Limitations

  • Not available when email hosting is suspended, waiting on payment, or pending cancellation, or when the inbox itself is suspended.

Use cases

  • Get back into a mailbox after you forget the password.
  • Set a password you can use in Outlook or on your phone.

get_email_inbox_login_url_tool

Access: Read-only

Returns a short-lived sign-in link that opens webmail for one inbox.

Parameters

Parameter Required Description
hosting_email_inbox_id Required The inbox, from get_email_inboxes_tool.

Limitations

  • The link expires in about five minutes and is available only when webmail sign-in is enabled for the inbox.

Use cases

  • Open webmail without typing your password.

get_email_inbox_storage_usage_tool

Access: Read-only

Returns the storage each inbox on a domain is using, in bytes and as a percentage of its limit.

Parameters

Parameter Required Description
domain_name Required The domain.

Use cases

  • Check whether an inbox is close to full.

get_email_inbox_send_usage_tool

Access: Read-only

Returns daily outgoing email counts for each inbox on a domain.

Parameters

Parameter Required Description
domain_name Required The domain.

Use cases

  • Check whether you’re close to a sending limit.

get_email_smtp_settings_tool

Access: Read-only

Returns authoritative instructions for connecting an email app to your business email: the username, password guidance, incoming IMAP and POP3 servers, and the outgoing SMTP server with ports, security, and authentication.

Parameters

Parameter Required Description
email_address Optional The inbox to set up. Also identifies the domain.
domain_name Optional The email domain, when no address is given.
email_client Optional Your app or device, for a matching setup guide: apple-iphone-ipad, apple-mac-os, outlook-webmail, outlook-desktop, outlook-apple, outlook-android, gmail, gmail-apple, or gmail-android.

Key features

  • Settings come from your email hosting, never from DNS records or guesses.

Limitations

  • Never returns the password. Use the inbox password you set.

Use cases

  • Set up business email in Outlook, Apple Mail, Gmail, or on your phone.
  • Troubleshoot sending or receiving after an email migration.

check_webmail_server_reachability_tool

Access: Read-only
Confirmation: Runs only when you ask for the check, or accept it when it’s offered

Checks whether the webmail site for your email domain can be reached over HTTPS from our servers.

Parameters

Parameter Required Description
domain_name Required The domain with email hosting.
confirmed_intent Required Must be true. Set only after you ask for the check or accept it.

Limitations

  • A point-in-time check, not proof of an outage. It doesn’t test passwords, IMAP or SMTP connections, or email delivery.

Use cases

  • Rule out a webmail outage when webmail won’t load.

get_email_forwarding_tool

Access: Read-only
Who can run it: Company owner only; shared collaborators can’t

Lists the email forwarding rules on a domain, each forwarding an address on your domain to an outside address.

Parameters

Parameter Required Description
domain_name Required The domain.

Use cases

  • See where info@ forwards.

create_email_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t

Forwards an address on your domain to an outside email address.

Best practices

  • Your client checks your existing rules first to avoid duplicates.

Parameters

Parameter Required Description
domain_name Required The domain.
source Required The full address on your domain, including the domain name.
destination Required The outside address to forward to.

Use cases

  • Send email for info@ to an inbox you already use.

update_email_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Changes where an existing forwarding rule sends email. The source address stays the same.

Parameters

Parameter Required Description
domain_name Required The domain.
source Required The address on your domain.
old_destination Required The current destination.
new_destination Required The new destination.

Use cases

  • Route info@ to a new team member.

delete_email_forwarding_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t
Confirmation: Runs only after you approve it in chat

Deletes an email forwarding rule. (⚠️ destructive, irreversible)

Best practices

  • Your client shows your current rules so you can pick the exact one to remove.

Parameters

Parameter Required Description
domain_name Required The domain.
source Required The address on your domain.
destination Required The destination of the rule to delete.

Use cases

  • Stop forwarding after you set up a real inbox for that address.

Website hosting

Activate website hosting included with your services.

Tool What it does Sample prompt
activate_website_hosting_addon_tool Activate website hosting included with your services. Activate website hosting on cedarandpine.com.

activate_website_hosting_addon_tool

Access: Write
Who can run it: Company owner only; shared collaborators can’t

Activates a website hosting voucher on a domain, setting up website hosting that’s waiting to be activated.

Parameters

Parameter Required Description
domain_name Required The domain to host.

Limitations

  • Requires an unused website hosting voucher.

Use cases

  • Turn on included website hosting during account setup.

Phone service

Buy local business numbers and manage lines, call forwarding, voicemail, caller ID, and the Corporate Phone app. Phone Service offers local US and Canadian numbers only; toll-free numbers aren’t available.

Tool What it does Sample prompt
get_phone_plans_tool List Phone Service plans. What phone plans do you have?
search_available_numbers_tool Search available local numbers by area code. Find a 509 phone number I can use.
reserve_phone_number_tool Hold a number while you finish ordering. Reserve 509-555-0123.
add_phone_service_to_cart_tool Add a phone line with your reserved number to your cart. Add a phone line with that number to my cart.
attach_number_to_provisioned_service Assign a number to a line that’s waiting for one. Use 509-555-0123 for my new phone line.
get_virtual_phones_tool List the phone lines on your account. What phone numbers are on my account?
change_phone_service_plan_tool Change a phone line’s plan. Upgrade my phone line to the next plan.
reactivate_phone_service_tool Reactivate a recently cancelled phone line. Reactivate my cancelled business line.
get_phone_app_username_tool Show your Corporate Phone app username. What’s my phone app username?
set_phone_app_username_tool Create your Corporate Phone app username. Set my phone app username to cedarpine_main.
get_phone_settings_tool Show a line’s label and attachment retention. What are the settings on my business line?
update_phone_settings_tool Rename a line or change attachment retention. Rename my line to Main Office.
get_call_forwarding_tool Show call forwarding settings. Is call forwarding on for my business line?
update_call_forwarding_tool Turn call forwarding on or off. Forward my business line to my cell.
get_voicemail_settings_tool Show voicemail settings. What voicemail greeting is on my line?
update_voicemail_settings_tool Change the voicemail greeting or retention. Use the generic voicemail greeting on my line.
get_cnam_tool Show your outgoing caller ID name. What caller ID name shows on my outgoing calls?
update_cnam_tool Change your outgoing caller ID name. Set my caller ID name to CEDAR PINE.

get_phone_plans_tool

Access: Read-only

Lists the Phone Service plans you can buy for a company.

Parameters

Parameter Required Description
company_id Required The company. Free trial eligibility is checked for it.

Use cases

  • Compare phone plans before you buy a line.

search_available_numbers_tool

Access: Read-only

Lists phone numbers available in a US or Canadian area code.

Best practices

Parameters

Parameter Required Description
area_code Required A three-digit geographic area code, such as 509. Toll-free codes aren’t supported.
nxx Optional A three-digit prefix within the area code.
page Optional Page number. Default: 1.
page_size Optional Numbers per page. Default: 6. Max: 50.

Use cases

  • Find a local number for your business.

reserve_phone_number_tool

Access: Write

Holds a phone number you picked so it stays available while you finish your order or activation.

Parameters

Parameter Required Description
number Required A number from search_available_numbers_tool, in 10-digit or +1 format.

Key features

  • Tells your assistant the next step: attach the number to a line that’s waiting for one, or add a new plan to your cart.

Use cases

  • Hold a number while you finish ordering.

add_phone_service_to_cart_tool

Access: Write (adds to your cart; nothing is charged until checkout)

Adds a Phone Service plan with your reserved number to a company’s cart.

Best practices

  • New lines follow this order: search for a number, reserve it, confirm or set your Corporate Phone app username, then add the plan.

Parameters

Parameter Required Description
company_id Required The company.
simple_product_id Required The plan, from get_phone_plans_tool.
reserved_number Required The reserved number in +1 format.
reserved_tn_id Required The reservation, from reserve_phone_number_tool.
phone_app_username Required Your Corporate Phone app username.

Use cases

  • Buy a business phone line.

attach_number_to_provisioned_service

Access: Write

Assigns a number to an existing Phone Service line that’s waiting for one, such as a line included with a package.

Parameters

Parameter Required Description
virtual_phone_id Required The line waiting for a number.
number Required The 10-digit number you chose, without the +1.

Limitations

  • Not for new purchases. New lines go through reserving a number and adding a plan to your cart.

Use cases

  • Choose the number for a line you already have.

get_virtual_phones_tool

Access: Read-only

Lists your Phone Service lines with each line’s setup state and service status.

Parameters

Parameter Required Description
company_id Optional Limit results to one company.
scope Optional active for current lines, or inactive for cancelled lines still within the 45-day pending-removal window. Default: active.
limit Optional Number of lines to return. Default: 25. Max: 100.

Use cases

  • See your business phone numbers.
  • Find a cancelled line you can still reactivate.

change_phone_service_plan_tool

Access: Write (upgrades charge a saved payment method)
Confirmation: Runs only after you approve it in chat

Changes the plan on an existing Phone Service line. Moving to a higher-priced plan is charged to a saved payment method.

Parameters

Parameter Required Description
virtual_phone_id Required The line.
simple_product_id Required The new plan, from get_phone_plans_tool.
confirmed_intent Required Must be true. Set only after you approve.
payable_id Optional A saved payment method. Required for upgrades.
card_cvv Optional The card’s CVV, when the payment method requires one.

Use cases

  • Move a line to a different plan.

reactivate_phone_service_tool

Access: Write (charges a saved payment method)
Confirmation: Runs only after you approve it in chat

Reactivates a cancelled Phone Service line that’s still within the 45-day pending-removal window, charging a saved payment method.

Parameters

Parameter Required Description
virtual_phone_id Required The cancelled line, from get_virtual_phones_tool with scope set to inactive.
payable_id Required A saved payment method for the reactivation charge.
confirmed_intent Required Must be true. Set only after you approve.

Limitations

  • Only lines marked as reactivatable qualify.

Use cases

  • Keep a number you cancelled by mistake.

get_phone_app_username_tool

Access: Read-only

Returns your Corporate Phone app username, if you’ve set one.

Parameters: None.

Use cases

  • Look up your phone app sign-in.

set_phone_app_username_tool

Access: Write

Creates your Corporate Phone app username, which you need before you buy your first line.

Parameters

Parameter Required Description
username Required 6 to 254 characters. Letters, numbers, and @ . _ – are allowed.

Limitations

  • Fails if you already have a username. To change it, use Phone Service settings in the portal.
  • Your app password is never handled in chat.

Use cases

  • Set your app sign-in before you add a phone line.

get_phone_settings_tool

Access: Read-only

Returns a line’s label (phone name) and how long message attachments are kept.

Parameters

Parameter Required Description
virtual_phone_id Required The line.

Use cases

  • Check how long attachments are kept on a line.

update_phone_settings_tool

Access: Write

Updates a line’s label and how long its message attachments are kept.

Parameters

Parameter Required Description
virtual_phone_id Required The line.
name Optional The line label: 3 to 50 characters, starting and ending with a letter or number, and may include spaces, underscores, periods, apostrophes, and hyphens.
media_lifespan_in_days Optional How long attachments are kept: 7, 14, or 28 days.

Use cases

  • Rename a line so it’s easy to tell apart.

get_call_forwarding_tool

Access: Read-only

Returns the call forwarding settings for a line, including whether forwarding is on and where calls go.

Parameters

Parameter Required Description
virtual_phone_id Required The line.

Use cases

  • Check whether calls ring in the app or forward to your cell.

update_call_forwarding_tool

Access: Write

Turns call forwarding on or off for a line.

Parameters

Parameter Required Description
virtual_phone_id Required The line.
forward_type Required number-only turns forwarding on. browser-only turns it off, so calls ring in the Corporate Phone app.
forward_to_number Optional The destination number, in +1 or 10-digit US format. Required when turning forwarding on.

Use cases

  • Forward your business line to your cell while you travel.

get_voicemail_settings_tool

Access: Read-only

Returns the voicemail settings for a line, such as the greeting type and how long voicemails are kept.

Parameters

Parameter Required Description
virtual_phone_id Required The line.

Use cases

  • Check which greeting your callers hear.

update_voicemail_settings_tool

Access: Write

Updates a line’s voicemail greeting type and how long voicemails are kept.

Parameters

Parameter Required Description
virtual_phone_id Required The line.
greeting_type Optional custom, generic, or beep.
voicemail_lifespan_in_days Optional 14 (two weeks), 60 (two months), or 182 (six months).

Limitations

  • Custom greetings are recorded on the phone line’s page in the portal, under Manage Custom Greeting.

Use cases

  • Switch to the generic greeting.

get_cnam_tool

Access: Read-only

Returns the outgoing caller ID name (CNAM) for a line.

Parameters

Parameter Required Description
virtual_phone_id Required The line.

Use cases

  • Check what name people see when you call.

update_cnam_tool

Access: Write

Updates the outgoing caller ID name (CNAM) for a line. (⚠️ a caller ID name can’t be deleted once set)

Parameters

Parameter Required Description
virtual_phone_id Required The line.
caller_id_name Required The new caller ID name, up to 15 characters.

Limitations

  • You can change the caller ID name later, but you can’t remove it, here or in the portal.

Use cases

  • Show your business name on outgoing calls.

Knowledge base

Search Northwest guides, filing help, and product documentation without leaving the conversation.

Tool What it does Sample prompt
kb__search_customer Search Northwest guides, filing rules, and product help. What does Washington require for an LLC annual report?

kb__search_customer

Access: Read-only

Searches Northwest’s customer-facing knowledge base, including how-to guides, state filing rules, and product help.

Parameters

Parameter Required Description
query Required A full question or sentence in your own words. Lists of keywords return worse results.
jurisdiction Optional A US state or territory code to focus the results.
knowledge_areas Optional Narrow the search to areas such as formations, compliance, registered_agent, mail, domains, email_hosting, web_hosting, phone, ein, billing, account_access, trademarks, vehicles, general_filings, order_status, services, sales, general, or wyoming.
top_k Optional Number of results, from 1 to 20. Default: 4.
website_id Optional A website ID, domain, or URL to focus on one brand’s site.
include_review_drafts Optional Include draft articles submitted for review that the caller is authorized to see.
include_global_review_drafts Optional With include_review_drafts, also include global review drafts.
review_team_scope_ids Optional Team scopes whose review drafts may be included.

Limitations

Use cases

  • Look up what a state requires for an annual report.

Utilities & display

Keep dates accurate and show results as charts and tables in the conversation.

Tool What it does Sample prompt
get_todays_date_tool Get the current date and time. How many days until my annual report is due?
show_chart Show results as a chart in the conversation. Chart what I’ve paid each month this year.
show_table Show results as a sortable table in the conversation. Make a table of my domains and their expiration dates.

get_todays_date_tool

Access: Read-only

Returns the current date and time in the application’s time zone: day, month name and number, year, hour (24-hour), minute, time zone name and abbreviation, and UTC offset.

Parameters: None.

Key features

  • Lets your assistant use the real date for deadlines and forms instead of guessing.

Use cases

  • Work out how many days are left before a due date.

show_chart

Access: Display only (shows results in the conversation and changes nothing)

Shows numeric results as a chart in the conversation.

Parameters

Parameter Required Description
chart_type Required line, bar, area, pie, or scatter.
title Required The chart title.
x_values Required Labels or values along the x-axis, up to 500.
series Required One to 10 series, each with a name and up to 500 values.
unit Optional A unit label, such as USD.
x_label Optional The x-axis label.

Key features

  • The chart renders automatically, so the values aren’t repeated in the reply.

Use cases

  • Chart your invoice totals by month.

show_table

Access: Display only (shows results in the conversation and changes nothing)

Shows computed results as a table card in the conversation, with sorting and CSV download.

Parameters

Parameter Required Description
title Required The table title.
columns Required 1 to 20 column names.
rows Required Up to 200 rows of up to 20 cells each.
truncated Optional Marks the table as a partial result.

Use cases

  • Compare annual report due dates across all of your companies.

Example workflow

  1. “What companies are on my account?”
  2. “Is the annual report filed for the Washington LLC?”
  3. “Add the annual report to my cart and show me the total.”

The client may call get_companies_tool, then get_annual_reports_tool, then discover_products_tool, select_product_tool, and add_product_to_cart_tool to add the filing, and finally get_cart_items_tool to quote the total. You only need the conversation.

Tools vary by account

This catalog reflects the tools the Northwest connector exposes as of October 2026. Some tools are enabled per account or brand, such as WordPress hosting controls and vehicle registrations, so your client may list tools that aren’t on this page, or fewer than this page shows. If your MCP client lists a tool that isn’t here, it’s available to you. Ask in plain language and let the client select it.

Ready to try Bigfoot?

Log in to the client portal, or connect the MCP server to the AI client you already use.