Skip to main content
Glama
YCloud-Developers

YCloud WhatsApp API MCP Server

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
NameRequiredDescriptionDefault
idYes

Implementation Reference

  • 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)
            }]
          };
        }
      }
    );
  • 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);
Behavior2/5

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

No annotations are provided, so the description carries full burden. 'Mark message as read' implies a mutation (changing read status), but it doesn't disclose behavioral traits such as required permissions, whether it's idempotent, error handling, or side effects. This is a significant gap for a mutation tool with zero annotation coverage.

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 with zero waste—'Mark message as read' directly conveys the core action. It's appropriately sized and front-loaded, making it easy to parse without unnecessary elaboration.

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?

Given the tool's mutation nature, lack of annotations, no output schema, and incomplete parameter documentation, the description is insufficient. It doesn't cover return values, error cases, or operational context (e.g., how it interacts with other WhatsApp tools), making it incomplete for safe and effective use.

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 1 parameter with 0% description coverage, and the tool description adds no meaning beyond the schema. It doesn't explain what 'id' represents (e.g., message ID from retrieval), its format, or constraints. With low schema coverage, the description fails to compensate, leaving the parameter undocumented.

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 'Mark message as read' clearly states the action (mark) and the resource (message) with a specific state change (as read). It distinguishes from siblings like wa_msg_retrieve or wa_msg_send by focusing on updating read status rather than retrieving or sending messages. However, it doesn't explicitly differentiate from all siblings (e.g., other update operations), keeping it at 4 instead of 5.

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. It doesn't mention prerequisites (e.g., needing a message ID from retrieval), exclusions, or comparisons to other tools like wa_msg_retrieve for checking status. This lack of context leaves usage unclear beyond the basic action.

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/YCloud-Developers/ycloud-whatsapp-mcp-server'

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