MCP 服务器概览
what is the project about?
DealMachine CLI (dm) is the official command-line client and public MCP server package for DealMachine. It provides property, people, company, and lead intelligence by talking to the DealMachine REST API. The distribution also contains a hosted MCP connection and an agent skill for AI assistants (OpenAI, Claude, Cursor, Copilot, Gemini, etc.).
how to use the project?
Install: npm install -g dealmachine (or use @dealmachine/cli) Basic auth flows: dm login (OAuth2 device flow) or dm login --key <API_KEY> for CI. Commands are invoked as dm <group> <command>. Example: dm properties search --body ‘{…}’ or dm enrich address “123 Main St, Austin, TX”. Use --json for machine-readable output. Config and credentials are stored at ~/.dealmachine/config.json. The CLI supports environment overrides via DM_API_URL / DM_ENV.
key features
- Single self-contained ESM binary communicating only with the public REST API (no internal package deps)
- 17 command groups covering agents, auth, account, usage, properties, people, enrich, comps, lists, filters, fields, activity, addresses, locations, and dev utilities
- Support for batch enrichment (JSON and CSV), exports (signed download URLs), and large exports up to 1,000,000 records
- OAuth2 Device Authorization Grant (RFC 8628) and direct API-key login
- Credit-aware agent skill with cost estimation and manifests for multiple AI platforms; hosted MCP server at https://mcp.dealmachine.com
- Consistent CLI UX: --json output, --quiet, parseRequestBody from --body/-f/stdin, auto-chunking for large batches, spinners and formatted tables
- Developer-friendly: tsc-built ESM bundle, project layout and guidance for adding commands
use cases
- Real-estate prospecting: find absentee owners, high-equity properties, and build targeted prospecting lists.
- Lead enrichment: lookup owners, emails, phones, APNs, geocoordinates to enrich CRM records.
- Comparable sales (comps) analysis and property valuation summaries.
- Bulk exports and list management for marketing campaigns and outreach workflows.
- Agent/AI integrations: plug into ChatGPT/Claude/Copilot to let agents query property and people data via the MCP skill.
- CI and automation: authenticate with an API key and run scripted queries and exports.
- Local development and testing against a local API environment (local/staging/production switches).
FAQ from the project
-
Q: How do I authenticate? A: Use dm login to run the OAuth2 device flow (interactive) or dm login --key <API_KEY> to supply a key for CI and scripts.
-
Q: Where are credentials stored? A: In ~/.dealmachine/config.json; the CLI enforces restrictive permissions (directory 0700, file 0600).
-
Q: How do I avoid consuming people credits when I only need property data? A: Use --contact-audience none on property/enrich endpoints to omit contact lookups and avoid people credits.
-
Q: Can I script output parsing? A: Yes. Every command supports --json for machine-readable output and stdin/–body/-f input methods for automation.
-
Q: What environments can I target? A: local (http://localhost:3001/v1), staging, and production; you can also override DM_API_URL.
-
Q: How large are exports? A: Exports return signed URLs and support up to 1,000,000 records; exports and certain operations are credit-aware.
-
Q: What Node version is required? A: Node.js >= 18 to run the compiled dist/index.js.
-
Q: Where can I find API docs and support? A: API docs at https://api.docs.dealmachine.com, hosted MCP at https://mcp.dealmachine.com, account and keys at https://dealmachine.com/settings/developer, support at support@dealmachine.com.