@oures/rooms-mcp 0.0.0-stage → 0.1.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 +57 -2
- package/dist/oures-rooms-mcp.mjs +5102 -0
- package/package.json +9 -4
package/README.md
CHANGED
|
@@ -1,3 +1,58 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Install the Oures Rooms MCP server
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
Oures Rooms is a 3D room planner. This MCP server lets an AI agent (Claude Code, Codex, any MCP client) open a room,
|
|
4
|
+
furnish it from the Oures shop, check it, look at it and save it, through exact commands that refuse with a reason
|
|
5
|
+
(a sofa in a door's swing, a piece through a wall) and offer the nearest spot that works.
|
|
6
|
+
|
|
7
|
+
## Install (Claude Code)
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
claude mcp add --scope user oures-rooms -- npx -y @oures/rooms-mcp
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
Needs Node 20 or later. Check it with `claude mcp get oures-rooms` (it should say Connected), then ask Claude for
|
|
14
|
+
example: *"Make a new 4 by 5 m room with a door on wall 0, furnish it as a calm living room and give me its link."*
|
|
15
|
+
|
|
16
|
+
Other MCP clients: run `npx -y @oures/rooms-mcp` as a stdio server.
|
|
17
|
+
|
|
18
|
+
## What works out of the box
|
|
19
|
+
|
|
20
|
+
- `new_room`, `open_room` (a Rooms share link), `describe_room`, `list_pieces`
|
|
21
|
+
- `place_piece`, `move_piece`, `turn_piece`, `remove_piece`, `batch`, `furnish` (a whole plan in one call), `undo`
|
|
22
|
+
- `set_surroundings` (time of day, view, lights, paint, floor), `verify`
|
|
23
|
+
- `save_room` (saved on your computer, in `~/.oures/rooms-agent`) and `export_room`: the share link opens the room in
|
|
24
|
+
your browser at oures.co
|
|
25
|
+
- `show_room` (pictures of the room for the agent), once Playwright is installed:
|
|
26
|
+
`npm i -g playwright && npx playwright install chromium`
|
|
27
|
+
|
|
28
|
+
Lengths are metres or a string with a unit (`"180cm"`); turns are degrees.
|
|
29
|
+
|
|
30
|
+
## Shop search and live rooms (from the Oures team)
|
|
31
|
+
|
|
32
|
+
Two things need a key from the Oures team, given to you directly, never in this repo:
|
|
33
|
+
|
|
34
|
+
| Setting | What it turns on |
|
|
35
|
+
|---|---|
|
|
36
|
+
| `OURES_CATALOGUE_KEY` | `search_catalogue` and `furnish` with real shop products and 3D models |
|
|
37
|
+
| `OURES_AGENT_KEY` and `OURES_CONVEX_SITE` | `list_live_rooms` and `open_room({ live })`: the agent works in your own Rooms account, live on any screen where the room is open, as its own person ("Sofa added by Claude") |
|
|
38
|
+
|
|
39
|
+
Add them to the install line:
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
claude mcp add --scope user oures-rooms -e OURES_CATALOGUE_KEY=<key> -e OURES_AGENT_KEY=<key> -e OURES_CONVEX_SITE=<url> -- npx -y @oures/rooms-mcp
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`OURES_AGENT_NAME=codex` makes the room show Codex instead of Claude.
|
|
46
|
+
|
|
47
|
+
## Remove
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
claude mcp remove oures-rooms -s user
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
An agent key stops working everywhere once the Oures team revokes it.
|
|
54
|
+
|
|
55
|
+
## For Oures developers
|
|
56
|
+
|
|
57
|
+
Source and tool list: [README.md](README.md). Build the package with `node agent/package/build.mjs` (in `apps/rooms`),
|
|
58
|
+
then `npm pack` or `npm publish --access public` in `agent/package`.
|