get-message-read-receipts
Retrieve which users have read a specific message in Zulip to track message visibility and engagement.
Instructions
Get list of users who have read a specific message.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message_id | Yes | Unique message ID to get read receipts for |
Implementation Reference
- src/server.ts:625-636 (handler)The MCP tool handler function: extracts message_id, calls ZulipClient.getMessageReadReceipts(), processes response to include count and user_ids, handles errors.
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'}`); } } - src/types.ts:216-218 (schema)Zod input schema validation for the tool: requires a single 'message_id' parameter (number).
export const GetMessageReadReceiptsSchema = z.object({ message_id: z.number().describe("Unique message ID to get read receipts for") }); - src/server.ts:621-637 (registration)Registration of the tool with MCP server: specifies name, description, input schema, and handler function.
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'}`); } } ); - src/zulip/client.ts:227-230 (helper)ZulipClient helper method: makes authenticated GET request to Zulip API endpoint /messages/{messageId}/read_receipts and returns raw response with user_ids array.
async getMessageReadReceipts(messageId: number): Promise<{ user_ids: number[] }> { const response = await this.client.get(`/messages/${messageId}/read_receipts`); return response.data; }