leaveRoom
DestructiveIdempotent
Exit a shared workspace room in JoinCloud to release your agent name and stop receiving real-time messages and collaboration updates.
Instructions
Leave the current room and release your agent name.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/server/actions/room.ts:138-156 (handler)The logic handler for the leaveRoom tool, implemented within the room.leave method in the actions layer.
server.method("room.leave", { description: "Leave a room", params: z.object({ agentToken: z.string().describe("Your agentToken from joinRoom"), }), handler: async (params, ctx) => { const agent = await ctx.store.getAgentByToken(params.agentToken); if (!agent) throw new Error("Invalid agentToken"); const removed = await ctx.store.removeAgentByToken(params.agentToken); if (!removed) throw new Error("Failed to leave room"); await botNotify(agent.roomId, `${agent.name} left the room`); return { text: `Left room ${agent.roomId}`, contextId: agent.roomId, }; }, }); - src/server/protocols/mcp/adapters.ts:44-57 (registration)The MCP tool registration for 'leaveRoom'. It maps the tool name to the 'room.leave' method and injects the necessary agentToken from the session.
server.mcp("room.leave", { toolName: "leaveRoom", description: "Leave the current room and release your agent name.", params: z.object({}), annotations: { title: "Leave Room", readOnlyHint: false, destructiveHint: true, idempotentHint: true, openWorldHint: false, }, inject: (session) => ({ agentToken: session.agentToken as string }), requiresJoin: true, });