Docs / MCP tools
MCP and agents
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. Cost includes credits charged by the public API, even when the MCP layer adds no charge. Record delivery is free inside the geography of County, State, and National plans; on the trial and API Only plan, new or changed records can use credits. Use the free count_projects tool before a new pull.
| 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. Does not deliver a record, so it spends neither the export cap nor Find Contact Info. 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). New records were counted toward the export cap when the job settled. |
get_credit_balance | account | Free | Find Contact Info credits and exportCredits (used, remaining, limit, resetsAt). Free. Call before a large pull or before Find Contact Info. |
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. Set enrichContacts to look contacts up on every run before it notifies. Takes the same share block as the API. |
update_alert | account | Free | Change filters, cadence, notification, sharing, or enrichContacts. Any member may edit. |
delete_alert | account | Free | Archive an alert for every member. Only the owner or team admin may call it (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. include: "contacts" adds what the alert's own lookups found, best contacts first. |
create_enrichment | leads | Plan dependent | Find email and phone for project ids. 1 credit per project the first time a County, State, or National account receives a contact channel. API Only includes contacts on purchased records; a live trial has a separate 5-lookup grant. 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 page at boardwalkai.com/exports, never the CSV bytes. |
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 | Plan dependent | Project details matching a filter set. On County, State, and National, each new or changed record counts toward 100,000 export records a month. Find Contact Info does not use credits on this call. Trial and API Only spend 1 credit per new or changed record. Review up to ~250 in chat; export the rest. |
get_projects_sync | leads | Plan dependent | Incremental feed of new or changed records. On County, State, and National, each new or changed record counts toward 100,000 export records a month. An unchanged record already delivered does not. Trial and API Only spend 1 credit per new or changed record. |
get_project | leads | Plan dependent | One record in detail. On County, State, and National, the first delivery counts as 1 export record; a later unchanged read does not. Trial and API Only spend 1 credit on first delivery. Email/phone stay withheld until Find Contact Info unlocks them. |
get_document | leads | Plan dependent | A source meeting document. On County, State, and National, the first delivery counts as 1 export record. Trial and API Only spend 1 credit on first delivery. |
ai_search_projects | leads | Plan dependent | Natural-language search. On County, State, and National, confirmed new or changed matches count toward 100,000 export records a month. Rejected candidates do not. Trial and API Only reserve 1 credit per requested record. |
run_alert | leads | Free | Trigger a real run now. Preview is free. A run that delivers a new or changed record counts toward the export cap. 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 | Plan dependent | The projects already on a named list. Extra filters stay inside those ids. On County, State, and National, each new or changed record counts toward the export cap. Trial and API Only spend 1 credit per new or changed record. |
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. New or changed rows count toward 100,000 export records a month. Find Contact Info on the file is 1 credit per project when email or phone is found, and 0 when nothing is found. |
Guardrails built into the tools
- Before a plan-dependent pull, use the free preflight named by the tool:
count_projects,get_list, orget_credit_balance. The public API enforces the plan gate and credit balance. - Paged record-returning tools require an explicit
limitbelow the API's own page ceiling. An omitted limit used to mean the maximum. - Before
run_alert, call the freepreview_alerttool, tell the user how many matches it found, and wait for an explicit yes. Manual runs are free and capped at three per America/Denver calendar day. 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.