A domain-level reference for the EQUIRE AI assistant tools, grouped by availability, mode, and approval behavior.
This page is the human-facing reference for the tools the chat assistant can call on your behalf. Each tool is one capability: a query, a calculation, or a mutation. The assistant chooses tools based on your message, the active chat mode, and the web-toggle categories you have enabled. Source code remains the canonical runtime inventory.
For implementers: tool factories live under src/lib/ai/tools/ (see src/lib/ai/tools/README.md and CLAUDE.md). AI SDK tool/stream APIs — use vercel:ai-sdk and AI SDK 7 docs, not this page.
- Modes — which chat surfaces expose this tool. Deal is per-deal chat, Portfolio is the org-level chat at
/deals and similar, Prospecting is the chat in mandate workspaces.
- Type — Read tools fetch information; Write tools mutate deal, prospect, or task state.
- Approval — a checkmark means the write is governed. Depending on your organization's approved autonomy policy, EQUIRE either prompts Allow / Deny or executes an eligible routine write under that policy. Structural capital-stack and base/scenario scalar changes remain attended.
For mode behavior and toggle defaults, see Chat modes. For who governs each tool's data and provenance, see Trust and safety.
| Tool | Description | Modes | Type | Approval |
|---|
getDealData | Read deal overview, property, tenants, financials, environmental, appraisal, pricing, financing | Deal, Portfolio | Read | — |
updatePropertyInfo | Modify property name, address, city, state, type, square footage, year built | Deal | Write | ✓ |
updateField | Update any deal schema field; resolves single conflicts and dated fields | Deal | Write | ✓ |
addTenant | Create a new rent roll tenant record | Deal | Write | ✓ |
deleteTenant | Remove a tenant from the rent roll | Deal | Write | ✓ |
deleteSuiteInventory | Remove duplicate or incorrect suite inventory / vacancy schedule records | Deal | Write | ✓ |
addOperatingStatement | Append a T-12 or custom operating statement to financials | Deal | Write | ✓ |
getDealActivityLog | Fetch the deal audit log with timestamps, actions, user attribution | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
searchDocuments | Search processed documents in the current deal; supports @-mention scoping | Deal | Read | — |
listDocuments | List uploaded documents with metadata, type, status, extraction status | Deal | Read | — |
reprocessDocument | Trigger re-extraction and verification on a document | Deal | Write | ✓ |
deleteDocument | Remove a document from the deal | Deal | Write | ✓ |
markDocumentsReviewed | Clear the needs-review flag on documents | Deal | Write | ✓ |
getReviewQueue | Read the canonical Review tab queue: release blockers, ranked decisions, document summaries, and both sides of every open data conflict with the document each came from | Deal | Read | — |
getConflicts | List every open extraction conflict, including the ones the release gate does not block on and the Review queue therefore leaves out | Deal | Read | — |
actOnReviewItem | Apply one approved decision to up to 25 Review items at once, including resolving a data conflict | Deal | Write | ✓ |
resolveAllConflicts | Apply one strategy across every open conflict in a deal | Deal | Write | ✓ |
autoResolveReviewQueue | Clear the queue items this deal's own documents already settle, and report the rest as open decisions | Deal | Write | ✓ |
generateReviewBriefing | Generate or retrieve the AI review briefing and its recommended actions. It saves the briefing but changes no deal data, so it does not ask for approval | Deal | Write | — |
stageReviewBatch | Stage the briefing's recommended actions as a batch and return a deep link. The batch is never applied until you approve it on the Review tab, whatever your organization's autonomy level | Deal | Write | — |
getOpenFindings | List validation findings — arithmetic, consistency, missing fields | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
getValuation | Fetch the built DCF model with scenarios, assumptions, and outputs (value, IRR, MoIC, cash flows) | Deal | Read | — |
previewScenarioAssumption | Preview one exact Upside or Downside assumption change, including before/after returns and the current evidence basis, without writing | Deal | Read | — |
analyzeValuation | Explain scoped assumption and deviation diagnostics from the saved model | Deal | Read | — |
sensitivityAnalysis | Sweep one to eight supported assumptions one at a time and rank their IRR and equity-multiple impact | Deal | Read | — |
runLeaseIntelligence | Preview lease obligations and their modeled valuation impact | Deal | Read | — |
getLeaseObligationAudit | Read the lease-obligation change audit | Deal | Read | — |
updateAssumption | Modify a base-case scalar assumption; OpEx fields and structural financing use their dedicated tools | Deal | Write | ✓ |
updateScenarioAssumption | Apply the exact Upside or Downside request returned by the preview tool | Deal | Write | ✓ |
updateTenantAssumption | Modify tenant-level renewal, downtime, landlord work, TI, or blowout assumptions | Deal | Write | ✓ |
updateOpex | Update the active blended or line-item operating-expense model | Deal | Write | ✓ |
updateValuationParams | Modify model parameters such as purchase price and square footage | Deal | Write | ✓ |
sizeDebt | Size senior debt against supplied lender constraints and report the binding constraint and Sources & Uses tie-out | Deal | Write | ✓ |
sizeMezz | Size subordinate debt after senior debt against supplied whole-loan constraints | Deal | Write | ✓ |
applyLeaseIntelligencePackage | Apply reviewed lease obligations to the valuation model | Deal | Write | ✓ |
updateCapitalStack | Update structured financing: all-cash, senior debt, bridge/construction future funding, senior + mezzanine, senior + preferred equity, or custom multi-layer stacks | Deal | Write | ✓ |
exportValuationExcel | Prepare a formula-workbook download or an explicit static snapshot; formula requests run model preflight at download and refuse unsupported structures | Deal | Read | — |
Valuation assumption reads include the exact numeric value, unit, source state, confidence, derivation, and evidence availability. A value may be backed by document or market evidence, a user judgment, an approval-anchored assistant judgment, or an unavailable evidence state; the assistant must preserve that distinction when explaining or changing it.
Available only on the Deal Overview tab when deal chat page context matches Overview. These tools manage saved custom dashboard widgets on the Overview canvas (read-only JSON Render panels grounded in live deal state).
| Tool | Description | Modes | Type | Approval |
|---|
listJsonRenderDashboards | List saved custom dashboard widgets with ids and titles | Deal (Overview only) | Read | — |
createJsonRenderDashboard | Create and save a custom dashboard, chart, panel, or visualization from an explicit creation prompt or the Overview dashboard button | Deal (Overview only) | Write | — |
editJsonRenderDashboard | Edit, rebuild, or regenerate an existing saved widget by widgetId from an explicit edit prompt | Deal (Overview only) | Write | — |
createJsonRenderDashboard and editJsonRenderDashboard persist immediately after an explicit user request (or the visible Overview dashboard affordance for creation). They do not show Allow / Deny approval prompts. Factual or analytical questions must no-op and stay on read-only deal tools. Lease rollover plus DSCR timeline requests use the deterministic system-lease-rollover-dscr template (RolloverDscrTimeline).
The tables below list the market tools registered on each chat surface. Deal, Portfolio, and Prospecting chat use the Market data setting to control their market-data group. The Listings assistant registers market reads independently of that client setting; Web Search and Academic Research remain controlled by their own settings. Deal chat deliberately omits the aggregate getCREMarket metro index while retaining separately based CRE trends, comps, operating fundamentals, REIT transactions, and CBRE survey reads alongside the deal's Market Research ledger.
- The economic and demographic tools (
getMarketData, compareMarkets, searchMarkets, getMarketTrends, getNationalMacro, getMetricDefinitions) retrieve market profiles, comparisons, historical series, and metric definitions. Available metrics and source/publisher details come from the live definition lookup; each market result reports its own coverage and observation dates.
- Commercial real-estate evidence comes through distinct tools:
getCREMarket returns all-vintage CMBS medians, asking-side listing measures, and a separate CBRE survey range; getCRETrend and getCREComps read yearly trends and property comparables; getCREOperatingFundamentals and getREITTransactionCaps read REIT disclosures; getCBRECapRateSurvey reads CBRE survey data. These bases remain distinct.
All values are precomputed and read-only. For commercial figures the assistant reports the underlying sample size and the basis behind each figure. It does not blend closed securitized transactions and broker asking quotes into a single median, because the mix behind such a figure is unpublished. Residential (Zillow/HUD) data stays separate from commercial rents. See CRE market evidence.
| Tool | Description | Modes | Type | Approval |
|---|
getMarketData | Economic and demographic profile for a US metro, with available metrics, a narrative, peer metros, and a composite score | Deal, Portfolio, Prospecting, Listings | Read | — |
compareMarkets | Side-by-side comparison of metrics across two or more metros | Deal, Portfolio, Prospecting, Listings | Read | — |
searchMarkets | Search and rank metro-index records by metric, region, state, or market tier; available results follow current source coverage | Deal, Portfolio, Prospecting, Listings | Read | — |
getNationalMacro | US macro context — GDP, CPI, Treasury yields, 30-year mortgage rate, Fed Funds rate | Deal, Portfolio, Prospecting, Listings | Read | — |
getMarketTrends | Historical time series for a metro from supported sources; available series vary by metric and source | Deal, Portfolio, Prospecting, Listings | Read | — |
getMetricDefinitions | Glossary of market data fields and calculation methods | Deal, Portfolio, Prospecting, Listings | Read | — |
getCREMarket | Metro/property-type rows with all-vintage CMBS medians, asking-side listing measures, and a separate CBRE survey range. Pooled CMBS-plus-listing distributions are withheld. Withdrawn from Deal mode, where Market research is the deal's market ledger | Portfolio, Prospecting, Listings | Read | — |
getCRETrend | Year-by-year history of a CRE metric for a metro (for example, how office cap rates moved from 2015 to 2025) | Deal, Portfolio, Prospecting, Listings | Read | — |
getCREComps | Individual securitized-property (CMBS) comparables behind a market's aggregates | Deal, Portfolio, Prospecting, Listings | Read | — |
searchPapers | Query academic papers (OpenAlex) on CRE, markets, and asset performance | Deal, Portfolio, Prospecting, Listings | Read | — |
getCREOperatingFundamentals | Latest-quarter REIT same-store operating fundamentals by metro and property type, with optional quarterly history | Deal, Portfolio, Prospecting, Listings | Read | — |
getREITTransactionCaps | National-by-sector REIT acquisition and disposition cap rates, with optional quarterly history | Deal, Portfolio, Prospecting, Listings | Read | — |
getCBRECapRateSurvey | CBRE Class A stabilized cap-rate survey range for a metro/property type, with optional half-year history | Deal, Portfolio, Prospecting, Listings | Read | — |
searchIndexedListings | Search EQUIRE's indexed listing inventory with asking-side economics and source information; distinguishes a genuine no-match from an unavailable inventory read | Deal, Portfolio, Prospecting, Listings | Read | — |
getResearchSources | List research sources linked to the deal | Deal | Read | — |
getResearchBenchmarks | Externally sourced benchmarks — rents, cap rates, occupancy by asset class and market | Deal | Read | — |
getMarketNarrative | Synthesized narrative of market conditions from collected research | Deal | Read | — |
getEconomicConditions | Economic context relevant to the deal — labor, construction costs, credit availability | Deal | Read | — |
searchMarketReports | Retrieve market reports (broker reports, research, local intel) for a property or market | Deal | Read | — |
searchBusinessContext | Find business context — tenant background, competitive landscape, regulatory | Deal | Read | — |
analyzeMarketReports | Synthesize insights from collected research and market reports | Deal | Read | — |
generateMarketNarrative | Generate a cohesive market narrative for IC memo or deliverable inclusion | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
findComps | Search for comparable sales and active listings near the subject property | Deal | Read | — |
Comps are intentionally restricted to deal mode because they are property-level. The comps toggle is hidden in portfolio and prospecting chat.
| Tool | Description | Modes | Type | Approval |
|---|
getHealthSummary | Overall deal-health score, severity counts, category breakdown, last-analyzed timestamp | Deal | Read | — |
getHealthIssues | List health issues with filters (severity, type, status, category, search) | Deal | Read | — |
getHealthIssue | Fetch details of a single health issue | Deal | Read | — |
createHealthIssue | Create a new health issue for manual problem tracking | Deal | Write | — |
updateHealthIssue | Modify health issue status, severity, owner, or notes | Deal | Write | — |
resolveHealthIssue | Mark a health issue resolved | Deal | Write | — |
runHealthAnalysis | Trigger a deep health scan (validators, data quality, consistency) | Deal | Write | — |
| Tool | Description | Modes | Type | Approval |
|---|
listAllDeals | List all portfolio deals with status filters and metrics | Portfolio | Read | — |
getDealSummary | Deep summary of a single deal — property, tenants, documents, valuation status | Portfolio | Read | — |
compareDealMetrics | Side-by-side comparison of financial and operational metrics across deals | Deal, Portfolio | Read | — |
searchAcrossDeals | Full-text search across all deals — documents, memos, issues | Deal, Portfolio | Read | — |
getPipelineAnalytics | Portfolio-wide pipeline insights — deal counts by stage, average metrics, funnel throughput | Portfolio | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
listMandates | List active search mandates with criteria and funnel counts | Prospecting | Read | — |
searchProspects | Query prospects against active mandates with readiness and ownership filters | Prospecting | Read | — |
getProspectBrief | Fetch a prospect summary — property, listing data, ownership signals, readiness score | Prospecting | Read | — |
listProspectSources | List data sources attached to a prospect | Prospecting | Read | — |
compareProspects | Compare readiness, metrics, and mandate fit across prospects | Prospecting | Read | — |
searchMandateMarkets | Find prospects across all mandates in specified markets | Prospecting | Read | — |
getMandateHealth | Mandate performance — sourcing velocity, readiness distribution, conversion rate | Prospecting | Read | — |
getProspectOwnerPath | Trace the ownership chain — entity relationships and decision-makers | Prospecting | Read | — |
listSnoozedProspects | List prospects currently snoozed with their wake dates | Prospecting | Read | — |
getDigestPreview | Preview the daily or weekly prospect digest before sending | Prospecting | Read | — |
prepareScreeningMemoExport | Prepare a screening memo export for a prospect | Prospecting | Read | — |
snoozeProspect | Defer a prospect to the queue until a date or shortcut (tomorrow, next week) | Prospecting | Write | ✓ |
addProspectTag | Assign a custom tag to a prospect for tracking and filtering | Prospecting | Write | ✓ |
dismissProspect | Dismiss a prospect from the active review queue | Prospecting | Write | ✓ |
attachProspectSourceUrl | Attach a source URL to a prospect record | Prospecting | Write | ✓ |
updateProspectSource | Update metadata or status on a prospect source | Prospecting | Write | ✓ |
runProspectResearchAction | Start a targeted prospect research action | Prospecting | Write | ✓ |
convertProspectToDeal | Convert a prospect into a deal workspace | Prospecting | Write | ✓ |
runSourcingProfile | Run a sourcing profile against available prospecting sources | Prospecting | Write | ✓ |
launchScoutReview | Launch an AI scout review for a prospect or mandate | Prospecting | Write | ✓ |
dispatchBackgroundJob | Dispatch an approved enrichment or review job | Prospecting | Write | ✓ |
| Tool | Description | Modes | Type | Approval |
|---|
getDealNextActions | Prioritized action items derived from health, tasks, and diligence context | Deal | Read | — |
listDealTasks | Query the persistent work queue with status, priority, and type filters | Deal | Read | — |
createDealTask | Create a new work item with title, description, priority, due date, assignment | Deal | Write | ✓ |
updateDealTask | Modify task status, priority, assignee, or dates | Deal | Write | ✓ |
completeDealTask | Mark a task complete | Deal | Write | ✓ |
snoozeDealTask | Snooze a task until a date; hides it from the queue until then | Deal | Write | ✓ |
scheduleTaskReminder | Set a reminder notification for a task | Deal | Write | ✓ |
These tools wrap deeper specialist agents (lease, debt, legal, diligence, intake, closing, LOI). The chat assistant invokes them when your message is in their domain. For more on the agents themselves, see Specialist agents.
| Tool | Description | Modes | Type | Approval |
|---|
abstractLeases | Extract key lease terms per tenant — rent, dates, escalations, TI, options | Deal | Write | — |
compareLeaseTerms | Compare rent spreads, escalations, and concessions across tenants | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
prepareLenderPackage | Tailor the lender package — financials, tenants, market — by lender type | Deal | Read | — |
compareTermSheets | Side-by-side comparison of loan terms; highlights best rate or leverage | Deal | Read | — |
lenderSensitivity | DSCR and LTV sensitivity tables for hypothetical loan changes | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
reviewPSA | Extract and flag PSA terms; identify deviations from market standards | Deal | Read | — |
mapTitleExceptions | Categorize title exceptions; assess impact and cure recommendations | Deal | Read | — |
generateIssueList | First-pass legal issue list compiled from all documents | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
createDiligenceRequest | Generate a prioritized DD document request list | Deal | Write | — |
chaseDeliverables | Generate escalation-tiered follow-up messages for outstanding documents | Deal | Read | — |
verifyDocumentCompleteness | Verify required closing documents are received and executed | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
screenDeal | Rapid triage from raw text (OM, teaser, email) with mandate-fit scoring | Deal | Read | — |
scoreMandateFit | Score deal fit against fund criteria (0–100) with drivers | Deal | Read | — |
| Tool | Description | Modes | Type | Approval |
|---|
generateClosingChecklist | Standard closing checklist plus deal-specific obligations | Deal | Write | — |
| Tool | Description | Modes | Type | Approval |
|---|
draftLOI | Generate an LOI with buyer entity, price, contingencies, timeline from deal data | Deal | Read | — |
compareLOIVersions | Side-by-side version comparison highlighting price and term changes | Deal | Read | — |
The transaction graph tracks parties, milestones, and obligations across the deal lifecycle.
| Tool | Description | Modes | Type | Approval |
|---|
listParties | List all deal parties — buyer, seller, broker, lender, legal — with contacts | Deal | Read | — |
addParty | Register a new party in the transaction graph | Deal | Write | — |
listMilestones | List deal milestones (DD close, financing approval, closing) | Deal | Read | — |
addMilestone | Create a deal milestone | Deal | Write | — |
updateMilestone | Modify a milestone's date, status, or owner | Deal | Write | — |
listObligations | List open obligations — seller deliverables, lender conditions | Deal | Read | — |
addObligation | Create an obligation | Deal | Write | — |
updateObligation | Modify an obligation's status, owner, or due date | Deal | Write | — |
| Tool | Description | Modes | Type | Approval |
|---|
getDealMemoryBrief | Read the compact working-memory brief for a deal: thesis, validated facts, decisions, blockers, next actions, and recent changes | Deal, Portfolio | Read | — |
getDealNotebook | Retrieve governed notebook entries for a deal, including facts, decisions, risks, questions, lessons, outcomes, and human / agent notes | Deal, Portfolio | Read | — |
searchDealNotebook | Search the deal notebook by topic with provenance-linked results | Deal, Portfolio | Read | — |
getOrganizationCompanyProfile | Read the latest reviewed, bounded public-business context for the organization; draft and rejected profiles remain withheld | Deal, Portfolio, Prospecting, Listings | Read | — |
findRelevantInstitutionalPatterns | Find reviewed institutional patterns relevant to a deal profile, such as preferences, risk patterns, IC feedback, or diligence sensitivities | Deal, Portfolio | Read | — |
compareDealToInstitutionalMemory | Compare a deal profile against reviewed institutional memory and return the patterns that should shape analysis | Deal, Portfolio | Read | — |
recordNotebookEntry | Record an approved deal notebook entry for durable facts, decisions, risks, open questions, or lessons | Deal, Portfolio | Write | ✓ |
proposeInstitutionalMemoryPattern | Save a draft cross-deal memory pattern for later human review | Deal, Portfolio | Write | ✓ |
recordHistoricalDealOutcome | Import a reviewed historical deal packet from IC memos and underwriting models into outcomes, notebook entries, and draft patterns | Deal, Portfolio | Write | ✓ |
Memory tools are org-scoped and only exposed when an organization context is in place. Deal-specific tools use the current deal automatically in deal chat; in portfolio chat, the assistant must identify or receive a dealId. Reviewed institutional memory can enter compact prompt context, while raw notebook entries and draft patterns are retrieved by tools on demand.
| Tool | Description | Modes | Type | Approval |
|---|
webSearch | Search the web for current CRE market info, news, tenant credit, and comparables | Deal, Portfolio, Prospecting | Read | — |
Web search runs only when the Web search category toggle is enabled in the chat input footer. It uses Vercel AI Gateway Parallel Search; unavailable or failed searches remain distinct from a legitimate empty result.
These writes are governed. Attended and higher-risk tools prompt for Allow / Deny before running. Eligible routine writes may execute under an organization-approved autonomy policy; when direct approvals are pending, a bulk approval bar can appear.
For Review queue tools and routine work, an approved policy can replace the prompt within its declared scope. See Approval modes. Base/scenario scalar valuation changes, capital-stack replacement, and executeDealCleanupCommand remain attended.
- Deal mode:
actOnReviewItem, updatePropertyInfo, updateField, addTenant, deleteTenant, deleteSuiteInventory, addOperatingStatement, reprocessDocument, deleteDocument, markDocumentsReviewed, resolveAllConflicts, autoResolveReviewQueue, executeDealCleanupCommand, valuation mutation tools, and deal work-queue mutations. The runtime policy decides whether an eligible routine write prompts or executes under approved autonomy. Overview JSON Render create/edit (createJsonRenderDashboard, editJsonRenderDashboard) are not in this list; they persist immediately after an explicit creation or edit/rebuild prompt (or the Overview dashboard button for creation).
- Prospecting mode: all prospecting write tools, including snooze, tag, dismiss, source update, research action, conversion, sourcing-profile run, scout review, and background-job dispatch
- For how the assistant decides which tools to expose in each mode, see Chat modes.
- For specialist agents that wrap many of these tools into multi-step flows, see Specialist agents.
- For data-handling and human-in-the-loop guarantees on the writes, see Trust and safety.
