vinzenz/hyperhive
vinzenz/hyperhive
Watch
0
0
Fork
You've already forked hyperhive
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: fix matrix tool signatures per damocles nits (room not room_id, no format?, member_count not unread)

Browse source
This commit is contained in:
lexis 2026-05-29 21:02:25 +02:00
commit 7aadf38483
2 changed files with 16 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -151,7 +151,8 @@ the container as environment variables. Common options:
auto-injects `hive-matrix-mcp` as a stdio MCP server so claude can auto-injects `hive-matrix-mcp` as a stdio MCP server so claude can
call the matrix tools (`mcp__matrix__send_message`, `send_dm`, call the matrix tools (`mcp__matrix__send_message`, `send_dm`,
`send_reaction`, `send_reply`, `mark_read`, `list_rooms`, `send_reaction`, `send_reply`, `mark_read`, `list_rooms`,
`list_room_members`, `read_room`). Silently no-ops when `list_room_members`, `read_room`; `room` args accept both
`!id:server` and `#alias:server` forms). Silently no-ops when
`<state>/matrix-token` is absent (i.e., the host-level `<state>/matrix-token` is absent (i.e., the host-level
`hyperhive.matrix` tuwunel container hasn't provisioned the account `hyperhive.matrix` tuwunel container hasn't provisioned the account
yet). Set to `false` to opt a specific agent out of matrix. yet). Set to `false` to opt a specific agent out of matrix.

23
docs/turn-loop.md
View file

@ -290,21 +290,26 @@ When `hyperhive.matrix.enable = true` (default) and the host-level
matrix tuwunel is configured, the harness auto-injects `hive-matrix-mcp` matrix tuwunel is configured, the harness auto-injects `hive-matrix-mcp`
as a second stdio MCP server. Tools land as `mcp__matrix__<name>`: as a second stdio MCP server. Tools land as `mcp__matrix__<name>`:
- `send_message(room_id, body, format?)` — send a plain or markdown message - `send_message(room, body)` — send a markdown message; `room` accepts
- `send_dm(user_id, body, format?)` — send a direct message to a matrix user `!id:server` or `#alias:server`, daemon resolves either
- `send_reaction(room_id, event_id, key)` — react to a message - `send_dm(user_id, body)` — send a direct message to a matrix user
- `send_reply(room_id, event_id, body, format?)` — threaded reply - `send_reaction(room, event_id, key)` — react to a message
- `mark_read(room_id, event_id)` — advance the read receipt - `send_reply(room, event_id, body)` — threaded reply
- `list_rooms()` — enumerate joined rooms (id + name + unread count) - `mark_read(room, event_id)` — advance the read receipt
- `list_room_members(room_id)` — members of a room - `list_rooms()` — enumerate joined rooms
- `read_room(room_id, limit?)` — recent timeline events (`{ id, canonical_alias, name, member_count }` per room)
- `list_room_members(room)` — members of a room
- `read_room(room, limit?)` — recent timeline events
The daemon (`hive-matrix-daemon`) holds the long-running matrix-sdk The daemon (`hive-matrix-daemon`) holds the long-running matrix-sdk
`Client` + sync loop; the stdio bridge (`hive-matrix-mcp`) is spawned `Client` + sync loop; the stdio bridge (`hive-matrix-mcp`) is spawned
per turn and forwards tool calls over `/run/hive-matrix.sock`. Both per turn and forwards tool calls over `/run/hive-matrix.sock`. Both
silently exit when `<state>/matrix-token` is absent (account not yet silently exit when `<state>/matrix-token` is absent (account not yet
provisioned). Incoming room events wake the agent via `AgentRequest::Wake` provisioned). Incoming room events wake the agent via `AgentRequest::Wake`
with `from: "matrix"` and a teaser body (`[matrix] @sender in #room: …`). with `from: "matrix"` and a teaser body
(`[matrix] <sender> in <room>: <first-100c>…` where `<sender>` is
the matrix user id and `<room>` is the alias or id as reported by
the SDK).
### Extra MCP servers (per-agent) ### Extra MCP servers (per-agent)