AI Assistant
Tool Reference
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.
How to Read This Page
- Modes — which chat surfaces expose this tool. Deal is per-deal chat, Portfolio is the org-level chat at
/dealsand 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 tool prompts Allow / Deny before running.
For mode behavior and toggle defaults, see Chat modes. For who governs each tool's data and provenance, see Trust and safety.
Deal Data and Property
| 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 | — |
Documents
| 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: total label, all category rows, ranked decisions, document summaries | Deal | Read | — |
actOnReviewItem | Apply an approved action to a source review or field check item from the Review queue | Deal | Write | ✓ |
getConflicts | List open extraction conflicts with source priority and confidence | Deal | Read | — |
resolveConflict | Accept a source as canonical for a single conflicted field, or set a manual override | Deal | Write | ✓ |
resolveAllConflicts | Bulk-accept the preferred source for every open conflict in a deal | Deal | Write | ✓ |
getOpenFindings | List validation findings — arithmetic, consistency, missing fields | Deal | Read | — |
Valuation
| Tool | Description | Modes | Type | Approval |
|---|---|---|---|---|
getValuation | Fetch the built DCF model with scenarios, assumptions, and outputs (value, IRR, MoIC, cash flows) | Deal | Read | — |
analyzeValuation | Narrative analysis of assumptions, drivers, and investment thesis | Deal | Read | — |
sensitivityAnalysis | Generate one- and two-variable sensitivity tables for IRR, MoIC, value | Deal | Read | — |
updateAssumption | Modify a base-year or growth assumption (rent, NOI, cap rate, discount rate, exit) | Deal | Write | ✓ |
updateTenantAssumption | Modify tenant-level renewal, downtime, landlord work, TI, or blowout assumptions | Deal | Write | ✓ |
updateOpex | Update operating expense line items | Deal | Write | ✓ |
updateValuationParams | Modify model parameters such as purchase price and square footage | 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 | Generate a formula-based Excel workbook with live model formulas | Deal | Read | — |
Market and Research
The assistant reads two precomputed market datasets covering roughly 1,000 US metros (CBSAs). Both are available in every chat mode when Market data is enabled in the chat settings.
- An economic and demographic layer (
getMarketData,compareMarkets,searchMarkets,getMarketTrends,getNationalMacro) — about 166 metrics drawn from roughly 22 government and research sources (BLS, Census, FHFA, HUD, BEA, IRS, FAA, FEMA, FDIC, Zillow, and others): employment, population, income, housing supply and prices, affordability, migration, lending conditions, and climate risk. - A commercial real-estate layer (
getCREMarket,getCRETrend,getCREComps) — cap rate, occupancy, NOI per SF, price per SF, DSCR, and asking rents by metro and property type, blending recent securitized (CMBS) transactions with current listings, plus year-by-year trends and the individual property comparables behind each market.
All values are precomputed and read-only. For commercial figures the assistant reports the underlying sample size, leads with the pooled median (such as the most current cap-rate measure), and keeps residential (Zillow/HUD) data separate from commercial rents.
| Tool | Description | Modes | Type | Approval |
|---|---|---|---|---|
getMarketData | Economic and demographic profile for a US metro — ~166 metrics (employment, population, income, housing, prices, affordability, migration, lending, climate risk) with a narrative, peer metros, and a composite score | Deal, Portfolio, Prospecting | Read | — |
compareMarkets | Side-by-side comparison of metrics across two or more metros | Deal, Portfolio, Prospecting | Read | — |
searchMarkets | Rank or search ~1,000 metros by any metric, region, state, or market tier | Deal, Portfolio, Prospecting | Read | — |
getNationalMacro | US macro context — GDP, CPI, Treasury yields, 30-year mortgage rate, Fed Funds rate | Deal, Portfolio, Prospecting | Read | — |
getMarketTrends | Historical time series for a metro from 11 federal sources | Deal, Portfolio, Prospecting | Read | — |
getMetricDefinitions | Glossary of market data fields and calculation methods | Deal, Portfolio, Prospecting | Read | — |
getCREMarket | Commercial real-estate market by metro and property type — cap rate, occupancy, NOI/SF, and price/SF as low/median/high ranges, plus DSCR and asking rent | Deal, Portfolio, Prospecting | 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 | Read | — |
getCREComps | Individual securitized-property (CMBS) comparables behind a market's aggregates | Deal, Portfolio, Prospecting | Read | — |
searchPapers | Query academic papers (OpenAlex) on CRE, markets, and asset performance | Deal, Portfolio, Prospecting | 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 | — |
Comparable Properties
| 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.
Deal Health
| 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 | — |
Portfolio and Cross-Deal
| 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 | — |
Prospecting
| 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 | ✓ |
Tasks and Work Queue
| 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 | ✓ |
Specialist Workflow Tools
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.
Lease Intelligence
| 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 | — |
Debt Placement
| 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 | — |
Legal Review
| 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 | — |
Diligence Management
| 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 | — |
Intake and Screening
| 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 | — |
Closing
| Tool | Description | Modes | Type | Approval |
|---|---|---|---|---|
generateClosingChecklist | Standard closing checklist plus deal-specific obligations | Deal | Write | — |
LOI
| 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 | — |
Transaction Graph
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 | — |
Institutional Memory
| 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 | — |
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.
Web Search
| 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. The provider order falls back gracefully across configured services (Perplexity → Bing); failures are non-blocking.
Approval-Gated Tools at a Glance
These tools always prompt for Allow / Deny before running. When two or more are pending, a bulk approval bar appears.
- Deal mode —
actOnReviewItem,updatePropertyInfo,updateField,addTenant,deleteTenant,deleteSuiteInventory,addOperatingStatement,reprocessDocument,deleteDocument,markDocumentsReviewed,resolveConflict,resolveAllConflicts, valuation mutation tools, and deal work-queue mutations - Prospecting mode — all prospecting write tools, including snooze, tag, dismiss, source update, research action, conversion, sourcing-profile run, scout review, and background-job dispatch
Where to Go Next
- 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.
Edit on GitHub
Last updated on
Specialist Agents
The domain-specific AI agents that handle intake, lease analysis, legal review, diligence, financing, closing, and research — and how each fits into the deal lifecycle.
Models and Routing
How EQUIRE routes AI workloads across model tiers, attributes usage to your organization, enforces zero-retention, and applies per-task timeouts.