Skip to main content

MCP tools

Every tool the Boardwalk MCP server exposes, which plane it belongs to, and what it costs.

AI-native analysts and MCP clientsData and PropTech platforms

Tools are grouped into planes. The plane is the sentence a model needs most and is least likely to infer: whether a call spends money.

ToolPlaneCostWhat it is for
describe_datareferenceFreeWhat the dataset can and cannot answer. The right first call for a model that has never used Boardwalk.
list_locationsreferenceFreeStates, counties and cities, with the ids the filters take.
get_project_typesreferenceFreeThe project-type tree (broad type → more specific → class, e.g. Commercial → Gas Stations).
count_projectsanalyticsFreeHow many records match. On API Only and the trial, also what delivering them would cost. Takes the same filters as get_projects.
analyze_projectsanalyticsFreeGroup and measure. Answers "how many / what mix / which is biggest" without returning any record identity.
get_ai_search_resultleadsFreePoll an AI-search job. While running, progress only; when complete, a page of project details (limit required). Searching is free on County, State, and National.
get_credit_balanceaccountFreeRemaining credits for the period. Free. Call before Find Contact Info, or before a search on API Only or the trial.
list_alertsaccountFreeThe named alerts they already have, with how many matches except dismissed are already on each (pending review included). Match a name here, then pull those existing ids — do not search.
get_alertaccountFreeOne named alert: every match except dismissed (pending review stays in), plus filters as context. Pull those ids with get_alert_matches; do not re-run the filters.
create_alertaccountFreeCreate a standing search on a cadence. Configuration is free. Records are free; Find Contact Info is billed separately. Takes the same share block as the API.
update_alertaccountFreeChange filters, cadence, notification or sharing. Any member may edit.
delete_alertaccountFreeArchive an alert for every member — owner or team admin only (members get 403), and the tool requires explicit user confirmation before it is called. Delivery history survives.
preview_alertaccountFreeWhat a run would match and cost, without delivering. The preflight for run_alert.
get_alert_deliveriesaccountFreePast API runs of an alert, if any. Not required to pull the projects already on that alert.
get_alert_matchesleadsFreeEvery match except dismissed on a named alert, including pending review. Free. Omit deliveryId. This is how you pull an alert, not run_alert and not a new search.
create_enrichmentleads1 credit per projectFind email and phone for project ids. 1 credit per project the first time this account receives a contact channel. Empty lookups cost nothing. Poll with get_enrichment.
get_enrichmentleadsFreePoll an enrichment job. Free. notAttempted ids can be re-submitted.
cancel_ai_searchleadsFreeCancel an AI-search job. Free, and only ever refunds reserved credits.
dismiss_alert_projectaccountFreeStop an alert re-offering a project — for every member; dismissals are shared state.
undismiss_alert_projectaccountFreeUndo a dismissal, for every member.
list_user_listsaccountFreeThe named lists they already have, with how many projects are already on each. An alert companion is the same match set as that alert (pending review included).
get_listaccountFreeOne named list: how many projects are already on it. An alert companion is the same match set as that alert (pending review included). A filter/polygon list is a saved search, not a pull.
create_listaccountFreeCreate a named list — the "new list" option on the save chooser.
add_to_listaccountFreeSave project ids onto Saved or a named list. Always offer every list first.
remove_from_listaccountFreeRemove a project from a membership-backed list.
get_preferencesaccountFreeSaved search preferences. Call on a first session; inherit a team blob when empty.
update_preferencesaccountFreeWrite types, geography, and optional website onto the account.
list_exportsaccountFreeTeam CSV export jobs — the same list as boardwalkai.com/exports.
get_exportaccountFreePoll one export job. When ready, return the download URL — never the CSV bytes.
download_exportaccountFreeFetch a ready CSV so a host with a disk can write it locally. Do not paste rows into chat.
get_referencereferenceFreeCanonical tokens for status, decisionBodies, and requestTypes filters.
get_locationreferenceFreeOne state, county, or city by numeric id from list_locations.
get_projectsleadsFreeProject details matching a filter set. Free. Review up to ~250 in chat; export the rest.
get_projects_syncleadsFreeIncremental feed of new or changed records. Free.
get_projectleadsFreeOne record in detail. Free. Email/phone stay withheld until Find Contact Info unlocks them.
get_documentleadsFreeA source meeting document. Free.
ai_search_projectsleadsFreeNatural-language search. Free.
run_alertleadsFreeTrigger a real run now. Free. Preview first, tell them the number, and only run after they say yes. Capped at 3 manual runs per America/Denver calendar day.
get_list_resultsleadsFreeThe projects already on a named list. Extra filters stay inside those ids. Free.
create_exportleadsFreeQueue the product CSV for a saved alert/list, the ids already in hand, or a new search — not one chat page. Receipt only. Find Contact Info on the file is 1 credit per project if email or phone is found.

Guardrails built into the tools

  • Every record-returning tool names a free tool that prices it first, and the tool description points at it.
  • Record-returning tools cap limit well below the API's own page ceiling, and limit is required rather than optional — an omitted limit used to mean the maximum.
  • A call that would spend more than a small floor of credits requires an explicit maxCredits acknowledgement in the arguments. run_alert requires maxCredits on every call — a run can deliver up to the alert's own per-run ceiling, so there is no safe default to assume.
  • delete_alert deletes the alert for every member of a shared alert, so its description instructs the model to obtain explicit user confirmation first — the confirm step a UI would render, moved into the transcript. Only the alert's owner or the team admin may call it; any other member gets 403.
  • Alert and list tools follow the signed-in user's membership: their own entities plus what is shared with them. Each person signs in with their own Boardwalk account.
  • Every tool calls the public API. None of them reaches an internal endpoint, so the plan gate, the geographic ceiling and the usage log apply identically to a model and to a human.

Ready to connect?

Sign in with your Boardwalk account. No API key. Free trial: pull up to 50 projects. Then upgrade for full access to the places you picked.