@honeyfield/rent2b-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 +235 -0
- package/dist/config.js +1 -1
- package/dist/config.js.map +1 -1
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,235 @@
|
|
|
1
|
+
# @honeyfield/rent2b-mcp
|
|
2
|
+
|
|
3
|
+
MCP Server for the rent2b Rental Management API. This server provides 105 tools for managing rooms, items, bookings, locations, guests, availability, categories, statistics, and more.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install -g @honeyfield/rent2b-mcp
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Or use directly with npx:
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npx @honeyfield/rent2b-mcp
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Configuration
|
|
18
|
+
|
|
19
|
+
### Environment Variable
|
|
20
|
+
|
|
21
|
+
Set your rent2b API key as an environment variable:
|
|
22
|
+
|
|
23
|
+
```bash
|
|
24
|
+
export RENT2B_API_KEY=r2b_your-api-key
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Optionally override the API URL (defaults to `https://rent2b-api.azurewebsites.net/api/v1`):
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
export RENT2B_API_URL=https://your-custom-api-url/api/v1
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
### Claude Desktop / Claude Code
|
|
34
|
+
|
|
35
|
+
Add to your MCP configuration:
|
|
36
|
+
|
|
37
|
+
```json
|
|
38
|
+
{
|
|
39
|
+
"mcpServers": {
|
|
40
|
+
"rent2b": {
|
|
41
|
+
"command": "npx",
|
|
42
|
+
"args": ["@honeyfield/rent2b-mcp"],
|
|
43
|
+
"env": {
|
|
44
|
+
"RENT2B_API_KEY": "r2b_your-api-key"
|
|
45
|
+
}
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
}
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
### SSE Mode
|
|
52
|
+
|
|
53
|
+
For SSE transport (e.g. for web-based MCP clients):
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
npx @honeyfield/rent2b-mcp --sse --port=8080
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Available Tools (105)
|
|
60
|
+
|
|
61
|
+
### Rooms (14 Tools)
|
|
62
|
+
|
|
63
|
+
| Tool | Description |
|
|
64
|
+
|------|-------------|
|
|
65
|
+
| `rent2b_rooms_create` | Create a new room |
|
|
66
|
+
| `rent2b_rooms_list` | List all rooms in the organization |
|
|
67
|
+
| `rent2b_rooms_organization_list` | Get all rooms for an organization with pagination and search |
|
|
68
|
+
| `rent2b_rooms_location_list` | Get all rooms for a location with pagination and search |
|
|
69
|
+
| `rent2b_rooms_get` | Get details of a specific room by ID |
|
|
70
|
+
| `rent2b_rooms_update` | Update a room's properties |
|
|
71
|
+
| `rent2b_rooms_delete` | Delete a room |
|
|
72
|
+
| `rent2b_rooms_images_create` | Upload images for a room |
|
|
73
|
+
| `rent2b_rooms_images_list` | Get all images for a room |
|
|
74
|
+
| `rent2b_rooms_images_delete` | Delete a room image |
|
|
75
|
+
| `rent2b_rooms_images_primary_update` | Set an image as primary for a room |
|
|
76
|
+
| `rent2b_rooms_buffer_times_list` | Retrieve buffer time configuration |
|
|
77
|
+
| `rent2b_rooms_buffer_times_update` | Configure buffer time before and after bookings |
|
|
78
|
+
| `rent2b_rooms_pricing_rules_list` | Get available pricing rules |
|
|
79
|
+
|
|
80
|
+
### Items (17 Tools)
|
|
81
|
+
|
|
82
|
+
| Tool | Description |
|
|
83
|
+
|------|-------------|
|
|
84
|
+
| `rent2b_items_create` | Create a new rental item |
|
|
85
|
+
| `rent2b_items_list` | List all rental items in the organization |
|
|
86
|
+
| `rent2b_items_organization_list` | Get all items with pagination, search, and radius filtering |
|
|
87
|
+
| `rent2b_items_location_list` | Get all items for a location |
|
|
88
|
+
| `rent2b_items_get` | Get details of a specific rental item by ID |
|
|
89
|
+
| `rent2b_items_update` | Update a rental item's properties |
|
|
90
|
+
| `rent2b_items_delete` | Delete a rental item |
|
|
91
|
+
| `rent2b_items_quantity_update` | Update available quantity of an item |
|
|
92
|
+
| `rent2b_items_images_create` | Upload images for an item |
|
|
93
|
+
| `rent2b_items_images_list` | Get all images for an item |
|
|
94
|
+
| `rent2b_items_images_delete` | Delete an item image |
|
|
95
|
+
| `rent2b_items_images_primary_update` | Set an image as primary for an item |
|
|
96
|
+
| `rent2b_items_buffer_times_list` | Retrieve buffer time configuration |
|
|
97
|
+
| `rent2b_items_buffer_times_update` | Configure buffer time before and after bookings |
|
|
98
|
+
| `rent2b_items_analyze_image_create` | AI-powered image analysis for item suggestions |
|
|
99
|
+
| `rent2b_items_favorites_create` | Toggle favorite status for an item |
|
|
100
|
+
| `rent2b_items_favorites_delete` | Remove item from favorites |
|
|
101
|
+
|
|
102
|
+
### Bookings (15 Tools)
|
|
103
|
+
|
|
104
|
+
| Tool | Description |
|
|
105
|
+
|------|-------------|
|
|
106
|
+
| `rent2b_bookings_create` | Create a new booking for an item or room |
|
|
107
|
+
| `rent2b_bookings_list` | List all bookings for the organization |
|
|
108
|
+
| `rent2b_bookings_my_list` | List bookings where the authenticated user is the renter |
|
|
109
|
+
| `rent2b_bookings_get` | Get details of a specific booking |
|
|
110
|
+
| `rent2b_bookings_update` | Update a booking |
|
|
111
|
+
| `rent2b_bookings_confirm` | Confirm a pending booking |
|
|
112
|
+
| `rent2b_bookings_reject` | Reject a pending booking |
|
|
113
|
+
| `rent2b_bookings_cancel` | Cancel a booking and process refund |
|
|
114
|
+
| `rent2b_bookings_reservations_pending_requests_list` | List off-platform reservations needing approval |
|
|
115
|
+
| `rent2b_bookings_reservations_pending_list` | List pending/reserved booking reservations |
|
|
116
|
+
| `rent2b_bookings_reservations_confirm_create` | Confirm an off-platform reservation |
|
|
117
|
+
| `rent2b_bookings_reservations_reject_create` | Reject an off-platform reservation |
|
|
118
|
+
| `rent2b_bookings_reviews_create` | Create a review for a completed booking |
|
|
119
|
+
| `rent2b_items_reviews_list` | Get reviews for an item |
|
|
120
|
+
| `rent2b_available_resources` | Get all available rooms and items |
|
|
121
|
+
|
|
122
|
+
### Availability (8 Tools)
|
|
123
|
+
|
|
124
|
+
| Tool | Description |
|
|
125
|
+
|------|-------------|
|
|
126
|
+
| `rent2b_rooms_availability` | Get availability calendar for a specific room |
|
|
127
|
+
| `rent2b_items_availability` | Get availability calendar for a specific item |
|
|
128
|
+
| `rent2b_availability_check` | Check availability and pricing for a specific date range |
|
|
129
|
+
| `rent2b_bookings_rooms_availability_bulk_create` | Get availability for multiple rooms at once |
|
|
130
|
+
| `rent2b_bookings_items_availability_bulk_create` | Get per-day availability breakdown for multiple items |
|
|
131
|
+
| `rent2b_locations_items_availability_list` | Get item availability calendar |
|
|
132
|
+
| `rent2b_locations_items_availability_generate_create` | Generate availability for date range |
|
|
133
|
+
| `rent2b_locations_items_availability_block_create` | Block specific dates |
|
|
134
|
+
|
|
135
|
+
### Locations (8 Tools)
|
|
136
|
+
|
|
137
|
+
| Tool | Description |
|
|
138
|
+
|------|-------------|
|
|
139
|
+
| `rent2b_locations_create` | Create a new location |
|
|
140
|
+
| `rent2b_locations_list` | List all locations for the organization |
|
|
141
|
+
| `rent2b_locations_organization_list` | Get all locations for an organization |
|
|
142
|
+
| `rent2b_locations_get` | Get details of a specific location |
|
|
143
|
+
| `rent2b_locations_update` | Update a location |
|
|
144
|
+
| `rent2b_locations_delete` | Delete a location |
|
|
145
|
+
| `rent2b_locations_address_search_create` | Search for addresses using Google Places |
|
|
146
|
+
| `rent2b_locations_place_details_create` | Get detailed place information including coordinates |
|
|
147
|
+
|
|
148
|
+
### Time Slots (6 Tools)
|
|
149
|
+
|
|
150
|
+
| Tool | Description |
|
|
151
|
+
|------|-------------|
|
|
152
|
+
| `rent2b_timeslots_create` | Create a time slot for a location |
|
|
153
|
+
| `rent2b_timeslots_list` | List time slots for a specific location |
|
|
154
|
+
| `rent2b_time_slots_day_list` | Get all time slots for a specific day |
|
|
155
|
+
| `rent2b_time_slots_list` | Get a specific time slot |
|
|
156
|
+
| `rent2b_timeslots_update` | Update a time slot |
|
|
157
|
+
| `rent2b_timeslots_delete` | Delete a time slot |
|
|
158
|
+
| `rent2b_timeslots_create_weekly` | Create a full weekly schedule |
|
|
159
|
+
|
|
160
|
+
### Guests (5 Tools)
|
|
161
|
+
|
|
162
|
+
| Tool | Description |
|
|
163
|
+
|------|-------------|
|
|
164
|
+
| `rent2b_guests_create` | Create a new guest |
|
|
165
|
+
| `rent2b_guests_list` | List guests for the organization |
|
|
166
|
+
| `rent2b_guests_get` | Get a specific guest by ID |
|
|
167
|
+
| `rent2b_guests_update` | Update a guest's information |
|
|
168
|
+
| `rent2b_guests_delete` | Delete a guest |
|
|
169
|
+
|
|
170
|
+
### Categories & Attributes (10 Tools)
|
|
171
|
+
|
|
172
|
+
| Tool | Description |
|
|
173
|
+
|------|-------------|
|
|
174
|
+
| `rent2b_categories_create` | Create a new category |
|
|
175
|
+
| `rent2b_categories_list` | List all item categories |
|
|
176
|
+
| `rent2b_categories_get` | Get a specific category by ID |
|
|
177
|
+
| `rent2b_categories_update` | Update a category |
|
|
178
|
+
| `rent2b_categories_delete` | Delete a category |
|
|
179
|
+
| `rent2b_categories_attributes_create` | Create a new attribute for a category |
|
|
180
|
+
| `rent2b_categories_attributes_list` | Get all attributes for a category |
|
|
181
|
+
| `rent2b_categories_attributes_update` | Update an attribute |
|
|
182
|
+
| `rent2b_categories_attributes_delete` | Delete an attribute |
|
|
183
|
+
| `rent2b_categories_items_attributes_list` | Get all attributes for an item |
|
|
184
|
+
|
|
185
|
+
### Statistics (7 Tools)
|
|
186
|
+
|
|
187
|
+
| Tool | Description |
|
|
188
|
+
|------|-------------|
|
|
189
|
+
| `rent2b_statistics_overview` | Get comprehensive organization statistics |
|
|
190
|
+
| `rent2b_statistics_summary` | Get a quick summary of organization statistics |
|
|
191
|
+
| `rent2b_statistics_revenue` | Get detailed revenue statistics |
|
|
192
|
+
| `rent2b_statistics_utilization` | Get utilization statistics |
|
|
193
|
+
| `rent2b_statistics_location_list` | Get detailed analytics for a specific location |
|
|
194
|
+
| `rent2b_statistics_location_summary_list` | Get key metrics summary for dashboard display |
|
|
195
|
+
| `rent2b_statistics_location_revenue_list` | Get comprehensive revenue breakdown and trends |
|
|
196
|
+
|
|
197
|
+
### Checklists (4 Tools)
|
|
198
|
+
|
|
199
|
+
| Tool | Description |
|
|
200
|
+
|------|-------------|
|
|
201
|
+
| `rent2b_bookings_checklists_create` | Create a checklist instance for a booking |
|
|
202
|
+
| `rent2b_checklists_list` | List all checklists for a specific booking |
|
|
203
|
+
| `rent2b_checklists_get` | Get a specific checklist by ID |
|
|
204
|
+
| `rent2b_bookings_checklists_items_update` | Check/uncheck an item or add a note |
|
|
205
|
+
|
|
206
|
+
## Development
|
|
207
|
+
|
|
208
|
+
```bash
|
|
209
|
+
# Install dependencies
|
|
210
|
+
npm install
|
|
211
|
+
|
|
212
|
+
# Generate tools from OpenAPI spec
|
|
213
|
+
npm run generate
|
|
214
|
+
|
|
215
|
+
# Build
|
|
216
|
+
npm run build
|
|
217
|
+
|
|
218
|
+
# Run in development
|
|
219
|
+
npm run dev
|
|
220
|
+
```
|
|
221
|
+
|
|
222
|
+
## Testing with MCP Inspector
|
|
223
|
+
|
|
224
|
+
```bash
|
|
225
|
+
npx @anthropic-ai/mcp-inspector dist/index.js
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## License
|
|
229
|
+
|
|
230
|
+
MIT
|
|
231
|
+
|
|
232
|
+
## Links
|
|
233
|
+
|
|
234
|
+
- [rent2b Website](https://rent2b.net)
|
|
235
|
+
- [GitHub Repository](https://github.com/Honeyfield-Org/rent2b-mcp)
|
package/dist/config.js
CHANGED
|
@@ -8,7 +8,7 @@ export function loadConfig() {
|
|
|
8
8
|
}
|
|
9
9
|
return {
|
|
10
10
|
apiKey,
|
|
11
|
-
apiUrl: process.env.RENT2B_API_URL || 'https://api.
|
|
11
|
+
apiUrl: process.env.RENT2B_API_URL || 'https://rent2b-api.azurewebsites.net/api/v1',
|
|
12
12
|
};
|
|
13
13
|
}
|
|
14
14
|
//# sourceMappingURL=config.js.map
|
package/dist/config.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,UAAU;IACxB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO;QACL,MAAM;QACN,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI
|
|
1
|
+
{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,UAAU;IACxB,MAAM,MAAM,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC;IAC1C,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAC;IACrE,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAC;IAC3D,CAAC;IACD,OAAO;QACL,MAAM;QACN,MAAM,EAAE,OAAO,CAAC,GAAG,CAAC,cAAc,IAAI,6CAA6C;KACpF,CAAC;AACJ,CAAC"}
|