Skip to main content
Glama

Server Details

US planned-project filings and building permits: alerts, lists, and exports.

Ownership verified
Status
Healthy
Uptime
100.0% over the last 24 hours
OAuth
Works in Glama
Last Tested
Transport
Streamable HTTP · MCP 2025-11-25
URL
ChatGPT
–
Claude
–

TDQS

A3.6/5.0

Scored across 59 tools

Disambiguation3/5

The set has a recognizable taxonomy (projects vs. permits; search vs. saved alert/list vs. sync vs. export), but many mirrored retrieval and metadata tools will look similar to an agent. Descriptions explicitly distinguish sources and billing, so overlap is manageable rather than chaotic, but boundaries are not clean.

Naming Consistency4/5

Almost all tools use snake_case verb_noun naming with consistent get/list/create/update/delete/search/count/analyze patterns. Minor asymmetries such as add_to_list vs. add_permits_to_list, remove_from_list vs. remove_permit_from_list, and list_user_lists keep it from perfect consistency.

Tool Count1/5

59 tools is far beyond a practical MCP surface; the planned-project and building-permit domains are mirrored almost one-for-one, and many specialized reads could be consolidated or dispatched through fewer tools. This is an extreme count mismatch for a connector.

Completeness4/5

Coverage is very broad: search, count, analyze, export, alerts, lists, enrichment, AI search, sync, metadata, preferences, and credits are all represented for both datasets. The main gaps are minor named-list lifecycle operations such as rename/delete and some cleanup operations.

Available Tools

59 tools
add_permits_to_listSave building permits onto a listA
Idempotent
Inspect

Saves building permit ids onto a list: Saved or a named list from create_list. A list holds planned projects and permits side by side. At most 100 ids per call; an id already on the list changes nothing. Returns added, alreadyOnList, and notFound. An alert's companion list does not take permits. Does not use credits.

Inputs: listId (required), permitIds (required).

add_to_listSave projects onto a listA
Idempotent
Inspect

Adds project ids to a membership list: Saved, an alert companion, or a named list from create_list. At most 100 ids per call. Repeating an id changes nothing. Does not use credits.

Inputs: listId (required), projectIds (required).

ai_search_projectsSearch projects in natural languageA
Destructive
Inspect

Submits a natural-language search job and returns the job id. get_ai_search_result returns project records when the job finishes. limit is how many records to find (max 25) and is the spend. get_projects with q covers map-style filters (place, type, acres, dates). This tool applies when the question depends on wording inside the minutes. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. Find Contact Info does not use credits on this call. On API Only and the trial, costs 1 credit per requested record. count_projects returns the structured count without records. notify.email=false skips the settlement email. Searches private leads by default. leadTypes (for example ["private","public"]) widens that set.

Inputs: limit (required), query (required), q, city, +16 more.

analyze_permitsGroup and measure building permitsA
Read-onlyIdempotent
Inspect

Counts and mix of matching building permits, grouped by up to three of: city, county, state, workType, workGroup, status, stage, constructionType, propertyType, valueBand, trade, sector, jobKind, appliedMonth, issuedMonth, or activityMonth. Metrics: count, sumJobValue, medianJobValue, avgJobValue, valueKnown, sumUnits, and contractors (how many distinct contractors). Value metrics come with valueKnown, the share of permits that state a value. filters take the search_permits names. Groups under five permits are omitted. Returns no permit records, names, or contacts. Does not use credits.

Inputs: limit, filters, groupBy, metrics, +2 more.

analyze_projectsGroup and measure projectsA
Read-onlyIdempotent
Inspect

Counts and mix for matching projects, grouped by up to three fields (city, county, state, building type, meetingMonth, and the others describe_data lists). Returns group keys and aggregates, not project names or contacts. Each metric includes a coverage fraction. Groups under five projects are omitted. Does not use credits.

Inputs: limit, dataset, filters, groupBy, +3 more.

count_permitsCount matching building permitsA
Read-onlyIdempotent
Inspect

How many building permits match a filter set, and what fetching them would use. Same filters as search_permits: q (permit text or number), contractor, Region, Work type, Status, Why now, Value, Date, Building type, Trades, and contact switches. Returns matchCount and the export-record or credit quote. Returns no permit records. The default is major and minor jobs with activity in the last 12 months; dateRange="all" counts every date. permitIds (at most 100) re-prices permits already in hand and must be the only filter. A place outside permit coverage is not covered yet, which is different from having no permits; get_permit_reference with facet="coverage" lists coverage. Does not use credits.

Inputs: q, ids, bbox, cities, +36 more.

count_projectsCount matching projectsA
Read-onlyIdempotent
Inspect

How many projects match a filter set, and what fetching them would use (export records on County, State, and National; credits on API Only and the trial). Same filters as get_projects, including q. Returns matchCount, the billable quote, and affordability.maxAffordableRecords. Returns no project records. A null or low matchCount is a filter miss. projectIds (alias ids, at most 100) re-prices an owned id set and is the only filter on this tool. dateRange="all" counts the whole corpus; the default is last_1_year. Does not use credits. Counts private leads by default. The same leadTypes value (for example ["private","public"]) keeps this count aligned with get_projects.

Inputs: q, ids, bbox, city, +84 more.

create_alertCreate an alertAInspect

Creates a recurring alert. Writing the alert does not use credits. Credits apply when a run delivers records. preview_alert returns the credit quote for the first run. Requires name and filters, the same fields as get_projects. Optional share block {mode, userIds, optOutUserIds}; sharing requires a paid plan. enrichContacts: true adds contact lookup on each run and costs 1 credit per project where a contact is found, on a paid plan or trial. Optional notify.emailTo (up to 5 extra addresses) and notify.webhookUrl save destinations outside this account. This call stores them and does not send. Delivers private leads by default. leadTypes inside filters (for example ["private","public"]) widens that set. Confirm with the user first: the name, the place, and the size floor.

Inputs: name (required), filters (required), share, active, +4 more.

create_enrichmentFind contact infoAInspect

Looks up email, phone, and personal LinkedIn profiles for project ids this account already has. Does not browse the web, send email, or write to LinkedIn. Returns a job receipt only — enrichmentJobId, status, accepted, and skipped. Contact values are not in this response. On County, State, and National plans, costs 1 credit per project the first time this account receives an email, phone, or personal LinkedIn profile. The maximum is held when the job is queued, and unused credits are released. Names and company links alone do not add a charge. On API Only, included for records already purchased; unpurchased ids return in skipped.notPurchased. Empty lookups do not add a charge. Already-unlocked ids return in skipped.alreadyEnriched. Large lists are split into batches; the result lists leftover ids to pass as projectIds on the next call. get_enrichment returns job status. Once it is done, get_projects with the same projectIds and include="contacts" returns the contact values. A fresh project can take several minutes. A live trial includes 5 lookups, separate from record credits. For building permits pass permitIds in place of projectIds (at most 1,000 per call): it researches the companies and contractors each permit names and the people at them, at 1 credit per permit the first time it adds an email, phone, or personal LinkedIn profile the permit did not already print. Homeowners are never looked up; a permit naming only one returns in skipped.nothingToLookUp. Once the job is done, reading the permit again shows what was found under researchedParties.

Inputs: permitIds, projectIds. Returns: status, message, enrichmentJobId

create_exportQueue a CSV exportAInspect

Queues a CSV of every matching project: a saved alert or list with optional in-set filters, a list of projectIds, or a new search. With alertId, listId, or projectIds, the status, entitlementStatus, requestTypes, and buildingStories filters are refused: a saved set cannot answer them. Every row has Latitude, Longitude, and Location Precision columns for loading into a map. The response is a receipt, never the CSV bytes. New or changed rows count toward 100,000 export records a month on County, State, and National, and cost 1 credit each on API Only and the trial; rows already delivered unchanged are not charged again. Find Contact Info does not use credits unless include="contacts". include="contacts" runs contact lookup and costs 1 credit per project when an email, phone, or personal LinkedIn profile is found. get_export returns status and the download page. count_projects returns the match count for a new search. Send them to https://boardwalkai.com/exports to download the file.

Inputs: q, ids, bbox, city, +83 more.

create_listCreate a named listBInspect

Creates a named membership list (a new list). Does not use credits. add_to_list adds project ids to it.

Inputs: name (required), description.

create_permit_alertCreate a building permit alertAInspect

Creates a recurring building permit alert. Requires name and filters, using the search_permits filter names (for example cities, workTypes, valueMin). cadence.frequency is daily, weekly, or monthly. Optional share block {mode, userIds, optOutUserIds}; sharing requires a paid plan. New matches arrive in the email digest. The same limits as planned-project alerts: filters must name a place (states, counties, or cities), with at most 5 states and 25 counties or cities, unless the plan is nationwide; and an account holds at most 25 active permit alerts (planned-project alerts are counted separately). permitIds, contractorKeys, placeKey, and bbox cannot be saved on an alert. A refusal names the rule (alert_geography_required, alert_geography_too_broad, or alert_limit_reached); relay it and offer to narrow the place or pause an alert. The alert follows the plan area. Writing the alert does not use credits. An alert created here is API-made, so its scheduled runs are charged: each new or changed permit a run adds counts as one export record, or 1 credit on API Only and the trial. Say so, with preview_permit_alert's count, before creating. This call does not send the digest. Confirm with the user first: the name, the place, the work types, and the value floor.

Inputs: name (required), filters (required), share, active, +2 more.

create_permit_exportQueue a building permit CSV exportAInspect

Queues a CSV of building permits from exactly one source: a saved permit alert (alertId, palr_…; alertScope picks not_dismissed (the default), pending, saved (kept), dismissed, or all), a list (listId), permitIds already in hand (at most 10,000), or a new filter set (at most 10,000 permits). Filters cannot be combined with an alert, list, or ids; to narrow one, pull its permits with the narrowing filters first and export those permitIds. Every row has Latitude, Longitude, and Location Precision columns for loading into a map. deliveryMode="new" leaves out permits already delivered, including ones already read in this chat. The response is a receipt with exportJobId, never the CSV bytes. Queuing does not use credits; new or changed rows count toward 100,000 export records a month on County, State, and National, and cost 1 credit each on API Only and the trial. Rows already delivered unchanged are not charged again. Permit contacts are in the file. count_permits returns the match count for a new filter set. get_export returns status, and the file downloads from https://boardwalkai.com/exports.

Inputs: q, ids, bbox, cities, +42 more.

delete_alertDelete an alertA
Destructive
Inspect

Deletes an alert for every member of a shared alert, not only the caller. The alert is archived: delivery history remains for billing, and no further runs, digests, or member reads occur. Only the owner or a team admin may delete; another member receives 403. Does not use credits. Not undoable on this surface. Confirm with the user first.

Inputs: alertId (required).

delete_permit_alertDelete a building permit alertA
Destructive
Inspect

Deletes a building permit alert for every member of a shared alert, not only the caller. Its matches and review decisions are removed. Only the owner may delete. Does not use credits. Confirm with the user first.

Inputs: alertId (required).

describe_dataDescribe the Boardwalk datasetA
Read-onlyIdempotent
Inspect

What this dataset can and cannot answer. Returns groupable fields (Building type, city, county, Construction Type), metrics, denominators, coverage, and a notAnswerable list (denial rates, time-to-entitlement, project value, affordability). Does not use credits. Returns no project records. Covers both datasets: planned projects (datasets.projects) and building permits (datasets.permits, with its own fields, metrics, coverage, and notAnswerable list). Searches return private leads by default. leadTypes (for example ["private","public"]) widens that set. Standard and full records carry leadType and stage; compact omits them.

Inputs: no named parameters.

dismiss_alert_projectDismiss a project from an alertA
Idempotent
Inspect

Dismisses one project from an alert so later digests and match reads omit it. A kept project also leaves the alert's list, and wasKept says so. On a shared alert the dismissal applies for every member, with the caller recorded as the actor. Repeating it changes nothing. Does not use credits.

Inputs: alertId (required), projectId (required).

get_ai_search_resultCollect an async AI searchA
Read-onlyIdempotent
Inspect

Status of an AI-search job from ai_search_projects. While queued or running, returns progress only. When complete, returns a page of project details. limit is required, with the same cap as get_projects. Records in a finished job were already counted toward the export cap when the job settled. Does not use credits. get_credit_balance returns the remaining balance. create_export queues a CSV of a large completed set.

Inputs: jobId (required), limit (required), offset.

get_alertGet one alertB
Read-onlyIdempotent
Inspect

One alert: alreadyOnThis, pendingReview, filters, cadence, and share roster. alreadyOnThis counts every match except dismissed, and pending review stays in that count. Does not use credits. get_alert_matches reads those projects.

Inputs: alertId (required).

get_alert_deliveriesList alert deliveriesA
Read-onlyIdempotent
Inspect

Past API runs of an alert, if any. Each row is an envelope (ids, counts, credit figures), not project records. An empty list does not mean the alert has no projects. get_alert_matches reads the projects on the alert. Supports limit, offset, and since. Does not use credits.

Inputs: alertId (required), limit, since, offset.

get_alert_matchesPull projects already on an alertA
Read-onlyIdempotent
Inspect

Project records already on an alert. The set is every match except dismissed, and pending review stays in. list_alerts supplies the alert id. Omitting deliveryId returns that current set. Extra filters such as acreageMin, projectSizes, and propertyTypes apply inside those existing ids. status, entitlementStatus, requestTypes, and buildingStories filters are not available on a saved set; they belong on get_projects. limit is required. On an alert with enrichContacts, include="contacts" adds the emails and phones its runs found. Does not use credits. create_export with this alertId queues a CSV of the same set.

Inputs: limit (required), alertId (required), q, ids, +79 more.

get_credit_balanceGet credit balanceA
Read-onlyIdempotent
Inspect

The plan and what is left on it; howToRead says it in one plain sentence, so quote that. On County, State, and National, exportCredits is the record allowance: 100,000 export records a month for the team, owned by the plan holder and shared by the website, CSV downloads, the API, and this connector, used by each new or changed planned project or permit. creditsRemaining is the separate Find Contact Info allowance, not records, here and in search results. On API Only and the trial, creditsRemaining is the record credits (the trial has 50 in total, planned projects and permits together, and they do not reset). Does not use credits.

Inputs: no named parameters.

get_documentGet a source documentA
Read-onlyIdempotent
Inspect

The source meeting document for a document id from get_project with representation="full". Long filings consume model context and may be truncated; the response says when that happened. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. Find Contact Info does not use credits on this call. On API Only and the trial, costs 1 credit per document. get_credit_balance returns the remaining balance.

Inputs: documentId (required).

get_enrichmentPoll an enrichment jobA
Read-onlyIdempotent
Inspect

Status of an enrichment job: processed, found, and pending counts, plus contactBilling (reserved, charged, released, qualifyingProjects). Polling does not use credits. notAttempted lists ids a completed job did not try because of the per-request ceiling. The contact values are not in this response: when the job is done, get_projects with the same projectIds and include="contacts" returns them.

Inputs: enrichmentJobId (required).

get_exportPoll a CSV export jobA
Read-onlyIdempotent
Inspect

Status of one export job this account already queued. When the file is ready, returns downloadUrl and webExportsUrl (https://boardwalkai.com/exports). Does not return the CSV and does not write a file. Send the user to webExportsUrl to download it. Does not use credits. Works for planned-project and building permit exports alike (dataset says which).

Inputs: exportJobId (required). Returns: status, message, downloadUrl, exportJobId, +1 more

get_listGet one saved listA
Read-onlyIdempotent
Inspect

One named list: alreadyOnThis, pendingReview, source, and share roster. Does not use credits. An alert companion is the same match set as that alert (every match except dismissed; pending review stays in). A filter or polygon list with no saved records is a saved search. get_list_results reads the planned projects on this list, and get_list_permits reads its building permits.

Inputs: listId (required).

get_list_permitsGet building permits saved on a listA
Read-onlyIdempotent
Inspect

Building permits already saved on a named list. get_list returns the list and its permitCount before this read. Extra filters such as workTypes, statuses, and valueMin apply inside those existing permits. limit is required. Each new or changed permit counts toward 100,000 export records a month on County, State, and National plans. On API Only and the trial, costs 1 credit per new or changed permit. An unchanged permit already delivered does not use credits. create_permit_export with this listId queues a CSV of the same set. contactWithheld on a private individual means the phone or email exists but is withheld: "upgrade" (homeowner phones and emails need a paid plan, and the user's plan does not include them) or "acknowledge" (the user accepts the homeowner contact rules once in the Boardwalk web app). It is never missing. "[phone withheld]" and "[email withheld]" in titles, summaries, or notes (textContactWithheld) are the same rule and can hide business lines too. Name every party; mention withholding only for a party that carries contactWithheld.

Inputs: limit (required), listId (required), q, ids, +40 more.

get_list_resultsGet a saved list's recordsA
Read-onlyIdempotent
Inspect

Project records already on a named list. get_list returns the list before this read. Alert companions return the same ids as get_alert_matches (every match except dismissed, pending review included). Saved and other manual lists return saved members. Does not use credits from the Find Contact Info allowance. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. On API Only and the trial, costs 1 credit per new or changed record. Extra filters such as acreageMin and propertyTypes apply inside those existing ids. status, entitlementStatus, requestTypes, and buildingStories filters are not available on a saved set; they belong on get_projects. limit is required. create_export with this listId queues a CSV of the same set. A filter or polygon list has no saved records. Saved members are private leads by default. leadTypes (for example ["private","public"]) includes the public or minor ones they saved. acreageMin and propertyTypes still apply inside those existing ids.

Inputs: limit (required), listId (required), q, ids, +78 more.

get_locationGet one location by idA
Read-onlyIdempotent
Inspect

One state, county, or city by numeric id from list_locations. Does not use credits.

Inputs: id (required), kind (required).

get_permitGet one building permitA
Read-onlyIdempotent
Inspect

One building permit by permitId. representation="standard" (the default) has every party named on the permit with the phones and emails it printed, the inspections summary, value, size, and building type. "compact" is the short card. "full" adds the history, every inspection, fees, property owners, and plannedProjectId when the permit is linked to a planned project. includeSourceText=true also returns the text the permit was read from (it implies full; long text is cut and the response says so). Counts as one export record on County, State, and National, or 1 credit on API Only and the trial, the first time this account receives this permit's current content. The source text counts with the permit record: 1 export record (or credit) per new or changed permit across both, and nothing more if the account already has it. A permit with no source text on file returns without it, with a note, and nothing extra is charged. Re-reading an unchanged permit does not use credits. detailLevel "summary" means Boardwalk has only the city's list entry for this permit, so the contractor or value may be on the city's own page (sourceUrl). A private individual's phone or email can be withheld (contactWithheld). withheld "upgrade" means homeowner phones and emails need a paid plan, and the user's plan does not include them; "acknowledge" means the user has to accept the homeowner contact rules once in the Boardwalk web app, and then they show. hasPhone and hasEmail say which exists. When anything on a permit is withheld, every phone and email in its source text and its written text (descriptions, summaries, titles, notes, inspections, history; counted in textContactWithheld) shows as "[phone withheld]" or "[email withheld]", business lines included; quote business phones and emails from the permit's parties instead. Name every party the result returns; mention withholding only for a party that carries contactWithheld. The contact exists: never call it missing or not on the permit, and never guess a number. get_credit_balance returns the remaining balance.

Inputs: permitId (required), representation, includeSourceText.

get_permit_alert_deliveriesList building permit alert runsA
Read-onlyIdempotent
Inspect

Past runs of a building permit alert that found new permits, newest first. Each row is a run summary: its id, its date, and how many permits it added. get_permit_alert_matches reads the permits themselves. Supports limit, offset, since, and before (pdlv_ run ids). Does not use credits.

Inputs: alertId (required), limit, since, before, +1 more.

get_permit_alert_matchesPull building permits already on an alertA
Read-onlyIdempotent
Inspect

Building permits already on a permit alert, by scope: pending (not reviewed yet), saved (kept), dismissed, or all. list_permit_alerts supplies the palr_ id. Extra filters such as valueMin, workTypes, and statuses are applied within the alert's permits only, never as a new search; dates default to all. permitIds and sort are not accepted. limit is required. A page can come back short while meta.hasMore is true (each call checks at most 5,000 of the alert's permits): pass meta.nextCursor as cursor until hasMore is false before saying how many match. Each row carries decision and firstMatchedAt. Each new or changed permit counts toward 100,000 export records a month on County, State, and National plans. On API Only and the trial, costs 1 credit per new or changed permit. An unchanged permit already delivered does not use credits, including one a run of this alert already charged for. create_permit_export with this alertId queues a CSV of the same set. contactWithheld on a private individual means the phone or email exists but is withheld: "upgrade" (homeowner phones and emails need a paid plan, and the user's plan does not include them) or "acknowledge" (the user accepts the homeowner contact rules once in the Boardwalk web app). It is never missing. "[phone withheld]" and "[email withheld]" in titles, summaries, or notes (textContactWithheld) are the same rule and can hide business lines too. Name every party; mention withholding only for a party that carries contactWithheld.

Inputs: limit (required), alertId (required), q, bbox, +38 more.

get_permit_referenceGet building permit filter values and coverageA
Read-onlyIdempotent
Inspect

Building permit filter values with labels: work types and their groups, statuses and stages, why-now codes, trades, construction types, building types (the same labels as get_project_types), value bands, sorts, date fields, and date ranges. facet narrows it to one block. facet="coverage" lists the states, counties, and cities that have permits, each with a permit count and entitled (whether this account's plan covers it). Building permits start with Utah, and more areas are being added through the end of 2026. Does not use credits.

Inputs: facet.

get_permits_syncSync new or changed building permitsA
Read-onlyIdempotent
Inspect

Building permits that are new to this account or changed since the last delivery. limit is required. The cursor from the previous page continues the walk; updatedSince (ISO 8601) starts it at a time; with neither, the walk is full. Send one of cursor or updatedSince, not both. sort, offset, and permitIds are not accepted. Otherwise the same filters as search_permits; changing them starts a new walk. Each new or changed permit counts toward 100,000 export records a month on County, State, and National plans. On API Only and the trial, costs 1 credit per new or changed permit. An unchanged permit already delivered does not use credits. A permit that leaves Boardwalk stops appearing and get_permit returns 404 for it. get_credit_balance returns the remaining balance. contactWithheld on a private individual means the phone or email exists but is withheld: "upgrade" (homeowner phones and emails need a paid plan, and the user's plan does not include them) or "acknowledge" (the user accepts the homeowner contact rules once in the Boardwalk web app). It is never missing. "[phone withheld]" and "[email withheld]" in titles, summaries, or notes (textContactWithheld) are the same rule and can hide business lines too. Name every party; mention withholding only for a party that carries contactWithheld.

Inputs: limit (required), q, ids, bbox, +39 more.

get_preferencesGet search preferencesA
Read-onlyIdempotent
Inspect

Saved search preferences for the connected account: types, geography, and an optional website. firstRunCompleted is false until those are saved. inheritedFromTeam is true when the blob comes from a teammate. Does not use credits.

Inputs: no named parameters.

get_projectGet one project recordA
Read-onlyIdempotent
Inspect

One project. representation="standard" is the default (headline, summary, parties, size, without minutes). representation="full" includes the filing text and document ids. Does not use credits from the Find Contact Info allowance. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. On API Only and the trial, costs 1 credit the first time this account receives the record. Email, phone, and personal LinkedIn come only from create_enrichment, which searches for them and may find none. A thin record is an early agenda item. get_credit_balance returns the remaining balance.

Inputs: projectId (required), representation.

get_projectsGet matching project recordsA
Read-onlyIdempotent
Inspect

Project records matching a filter set: name, headline, summary, status, place, parties without emails, and size. Address, city, county, countyFips, state, and postalCode are separate fields. Each record carries latitude and longitude when the project is mapped; locationPrecision says how exact the point is (address or parcel is the site, city or county is the centre of that place). Same filters as the Boardwalk map and as count_projects, including q. limit is required (max 25). A review past 250 records is past one chat page; create_export queues a CSV of the full match set. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. Find Contact Info does not use credits on this call. On API Only and the trial, costs 1 credit per new or changed record. Absent fields were not in the filing. get_project reads one id, including filing text. dateRange="all" searches the whole corpus; the default is last_1_year. count_projects returns the same count without records. Returns private leads by default, same as the map. leadTypes (["private","public"] for public-sector projects; "private_minor" or "public_minor" for small jobs) widens that set. Ground-up versus renovation is constructionTypes. Standard and full records carry leadType and stage; compact omits them.

Inputs: limit (required), q, ids, bbox, +83 more.

get_projects_syncSync new or changed recordsA
Read-onlyIdempotent
Inspect

Projects that are new to this account or changed since the last delivery. limit is required. The cursor from the previous page continues the walk; omitting it starts a full walk, last-updated ascending. sort, order, and offset are not accepted. Unchanged owned records do not add a charge. Each new or changed record counts toward 100,000 export records a month on County, State, and National plans. An unchanged record already delivered does not. Find Contact Info does not use credits on this call. On API Only and the trial, costs 1 credit per new or changed record. get_credit_balance returns the remaining balance. Walks private leads by default. leadTypes (for example ["private","public"]) widens it, and changing that value starts a new walk.

Inputs: limit (required), q, ids, bbox, +83 more.

get_project_typesGet project typesA
Read-onlyIdempotent
Inspect

The building type tree from the map's Building type filter: Residential, Commercial, Industrial, Institutional/Public, Mixed Use, Infrastructure, Agricultural. The second level is more specific; the third is the class (Apartment Building, Gas Stations). propertyTypes, propertySubtypes, and assetClasses take these labels. Land and zoning (rezones, plats, annexations with no building yet) is not in this list; records carry it as their type. facet="actionTypes" returns action-type labels for reading records; they are not requestTypes filter values (get_reference with facet="requestTypes" lists those, and facet="entitlementStatus" lists who decided and the statuses). Does not use credits.

Inputs: facet.

get_referenceList filter vocabulariesA
Read-onlyIdempotent
Inspect

Canonical tokens for the status, entitlementStatus, and requestTypes filters. facet is required: "statuses", "entitlementStatus" (the body groups and statuses that make a "council:approved" style pair), or "requestTypes" (the 15 application types, each with its early, middle, or late stage). Does not use credits.

Inputs: facet (required).

list_alertsList alert rulesA
Read-onlyIdempotent
Inspect

Named alerts on this account. Each row has name, id, alreadyOnThis (every match except dismissed, including pending review), pendingReview, and filters (a place list longer than 25 is summarised in placesSummary; get_alert has the full filters). Does not use credits. get_alert_matches reads the projects on one alert. Supports limit and offset.

Inputs: limit, offset.

list_exportsList CSV export jobsA
Read-onlyIdempotent
Inspect

Export jobs for the team, the same list as https://boardwalkai.com/exports. Does not use credits. get_export returns one job's status and download page. Lists planned-project and building permit exports; dataset on each row says which.

Inputs: limit.

list_locationsList states, counties and citiesA
Read-onlyIdempotent
Inspect

States, counties, and cities, with the numeric ids search filters accept. level is "state", "county" (with stateId), or "city" (with stateId and countyId). Names and abbreviations are also accepted on search filters. Does not use credits.

Inputs: level, stateId, countyId.

list_permit_alertsList building permit alertsA
Read-onlyIdempotent
Inspect

Building permit alerts on this account (ids start with "palr_"). Planned-project alerts are separate and list_alerts returns them. Each row has name, filters, cadence, sharing, and how many matches are pending review and kept. alertId returns one alert. get_permit_alert_matches reads the permits on an alert. Supports limit and offset. Does not use credits.

Inputs: limit, offset, alertId.

list_user_listsList saved listsB
Read-onlyIdempotent
Inspect

Named lists on this account, including Saved (isDefault=true) and lists the team shares. Each row has name, alreadyOnThis or projectCount, and source. An alert and its companion list are the same match set: every match except dismissed, pending review included. Does not use credits. get_list_results reads the projects on one list.

Inputs: limit, offset.

preview_alertPrice an alert runA
Read-onlyIdempotent
Inspect

Quote for an alert's next run, without running it. Uses the filters get_alert returns, including website-created map criteria. Returns matchCount, creditsRequired (export records on County, State, and National; credits on API Only and the trial), alreadyDeliveredUnchanged, and maxRecordsPerRun. Records this account already holds unchanged are not charged. Does not use credits.

Inputs: alertId (required).

preview_permit_alertPreview a building permit alertA
Read-onlyIdempotent
Inspect

What a building permit alert matches now, without running it: matchCount, newSinceLastRun, and maxPerRun (1,000). Does not use credits.

Inputs: alertId (required).

remove_from_listRemove a project from a listA
DestructiveIdempotent
Inspect

Removes one project from a membership list, including merge-family rows. Does not use credits.

Inputs: listId (required), projectId (required).

remove_permit_from_listRemove a building permit from a listA
DestructiveIdempotent
Inspect

Removes one building permit from a list. Removing a permit that is not on the list changes nothing. Does not use credits.

Inputs: listId (required), permitId (required).

run_alertRun an alert nowA
Destructive
Inspect

Starts an alert run now. It emails the digest to members and to any saved extra addresses, and POSTs a saved webhook. Those sends cannot be unsent. Does not use credits to start; the run charges when it delivers records. preview_alert returns the match count and credit quote for that run. get_alert_matches reads projects already on the alert. A repeat in the same window returns already_running and adds no charge. Manual runs are capped at 3 per America/Denver calendar day.

Inputs: alertId (required).

run_permit_alertRun a building permit alert nowA
Destructive
Inspect

Runs a building permit alert now and emails the digest of new matches to its members. That email cannot be unsent. Does not use credits to start; the run is charged when it adds permits: each new or changed permit counts as one export record on County, State, and National, or 1 credit on API Only and the trial, whoever created the alert. Short of allowance, the run is refused whole with a quote and charges nothing. preview_permit_alert returns newSinceLastRun, the number the run would add; state that cost and run only after the user agrees. get_permit_alert_matches reads permits already on the alert, which is how to pull an alert; a permit this run charged for is not charged again there while it is unchanged. Manual runs are capped at 3 per day.

Inputs: alertId (required).

search_permit_contractorsFind contractors from building permitsA
Read-onlyIdempotent
Inspect

Contractors rolled up from matching building permits: name, how many permits in the set, total stated job value, latest activity, cities, top work types, and the phone, email, website, and license printed on their permits. Same filters as search_permits; sort is permits (default), value, or recent. Companies only; private owner-builders are left out. contractorKey on each row is the contractorKeys filter for search_permits, which returns every permit by that contractor. analyze_permits with metric "contractors" returns how many contractors match. limit is required. Each contractor new to the account counts as one export record on County, State, and National, or 1 credit on API Only and the trial. A contractor already delivered does not use credits again, whatever the filters.

Inputs: limit (required), q, ids, bbox, +40 more.

search_permitsSearch building permitsA
Read-onlyIdempotent
Inspect

Building permit records matching a filter set: permit number, title, work type, status and stage, address, lat and lng with locationPrecision ("city" means the city centre, not the job site), job value, dates, latest activity, contractor, and the best contact with the phone and email printed on the permit. Same filters as count_permits, which returns the same count without records. limit is required (max 25). A review past 250 permits is past one chat page; create_permit_export queues a CSV of the full set. Each new or changed permit counts toward 100,000 export records a month on County, State, and National plans. On API Only and the trial, costs 1 credit per new or changed permit. An unchanged permit already delivered does not use credits. Contacts are part of the permit record. Absent fields were not in the record Boardwalk could read from the city or county. A private individual's phone or email can be withheld (contactWithheld). withheld "upgrade" means homeowner phones and emails need a paid plan, and the user's plan does not include them; "acknowledge" means the user has to accept the homeowner contact rules once in the Boardwalk web app, and then they show. hasPhone and hasEmail say which exists. When anything on a permit is withheld, every phone and email in its source text and its written text (descriptions, summaries, titles, notes, inspections, history; counted in textContactWithheld) shows as "[phone withheld]" or "[email withheld]", business lines included; quote business phones and emails from the permit's parties instead. Name every party the result returns; mention withholding only for a party that carries contactWithheld. The contact exists: never call it missing or not on the permit, and never guess a number. get_permit reads one permit in full. placeKey returns every permit at one address; after an address search, search again with the best hit's placeKey and dateRange "all", because cities write one address several ways. contractorKeys (from search_permit_contractors) returns every permit by a contractor.

Inputs: limit (required), q, ids, bbox, +41 more.

set_permit_alert_decisionKeep or dismiss a permit on an alertA
Idempotent
Inspect

Marks one building permit on a permit alert as kept (saved), dismissed, or pending (back to review). Decisions are per person: a teammate on a shared alert keeps their own. Repeating it changes nothing. Does not use credits.

Inputs: alertId (required), decision (required), permitId (required).

undismiss_alert_projectUndo a dismissalA
Idempotent
Inspect

Removes a dismissal and returns the project to review for every member of a shared alert. Repeating it changes nothing. Does not use credits.

Inputs: alertId (required), projectId (required).

update_alertUpdate an alertA
DestructiveIdempotent
Inspect

Updates an alert by public id. Only the fields passed are changed, and each one overwrites the previous setting for every member of a shared alert. Does not use credits. Same fields as create_alert, including the share block {mode, userIds, optOutUserIds}. Any member of a shared alert may edit it. enrichContacts true or false turns contact lookup on or off for future runs (1 credit per project where a contact is found, on a paid plan or trial). Optional notify.emailTo (up to 5 extra addresses) and notify.webhookUrl save destinations outside this account. This call stores them and does not send. filters.leadTypes (for example ["private","public"]) widens an alert past private leads. Confirm with the user first.

Inputs: alertId (required), name, share, active, +5 more.

update_permit_alertUpdate a building permit alertA
DestructiveIdempotent
Inspect

Updates a building permit alert by its palr_ id. Only the fields passed change, and each one overwrites the previous setting for every member of a shared alert. Same fields and the same place rules as create_permit_alert; active:true turns a paused alert back on. Does not use credits. Editing the filters here makes the alert API-made, so its scheduled runs are charged from then on: each new or changed permit a run adds counts as one export record, or 1 credit on API Only and the trial. Say so before changing filters. Confirm with the user first.

Inputs: alertId (required), name, share, active, +3 more.

update_preferencesUpdate search preferencesA
DestructiveIdempotent
Inspect

Saves the caller's search preferences on their Boardwalk account. Only the fields passed are changed, and each one replaces the previous value on the caller's own row, even when get_preferences returned a teammate's blob. firstRunCompleted=true marks the short first-run complete. Does not use credits.

Inputs: notes, website, geography, lookingFor, +2 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables agents and sales teams to surface US restaurants and bars roughly one to six months before they open, ranked by a readiness score and paired with owner contact details drawn from public liquor-license, permit, and business filings. It also exposes live coverage checks, the raw fused filings behind each venue, and webhook alerts when a new matching venue appears.
      MIT
    • F
      license
      A
      quality
      B
      maintenance
      Enables construction permitting teams to analyze portfolios of active permits by ranking risk, detecting day-over-day changes, identifying systemic bottlenecks, and generating daily executive action plans. Also supports single-permit readiness audits, missing-document reports, blocker explanations, resubmission checklists, and semantic search over municipal requirements.
      7
      1
      -
    • A
      license
      Not graded
      quality
      C
      maintenance
      Enables AI assistants to search permit coverage, count matching building permits, and retrieve clean permit rows with property and contractor details, including free initial results and paid per-row access.
      29 PyPI
      MIT
    Try in Browser

    Glama MCP Gateway

    Add one secure layer between your agents and this server.

    Resources