wa_inbound_mark
Mark inbound WhatsApp messages as read to update message status and manage conversations through the YCloud WhatsApp API.
Instructions
Mark message as read
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes |
Implementation Reference
- src/tools.ts:160-216 (handler)The core handler function for the 'wa_inbound_mark' tool (shared with all YCloud API tools). It constructs an HTTP request based on the OpenAPI path/method and proxies the call to the YCloud API using axios, returning the JSON response.async (args: Record<string, any>) => { try { // 解析URL中的路径参数 let url = `${apiBaseUrl}${path}`; Object.keys(args).forEach(key => { if (path.includes(`{${key}}`)) { url = url.replace(`{${key}}`, encodeURIComponent(String(args[key]))); delete args[key]; } }); // 提取请求体和查询参数 const { body, ...queryParams } = args as Record<string, any>; // 设置请求选项 const requestOptions: any = { url, method: method.toUpperCase(), headers: { 'Content-Type': 'application/json', ...headers }, params: Object.keys(queryParams).length > 0 ? queryParams : undefined, data: body, }; // 发送请求 const response = await axios(requestOptions); return { content: [{ type: 'text' as const, text: JSON.stringify(response.data, null, 2) }] }; } catch (error: unknown) { if (axios.isAxiosError(error) && error.response) { return { content: [{ type: 'text' as const, text: JSON.stringify({ error: true, status: error.response.status, message: error.response.data?.message || error.message, data: error.response.data }, null, 2) }] }; } return { content: [{ type: 'text' as const, text: JSON.stringify({ error: true, message: error instanceof Error ? error.message : String(error) }, null, 2) }] }; } } );
- src/tools.ts:9-50 (schema)Extracts input schema (using Zod) for tool parameters from the OpenAPI operation's parameters (path, query, body). Used to define the input schema for 'wa_inbound_mark' and other tools.function extractParamsSchema(operation: any): any { const properties: Record<string, any> = {}; const required: string[] = []; // 处理路径参数 if (operation.parameters) { operation.parameters.forEach((param: any) => { if (param.in === 'path' || param.in === 'query') { let schema; switch (param.schema?.type) { case 'string': schema = z.string(); break; case 'integer': schema = z.number().int(); break; case 'number': schema = z.number(); break; case 'boolean': schema = z.boolean(); break; default: schema = z.any(); } properties[param.name] = schema; if (param.required) { required.push(param.name); } } }); } // 处理请求体 if (operation.requestBody) { properties['body'] = z.any(); required.push('body'); } return properties; }
- src/tools.ts:106-109 (registration)Dynamic tool name generation for inbound message actions. For OpenAPI operations like 'whatsapp_inbound_message-mark', sets operationId to 'wa_inbound_mark'.// 从operationId中提取动作部分 const action = operationId.split('-')[1] || ''; operationId = `wa_inbound_${action}`; } else if (operationId.includes('whatsapp_message_send_directly')) {
- src/tools.ts:156-219 (registration)Registers the tool (including 'wa_inbound_mark') with MCP server using the generated name, description from OpenAPI summary, extracted params schema, and generic proxy handler.server.tool( toolName, description, paramsSchema, async (args: Record<string, any>) => { try { // 解析URL中的路径参数 let url = `${apiBaseUrl}${path}`; Object.keys(args).forEach(key => { if (path.includes(`{${key}}`)) { url = url.replace(`{${key}}`, encodeURIComponent(String(args[key]))); delete args[key]; } }); // 提取请求体和查询参数 const { body, ...queryParams } = args as Record<string, any>; // 设置请求选项 const requestOptions: any = { url, method: method.toUpperCase(), headers: { 'Content-Type': 'application/json', ...headers }, params: Object.keys(queryParams).length > 0 ? queryParams : undefined, data: body, }; // 发送请求 const response = await axios(requestOptions); return { content: [{ type: 'text' as const, text: JSON.stringify(response.data, null, 2) }] }; } catch (error: unknown) { if (axios.isAxiosError(error) && error.response) { return { content: [{ type: 'text' as const, text: JSON.stringify({ error: true, status: error.response.status, message: error.response.data?.message || error.message, data: error.response.data }, null, 2) }] }; } return { content: [{ type: 'text' as const, text: JSON.stringify({ error: true, message: error instanceof Error ? error.message : String(error) }, null, 2) }] }; } } ); registeredTools.add(toolName); registeredToolsCount++; }
- src/index.ts:43-43 (registration)Invokes the tool registration function, loading OpenAPI spec and registering all YCloud WhatsApp API tools including 'wa_inbound_mark'.await registerYCloudTools(server, openApiSpec, apiBaseUrl, headers);