@vprop/mcp 1.0.0 → 1.0.1
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 +142 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# @vprop/mcp
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) server for the [vProp Public API](https://vprop.ai/api/v1/docs) — let AI assistants create real-estate listing videos on your behalf.
|
|
4
|
+
|
|
5
|
+
## What it does
|
|
6
|
+
|
|
7
|
+
Connect Claude (or any MCP-compatible AI) to vProp so it can:
|
|
8
|
+
|
|
9
|
+
- Create and manage property listings
|
|
10
|
+
- Upload listing photos
|
|
11
|
+
- Create and manage agent profiles
|
|
12
|
+
- Generate AI-powered listing videos
|
|
13
|
+
- Poll for video completion and return the final URL
|
|
14
|
+
|
|
15
|
+
**Typical flow:**
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
create_listing → upload_listing_image (×10+) → create_agent →
|
|
19
|
+
upload_agent_photo → create_project → get_project_status (poll) → get_project
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Prerequisites
|
|
23
|
+
|
|
24
|
+
A vProp API key (`VP_…`). Contact [vProp](https://vprop.ai) to get one.
|
|
25
|
+
|
|
26
|
+
## Setup
|
|
27
|
+
|
|
28
|
+
### Claude Desktop
|
|
29
|
+
|
|
30
|
+
Edit `~/Library/Application Support/Claude/claude_desktop_config.json`:
|
|
31
|
+
|
|
32
|
+
```json
|
|
33
|
+
{
|
|
34
|
+
"mcpServers": {
|
|
35
|
+
"vprop": {
|
|
36
|
+
"command": "npx",
|
|
37
|
+
"args": ["-y", "@vprop/mcp"],
|
|
38
|
+
"env": {
|
|
39
|
+
"VPROP_API_KEY": "VP_your_key_here"
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
}
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
Restart Claude Desktop — the vProp tools will be available immediately.
|
|
47
|
+
|
|
48
|
+
### Claude Code (CLI)
|
|
49
|
+
|
|
50
|
+
```bash
|
|
51
|
+
claude mcp add vprop npx -e VPROP_API_KEY=VP_your_key_here -- -y @vprop/mcp
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
### Other MCP clients
|
|
55
|
+
|
|
56
|
+
```json
|
|
57
|
+
{
|
|
58
|
+
"command": "npx",
|
|
59
|
+
"args": ["-y", "@vprop/mcp"],
|
|
60
|
+
"env": { "VPROP_API_KEY": "VP_your_key_here" }
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
## Available tools
|
|
65
|
+
|
|
66
|
+
### Voices & Music
|
|
67
|
+
| Tool | Description |
|
|
68
|
+
|------|-------------|
|
|
69
|
+
| `list_voices` | List narration voices. Use the `id` as `voice_id`. |
|
|
70
|
+
| `list_bgms` | List background music tracks. Use the `id` as `bgm_id`. |
|
|
71
|
+
|
|
72
|
+
### Listings
|
|
73
|
+
| Tool | Description |
|
|
74
|
+
|------|-------------|
|
|
75
|
+
| `create_listing` | Create a property listing (address required) |
|
|
76
|
+
| `get_listing` | Get listing details by ID |
|
|
77
|
+
| `list_listings` | List all listings (paginated) |
|
|
78
|
+
| `update_listing` | Update address, attributes, or metadata |
|
|
79
|
+
| `delete_listing` | Delete a listing |
|
|
80
|
+
| `list_listing_images` | List uploaded images for a listing |
|
|
81
|
+
| `upload_listing_image` | Upload a local JPEG/PNG/WebP to a listing |
|
|
82
|
+
| `delete_listing_image` | Remove an image from a listing |
|
|
83
|
+
|
|
84
|
+
### Agents
|
|
85
|
+
| Tool | Description |
|
|
86
|
+
|------|-------------|
|
|
87
|
+
| `create_agent` | Create a realtor agent profile |
|
|
88
|
+
| `get_agent` | Get agent details by ID |
|
|
89
|
+
| `list_agents` | List all agents (paginated) |
|
|
90
|
+
| `update_agent` | Update agent info or default voice |
|
|
91
|
+
| `delete_agent` | Delete an agent |
|
|
92
|
+
| `upload_agent_photo` | Upload a headshot photo (enables avatar feature) |
|
|
93
|
+
|
|
94
|
+
### Projects (video generation)
|
|
95
|
+
| Tool | Description |
|
|
96
|
+
|------|-------------|
|
|
97
|
+
| `create_project` | Start video generation (async, returns `proj_…`) |
|
|
98
|
+
| `get_project_status` | Lightweight status check (`pending/processing/completed/failed`) |
|
|
99
|
+
| `get_project` | Full project details including `video_url` when done |
|
|
100
|
+
| `list_projects` | List projects with optional status filter |
|
|
101
|
+
|
|
102
|
+
### Webhooks
|
|
103
|
+
| Tool | Description |
|
|
104
|
+
|------|-------------|
|
|
105
|
+
| `register_webhook` | Register an HTTPS URL to receive project events |
|
|
106
|
+
|
|
107
|
+
## Example prompts
|
|
108
|
+
|
|
109
|
+
**Generate a video end-to-end:**
|
|
110
|
+
> "Create a listing for 123 Oak Ave, Austin TX 78701. Upload all photos from ~/Desktop/photos/. Create an agent named Jane Doe with email jane@realty.com. Then generate a video in modern theme and let me know when it's ready."
|
|
111
|
+
|
|
112
|
+
**Check on existing projects:**
|
|
113
|
+
> "Show me all completed projects from the last run."
|
|
114
|
+
|
|
115
|
+
**Try different styles:**
|
|
116
|
+
> "Generate a landscape video with bold theme and no captions for listing lst_AbCd."
|
|
117
|
+
|
|
118
|
+
## Video options
|
|
119
|
+
|
|
120
|
+
When calling `create_project`, you can customize:
|
|
121
|
+
|
|
122
|
+
| Option | Values | Default |
|
|
123
|
+
|--------|--------|---------|
|
|
124
|
+
| `theme` | `modern` `classic` `bold` `elegant` | `modern` |
|
|
125
|
+
| `resolution` | `portrait` (9:16) `landscape` (16:9) | `portrait` |
|
|
126
|
+
| `caption` | `none` `keyword` `description` | `keyword` |
|
|
127
|
+
| `voice_id` | ID from `list_voices` | agent default |
|
|
128
|
+
| `bgm_id` | ID from `list_bgms` | theme default |
|
|
129
|
+
| `use_agent_avatar` | `true` `false` | `true` |
|
|
130
|
+
| `use_lipsync` | `true` `false` | `false` |
|
|
131
|
+
|
|
132
|
+
## Notes
|
|
133
|
+
|
|
134
|
+
- **Image uploads require a local file path** — the MCP server runs on your machine and reads files directly. Minimum 10 photos recommended for best results.
|
|
135
|
+
- **Video generation is async** — `create_project` returns immediately. Poll `get_project_status` until `completed`, then call `get_project` for the `video_url`.
|
|
136
|
+
- **Rate limits** — project creation is capped at 10/min, 120/hour. Most other endpoints allow 120/min.
|
|
137
|
+
|
|
138
|
+
## Links
|
|
139
|
+
|
|
140
|
+
- [vProp API docs](https://vprop.ai/api/v1/docs)
|
|
141
|
+
- [API reference (OpenAPI)](https://vprop.ai/api/v1/openapi.json)
|
|
142
|
+
- [vProp website](https://vprop.ai)
|