yarooms-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/.env.example +2 -0
- package/LICENSE +21 -0
- package/README.md +88 -0
- package/docs/2026-04-14-001-feat-yarooms-mcp-server-plan.md +599 -0
- package/package.json +31 -0
- package/smithery.yaml +1 -0
- package/src/client.ts +172 -0
- package/src/index.ts +90 -0
- package/src/resources/catalogs.ts +40 -0
- package/src/stdio.ts +17 -0
- package/src/tools/approvals.ts +115 -0
- package/src/tools/bookings.ts +351 -0
- package/src/tools/people.ts +212 -0
- package/src/tools/visitors.ts +124 -0
- package/src/tools/work-status.ts +90 -0
- package/src/tools/workplace.ts +314 -0
- package/src/types.ts +83 -0
- package/test/client.test.ts +165 -0
- package/test/helpers.ts +13 -0
- package/test/integration/smoke.test.ts +49 -0
- package/test/resources/catalogs.test.ts +49 -0
- package/test/tools/bookings.test.ts +181 -0
- package/test/tools/visitors.test.ts +110 -0
- package/test/tools/work-status.test.ts +86 -0
- package/test/tools/workplace.test.ts +113 -0
- package/tsconfig.json +16 -0
package/.env.example
ADDED
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 YAROOMS
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
# YAROOMS MCP Server
|
|
2
|
+
|
|
3
|
+
MCP server for the [YAROOMS](https://www.yarooms.com) workplace management platform. Enables AI agents (Claude, ChatGPT, Copilot, etc.) to search rooms, book spaces, manage visitors, and set work status through the Model Context Protocol.
|
|
4
|
+
|
|
5
|
+
## Setup
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
### Environment Variables
|
|
12
|
+
|
|
13
|
+
Create a `.env` file (see `.env.example`):
|
|
14
|
+
|
|
15
|
+
```
|
|
16
|
+
YAROOMS_API_TOKEN=your-api-token
|
|
17
|
+
YAROOMS_BASE_URL=https://your-tenant.yarooms.com/api
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
### Local (stdio)
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
npm run stdio
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Smithery Dev Mode
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm run dev
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
### Smithery Production
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
npm run build
|
|
38
|
+
npm start
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## Tools
|
|
42
|
+
|
|
43
|
+
| Tool | Description |
|
|
44
|
+
|------|-------------|
|
|
45
|
+
| `search_available_spaces` | Search for available rooms/desks on a floor |
|
|
46
|
+
| `create_booking` | Book a room or desk |
|
|
47
|
+
| `get_my_bookings` | View your bookings |
|
|
48
|
+
| `cancel_booking` | Cancel a booking |
|
|
49
|
+
| `modify_booking` | Change booking time, space, or title |
|
|
50
|
+
| `check_in_booking` | Check in to a booking |
|
|
51
|
+
| `check_out_booking` | Check out of a booking |
|
|
52
|
+
| `get_locations` | List office locations |
|
|
53
|
+
| `get_floors` | List floors for a location |
|
|
54
|
+
| `get_floor_info` | Get floor details and spaces |
|
|
55
|
+
| `get_room_schedule` | View room booking timeline |
|
|
56
|
+
| `get_space_types` | List space types (Desk, Meeting Room, etc.) |
|
|
57
|
+
| `get_location_schedule` | Get operating hours for a location |
|
|
58
|
+
| `get_booking_options` | Get valid booking intervals for a space (resolves booking strategy) |
|
|
59
|
+
| `get_work_status` | View work status (WFH, office, etc.) |
|
|
60
|
+
| `set_work_status` | Set work status for dates |
|
|
61
|
+
| `register_visitor` | Register a visitor |
|
|
62
|
+
| `list_visitors` | List visitors for a date/location |
|
|
63
|
+
| `cancel_visitor` | Cancel a visitor registration |
|
|
64
|
+
| `get_all_bookings` | List all bookings (admin) — filter by date, location, space, booker, title, status |
|
|
65
|
+
| `get_pending_approvals` | List booking requests pending your approval |
|
|
66
|
+
| `approve_booking` | Approve pending booking requests |
|
|
67
|
+
| `reject_booking` | Reject pending booking requests with optional reason |
|
|
68
|
+
| `search_people` | Search for people by name or email |
|
|
69
|
+
| `get_my_profile` | Get your profile — name, email, team, location |
|
|
70
|
+
| `get_teammates` | List members of your team |
|
|
71
|
+
| `get_teammate_status` | View a teammate's work status |
|
|
72
|
+
| `get_teammate_bookings` | View a teammate's bookings for a date |
|
|
73
|
+
|
|
74
|
+
## Resources
|
|
75
|
+
|
|
76
|
+
| Resource | URI | Description |
|
|
77
|
+
|----------|-----|-------------|
|
|
78
|
+
| Work Status Options | `yarooms://work-status-options` | Available status options with IDs |
|
|
79
|
+
|
|
80
|
+
## Testing
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
# Unit tests
|
|
84
|
+
npm test
|
|
85
|
+
|
|
86
|
+
# Integration tests (requires API credentials)
|
|
87
|
+
RUN_INTEGRATION=true npm test
|
|
88
|
+
```
|