@estaite-solutions/estaite-mcp 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +76 -0
- package/package.json +12 -0
package/README.md
ADDED
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
# Estaite MCP Server
|
|
2
|
+
|
|
3
|
+
Current US rental market data for AI agents and LLMs via the Model Context Protocol (MCP).
|
|
4
|
+
The Estaite Submarket Index covers 1500+ submarkets across the largest MSAs in the United States and expanding, with monthly-updated rent, vacancy, affordability, and trend data.
|
|
5
|
+
|
|
6
|
+
## Getting Started
|
|
7
|
+
|
|
8
|
+
- **MCP Server URL:** `https://mcp.estaite.com`
|
|
9
|
+
- **Protocol:** Streamable HTTP (MCP 2025-03-26)
|
|
10
|
+
|
|
11
|
+
**Authentication** — pass your API key using any of these methods:
|
|
12
|
+
|
|
13
|
+
| Method | Example |
|
|
14
|
+
|--------|---------|
|
|
15
|
+
| Header | `x-api-key: YOUR_API_KEY` |
|
|
16
|
+
| Bearer token | `Authorization: Bearer YOUR_API_KEY` |
|
|
17
|
+
| Query param | `https://mcp.estaite.com?key=YOUR_API_KEY` |
|
|
18
|
+
|
|
19
|
+
Get your API key at [estaite.com/developers](https://estaite.com/developers).
|
|
20
|
+
|
|
21
|
+
## Available Tools
|
|
22
|
+
|
|
23
|
+
- **Search Submarkets** — Search for submarkets by name. Use this to get a submarket ID before calling metrics tools.
|
|
24
|
+
- **List Submarkets** — List all submarkets with optional filters by state or CBSA.
|
|
25
|
+
- **ZIP Metrics** — Rental metrics for a specific ZIP code — rent, YoY growth, vacancy, listings, and household income.
|
|
26
|
+
- **Submarket Metrics** — Full metrics for a submarket: rent, vacancy, affordability, days on market, saturation, and trend history.
|
|
27
|
+
- **Compare Submarkets** — Side-by-side comparison of two or more submarkets across all key metrics.
|
|
28
|
+
- **Market Snapshot** — Quick summary of a submarket including market condition label, vacancy, and rent trends.
|
|
29
|
+
- **Rent Trends** — Historical rent trend data — MoM, 3M, 6M, 9M, and YoY changes over configurable months.
|
|
30
|
+
- **Affordability** — Rent-to-income ratio and affordability index with trend changes over 3, 6, 9, and 12 months.
|
|
31
|
+
- **Find by Criteria** — Filter submarkets by rent range, YoY growth minimum, vacancy cap, state, or CBSA.
|
|
32
|
+
- **Metro Overview** — Aggregated rent, growth, and vacancy averages for all submarkets within a metro area.
|
|
33
|
+
- **Rank Submarkets** — Rank submarkets within a metro or state by median rent, rent growth, vacancy, affordability, or days on market.
|
|
34
|
+
- **Comparable Submarkets** — Find submarkets with similar rent levels to a given submarket.
|
|
35
|
+
- **Metro Historical Trends** — Monthly aggregated rent and vacancy trends for an entire metro area over up to 12 months.
|
|
36
|
+
|
|
37
|
+
## Data Coverage
|
|
38
|
+
|
|
39
|
+
- **Property types:** `apt` (apartment), `sfr` (single-family), `ct` (condo/townhome)
|
|
40
|
+
- **Bedroom counts:** 1–5 bedrooms per property type
|
|
41
|
+
- **Geography:** 1500+ submarkets across the largest MSAs in the US and expanding
|
|
42
|
+
- **Frequency:** Monthly updates
|
|
43
|
+
|
|
44
|
+
## Quick Connect
|
|
45
|
+
|
|
46
|
+
### Claude Desktop
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"mcpServers": {
|
|
50
|
+
"estaite": {
|
|
51
|
+
"command": "npx",
|
|
52
|
+
"args": ["-y", "mcp-remote@latest", "https://mcp.estaite.com", "--header", "x-api-key:YOUR_API_KEY"]
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
### Claude Code
|
|
59
|
+
```bash
|
|
60
|
+
claude mcp add --transport http estaite "https://mcp.estaite.com" --header "x-api-key:YOUR_API_KEY"
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### OpenAI SDK
|
|
64
|
+
```python
|
|
65
|
+
resp = client.responses.create(
|
|
66
|
+
model="gpt-4o",
|
|
67
|
+
tools=[{
|
|
68
|
+
"type": "mcp",
|
|
69
|
+
"server_label": "estaite",
|
|
70
|
+
"server_url": "https://mcp.estaite.com",
|
|
71
|
+
"headers": {"x-api-key": "YOUR_API_KEY"},
|
|
72
|
+
"require_approval": "never",
|
|
73
|
+
}],
|
|
74
|
+
input="What is the average rent in Austin, TX?",
|
|
75
|
+
)
|
|
76
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@estaite-solutions/estaite-mcp",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"mcpName": "io.github.estaite-solutions/estaite-mcp",
|
|
5
|
+
"description": "Real-time US rental market data MCP server for AI agents. Query vacancy rates, median rents, YoY growth, and more across US submarkets.",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "https://github.com/Estaite-Solutions/estaite-mcp.git"
|
|
9
|
+
},
|
|
10
|
+
"keywords": ["mcp", "real-estate", "rental-data", "ai-agents"],
|
|
11
|
+
"license": "ISC"
|
|
12
|
+
}
|