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.
| Tool | Plane | Cost | What it is for |
|---|---|---|---|
describe_data | reference | Free | What the dataset can and cannot answer. The right first call for a model that has never used Boardwalk. |
list_locations | reference | Free | States, counties and cities, with the ids the filters take. |
get_project_types | reference | Free | The project-type tree (broad type → more specific → class, e.g. Commercial → Gas Stations). |
count_projects | analytics | Free | How many records match. On API Only and the trial, also what delivering them would cost. Takes the same filters as get_projects. |
analyze_projects | analytics | Free | Group and measure. Answers "how many / what mix / which is biggest" without returning any record identity. |
get_ai_search_result | leads | Free | Poll 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_balance | account | Free | Remaining credits for the period. Free. Call before Find Contact Info, or before a search on API Only or the trial. |
list_alerts | account | Free | The 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_alert | account | Free | One 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_alert | account | Free | Create 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_alert | account | Free | Change filters, cadence, notification or sharing. Any member may edit. |
delete_alert | account | Free | Archive 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_alert | account | Free | What a run would match and cost, without delivering. The preflight for run_alert. |
get_alert_deliveries | account | Free | Past API runs of an alert, if any. Not required to pull the projects already on that alert. |
get_alert_matches | leads | Free | Every 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_enrichment | leads | 1 credit per project | Find 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_enrichment | leads | Free | Poll an enrichment job. Free. notAttempted ids can be re-submitted. |
cancel_ai_search | leads | Free | Cancel an AI-search job. Free, and only ever refunds reserved credits. |
dismiss_alert_project | account | Free | Stop an alert re-offering a project — for every member; dismissals are shared state. |
undismiss_alert_project | account | Free | Undo a dismissal, for every member. |
list_user_lists | account | Free | The 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_list | account | Free | One 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_list | account | Free | Create a named list — the "new list" option on the save chooser. |
add_to_list | account | Free | Save project ids onto Saved or a named list. Always offer every list first. |
remove_from_list | account | Free | Remove a project from a membership-backed list. |
get_preferences | account | Free | Saved search preferences. Call on a first session; inherit a team blob when empty. |
update_preferences | account | Free | Write types, geography, and optional website onto the account. |
list_exports | account | Free | Team CSV export jobs — the same list as boardwalkai.com/exports. |
get_export | account | Free | Poll one export job. When ready, return the download URL — never the CSV bytes. |
download_export | account | Free | Fetch a ready CSV so a host with a disk can write it locally. Do not paste rows into chat. |
get_reference | reference | Free | Canonical tokens for status, decisionBodies, and requestTypes filters. |
get_location | reference | Free | One state, county, or city by numeric id from list_locations. |
get_projects | leads | Free | Project details matching a filter set. Free. Review up to ~250 in chat; export the rest. |
get_projects_sync | leads | Free | Incremental feed of new or changed records. Free. |
get_project | leads | Free | One record in detail. Free. Email/phone stay withheld until Find Contact Info unlocks them. |
get_document | leads | Free | A source meeting document. Free. |
ai_search_projects | leads | Free | Natural-language search. Free. |
run_alert | leads | Free | Trigger 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_results | leads | Free | The projects already on a named list. Extra filters stay inside those ids. Free. |
create_export | leads | Free | Queue 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
limitwell below the API's own page ceiling, andlimitis 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
maxCreditsacknowledgement in the arguments.run_alertrequiresmaxCreditson every call — a run can deliver up to the alert's own per-run ceiling, so there is no safe default to assume. delete_alertdeletes 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 gets403.- 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.