Skip to main content
Glama

get-message-read-receipts

Retrieve a list of users who have read a specific message by providing its unique ID.

Instructions

Get list of users who have read a specific message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
message_idYesUnique message ID to get read receipts for

Implementation Reference

  • The MCP server tool handler for 'get-message-read-receipts'. Calls zulipClient.getMessageReadReceipts(message_id) and returns a JSON response with message_id, read_by_count, and user_ids.
    server.tool(
      "get-message-read-receipts",
      "Get list of users who have read a specific message.",
      GetMessageReadReceiptsSchema.shape,
      async ({ message_id }) => {
        try {
          const result = await zulipClient.getMessageReadReceipts(message_id);
          return createSuccessResponse(JSON.stringify({
            message_id,
            read_by_count: result.user_ids.length,
            user_ids: result.user_ids
          }, null, 2));
        } catch (error) {
          return createErrorResponse(`Error getting read receipts: ${error instanceof Error ? error.message : 'Unknown error'}`);
        }
      }
  • Zod schema defining the input for get-message-read-receipts: requires a message_id (number).
    export const GetMessageReadReceiptsSchema = z.object({
      message_id: z.number().describe("Unique message ID to get read receipts for")
    });
  • TypeScript type inferred from GetMessageReadReceiptsSchema.
    export type GetMessageReadReceiptsParams = z.infer<typeof GetMessageReadReceiptsSchema>;
  • ZulipClient method that makes the actual API call to GET /messages/{messageId}/read_receipts and returns the response data.
    async getMessageReadReceipts(messageId: number): Promise<{ user_ids: number[] }> {
      const response = await this.client.get(`/messages/${messageId}/read_receipts`);
      return response.data;
    }
  • src/server.ts:621-637 (registration)
    Tool registered with the MCP server using server.tool() with name 'get-message-read-receipts'.
    server.tool(
      "get-message-read-receipts",
      "Get list of users who have read a specific message.",
      GetMessageReadReceiptsSchema.shape,
      async ({ message_id }) => {
        try {
          const result = await zulipClient.getMessageReadReceipts(message_id);
          return createSuccessResponse(JSON.stringify({
            message_id,
            read_by_count: result.user_ids.length,
            user_ids: result.user_ids
          }, null, 2));
        } catch (error) {
          return createErrorResponse(`Error getting read receipts: ${error instanceof Error ? error.message : 'Unknown error'}`);
        }
      }
    );
Behavior2/5

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

No annotations are provided, so the description carries full responsibility. It does not disclose what happens if the message_id is invalid, whether the list is empty or includes user details, or any permissions needed. The description is too brief for a mutation-free read operation.

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

Conciseness4/5

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

The description is a single sentence with no wasted words. However, it could be more informative without losing conciseness, such as mentioning the output format.

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

Completeness3/5

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

Given the simplicity of the tool (one required parameter, no output schema, no annotations), the description is minimally adequate. It states the purpose and the parameter, but lacks details about the response format and error conditions.

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 parameter 'message_id' is fully described in the schema as 'Unique message ID to get read receipts for.' The description adds no extra meaning beyond the schema, and with 100% schema coverage, a baseline of 3 is appropriate.

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

Purpose5/5

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

The description clearly states the tool's purpose: 'Get list of users who have read a specific message.' It uses a specific verb ('Get') and resource ('list of users'), and it distinguishes itself from sibling tools like 'add-emoji-reaction' or 'send-message' by focusing solely on read receipts.

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 vs. alternatives, such as when to use it over other message-related tools. It does not mention prerequisites (e.g., message must exist) or conditions for use.

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/avisekrath/zulip-mcp-server'

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