Skip to main content
Glama
liveblocks

Liveblocks

Official
by liveblocks

update-room-subscription-settings

Modify notification preferences for threads and mentions in a Liveblocks collaborative room to control user alerts.

Instructions

Update a Liveblocks room's subscription settings

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roomIdYes
userIdYes
dataYes

Implementation Reference

  • src/server.ts:596-621 (registration)
    Registration of the 'update-room-subscription-settings' tool, including inline input schema (Zod) and handler function that invokes the Liveblocks SDK's updateRoomSubscriptionSettings method wrapped in callLiveblocksApi.
    server.tool(
      "update-room-subscription-settings",
      `Update a Liveblocks room's subscription settings`,
      {
        roomId: z.string(),
        userId: z.string(),
        data: z.object({
          threads: z
            .union([
              z.literal("all"),
              z.literal("replies_and_mentions"),
              z.literal("none"),
            ])
            .optional(),
          textMentions: z.union([z.literal("mine"), z.literal("none")]).optional(),
        }),
      },
      async ({ roomId, userId, data }, extra) => {
        return await callLiveblocksApi(
          getLiveblocks().updateRoomSubscriptionSettings(
            { roomId, userId, data },
            { signal: extra.signal }
          )
        );
      }
    );
  • The core handler logic for executing the tool, which calls the Liveblocks API to update the subscription settings for a user in a room.
    async ({ roomId, userId, data }, extra) => {
      return await callLiveblocksApi(
        getLiveblocks().updateRoomSubscriptionSettings(
          { roomId, userId, data },
          { signal: extra.signal }
        )
      );
    }
  • Zod input schema defining parameters: roomId, userId, and data object with optional threads and textMentions settings.
    {
      roomId: z.string(),
      userId: z.string(),
      data: z.object({
        threads: z
          .union([
            z.literal("all"),
            z.literal("replies_and_mentions"),
            z.literal("none"),
          ])
          .optional(),
        textMentions: z.union([z.literal("mine"), z.literal("none")]).optional(),
      }),
    },
Behavior2/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations provided, the description carries the full burden of behavioral disclosure. It states this is an update operation (implying mutation) but doesn't mention permissions required, whether changes are reversible, rate limits, or what the response looks like. For a mutation tool with zero annotation coverage, this is a significant gap in behavioral context.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is a single, efficient sentence with zero wasted words. It's appropriately sized and front-loaded with the core purpose, making it easy to parse quickly.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a mutation tool with 3 parameters (including nested objects), 0% schema description coverage, no annotations, and no output schema, the description is inadequate. It doesn't compensate for the lack of structured data, leaving critical gaps in understanding how to use the tool effectively or what to expect from it.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 0%, meaning none of the 3 parameters are documented in the schema. The description mentions 'subscription settings' but doesn't explain what parameters like 'roomId', 'userId', or the nested 'data' object with 'threads' and 'textMentions' enums actually represent or how to use them. It adds minimal value beyond the bare schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the action ('Update') and resource ('a Liveblocks room's subscription settings'), providing specific verb+resource pairing. However, it doesn't distinguish this tool from sibling tools like 'update-notification-settings' or 'update-room', which could also involve updating settings or rooms.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides no guidance on when to use this tool versus alternatives like 'update-notification-settings' or 'get-room-subscription-settings'. There's no mention of prerequisites, context, or exclusions, leaving the agent without usage direction.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/liveblocks/liveblocks-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server