Skip to main content
Glama
YCloud-Developers

YCloud WhatsApp API MCP Server

wa_phone_register

Register a phone number with YCloud WhatsApp API to enable messaging capabilities for business accounts.

Instructions

Register a phone number

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
wabaIdYes
phoneNumberYes

Implementation Reference

  • Generic handler function used for all YCloud WhatsApp API tools, including 'wa_phone_register'. It constructs and sends an HTTP request to the corresponding API endpoint based on the OpenAPI path and method, handles path/query/body params, and returns the response or error as text.
    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)
          }]
        };
      }
    }
  • Helper function to extract input schema (parameters and request body) from OpenAPI operation object using Zod schemas. Used to define the input schema for the 'wa_phone_register' tool.
    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:121-122 (registration)
    Maps the original OpenAPI operationId containing 'whatsapp_phone_number_register' to the shortened MCP tool name 'wa_phone_register'.
    } else if (operationId.includes('whatsapp_phone_number_register')) {
      operationId = 'wa_phone_register';
  • src/tools.ts:156-216 (registration)
    Registers the MCP tool named 'toolName' (which is 'wa_phone_register' for the matching operation) with description, input schema, and the generic HTTP 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)
            }]
          };
        }
      }
    );
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. 'Register a phone number' implies a write operation, but it doesn't specify permissions required, whether it's idempotent, rate limits, or what happens on success/failure. This is inadequate 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. It's appropriately sized and front-loaded, making it easy to scan. Every word earns its place by conveying the core action without fluff.

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 complexity (a mutation operation with 2 parameters), no annotations, no output schema, and 0% schema coverage, the description is incomplete. It lacks details on behavior, parameters, and expected outcomes, making it insufficient for reliable agent 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?

Schema description coverage is 0%, so the description must compensate by explaining parameters. It adds no meaning beyond the schema—it doesn't clarify what 'wabaId' or 'phoneNumber' represent, their formats, or examples. With 2 undocumented parameters, this is a significant gap.

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 'Register a phone number' clearly states the action (register) and resource (phone number), which is specific and unambiguous. However, it doesn't differentiate from sibling tools like 'wa_phone_list' or 'wa_phone_retrieve', which handle listing or retrieving phone numbers rather than registering them.

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. For example, it doesn't mention prerequisites like needing a WABA ID from 'wa_business_list' or 'wa_business_retrieve', or when to use 'wa_phone_update_profile' instead. This lack of context leaves usage unclear.

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