Skip to main content
Glama
liveblocks

Liveblocks

Official
by liveblocks

get-active-users

Retrieve real-time active user data from Liveblocks collaboration rooms to monitor engagement and manage room capacity.

Instructions

Get a Liveblocks room's active users

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
roomIdYes

Implementation Reference

  • src/server.ts:162-173 (registration)
    Registration of the 'get-active-users' MCP tool, including input schema (roomId: string) and inline handler function that calls the Liveblocks API via getLiveblocks().getActiveUsers and formats response with callLiveblocksApi.
    server.tool(
      "get-active-users",
      "Get a Liveblocks room's active users",
      {
        roomId: z.string(),
      },
      async ({ roomId }, extra) => {
        return await callLiveblocksApi(
          getLiveblocks().getActiveUsers(roomId, { signal: extra.signal })
        );
      }
    );
  • The handler function executing the tool logic: fetches active users for the given roomId using Liveblocks client, wrapped in callLiveblocksApi for MCP response formatting.
    async ({ roomId }, extra) => {
      return await callLiveblocksApi(
        getLiveblocks().getActiveUsers(roomId, { signal: extra.signal })
      );
    }
  • Input schema for the tool: requires a roomId string.
    {
      roomId: z.string(),
    },
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 the tool retrieves active users but doesn't describe what 'active' means, whether this is real-time or cached data, authentication requirements, rate limits, or what format the response takes. This leaves significant behavioral gaps.

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 that gets straight to the point with no wasted words. It's appropriately sized for a simple retrieval tool and front-loads the core functionality.

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 no annotations, no output schema, and 0% schema description coverage, the description is insufficient. It doesn't explain what 'active users' means in this context, what data is returned, or any behavioral characteristics. The description should provide more context given the lack of structured documentation.

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

Parameters3/5

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

The description mentions 'room' which aligns with the 'roomId' parameter in the schema, but adds no additional semantic context about what a roomId is, format requirements, or where to find it. With 0% schema description coverage, the description provides minimal compensation for the undocumented parameter.

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 active users'), making the purpose immediately understandable. It doesn't explicitly distinguish from sibling tools like 'get-room' or 'get-thread-participants', but the specificity of 'active users' provides some differentiation.

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 'get-room' or 'get-thread-participants', nor does it mention prerequisites or context for usage. It simply states what the tool does without any usage context.

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