Skip to main content
Glama
liveblocks

Liveblocks

Official
by liveblocks

get-room-subscription-settings

Retrieve subscription settings for a specific Liveblocks room to manage user access and permissions.

Instructions

Get a Liveblocks room's subscription settings

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roomIdYes
userIdYes

Implementation Reference

  • Handler function for the 'get-room-subscription-settings' tool. Calls the Liveblocks SDK's getRoomSubscriptionSettings method wrapped in callLiveblocksApi.
    async ({ roomId, userId }, extra) => {
      return await callLiveblocksApi(
        getLiveblocks().getRoomSubscriptionSettings(
          { roomId, userId },
          { signal: extra.signal }
        )
      );
    }
  • Input schema for the tool using Zod: requires roomId and userId as strings.
    {
      roomId: z.string(),
      userId: z.string(),
    },
  • src/server.ts:579-594 (registration)
    Registration of the 'get-room-subscription-settings' tool on the MCP server, including description, schema, and inline handler.
    server.tool(
      "get-room-subscription-settings",
      `Get a Liveblocks room's subscription settings`,
      {
        roomId: z.string(),
        userId: z.string(),
      },
      async ({ roomId, userId }, extra) => {
        return await callLiveblocksApi(
          getLiveblocks().getRoomSubscriptionSettings(
            { roomId, userId },
            { signal: extra.signal }
          )
        );
      }
    );
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 only states the read operation ('Get') without mentioning potential side effects, authentication requirements, rate limits, or the format of returned data. This leaves significant gaps for a tool that likely involves API calls.

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, direct sentence that efficiently conveys the core action without unnecessary words. It's front-loaded and wastes no space, 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 tool with 2 parameters, no annotations, no output schema, and 0% schema coverage, the description is insufficient. It doesn't cover parameter meanings, behavioral traits, or return values, leaving the agent with inadequate information to use the tool effectively beyond its basic purpose.

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?

The input schema has 0% description coverage, and the tool description provides no information about the parameters 'roomId' and 'userId'. It doesn't explain what these IDs represent, their format, or how they relate to fetching subscription settings, failing to compensate for the schema's lack of details.

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 ('Get') and resource ('a Liveblocks room's subscription settings'), making the purpose immediately understandable. It doesn't explicitly differentiate from its sibling 'get-user-room-subscription-settings', which handles user-specific settings, but the core functionality is well-defined.

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?

No guidance is provided on when to use this tool versus alternatives like 'get-user-room-subscription-settings' or 'get-room' for general room info. The description lacks context about prerequisites, such as needing specific permissions or when subscription settings are relevant.

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