Skip to main content
Glama
YCloud-Developers

YCloud WhatsApp API MCP Server

wa_template_get

Retrieve WhatsApp message templates from the YCloud API by specifying template name and language for automated messaging workflows.

Instructions

Retrieve a template

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
languageYes

Implementation Reference

  • Generic handler for all YCloud WhatsApp tools including 'wa_template_get'. Builds and sends HTTP request using Axios based on OpenAPI path and method, returns JSON response or error.
    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)
          }]
        };
      }
    }
  • Generates Zod schema properties for tool parameters from OpenAPI operation (path/query params and body). Used for 'wa_template_get' input validation.
    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:90-92 (registration)
    Maps original long OpenAPI operationIds for template retrieval to the tool name 'wa_template_get'.
    } else if (operationId.includes('template-retrieve-by-name-and-language') || 
              operationId.includes('whatsapp_template-retrieve-by-name-and-language')) {
      operationId = 'wa_template_get';
  • src/tools.ts:154-219 (registration)
    Registers the 'wa_template_get' tool on the MCP server with name, description, input schema, and handler function if not already registered.
    // 检查工具名称是否已注册
    if (!registeredTools.has(toolName)) {
      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:42-43 (registration)
    Loads OpenAPI spec and calls registerYCloudTools to register all tools including 'wa_template_get'.
    const openApiSpec = await loadOpenApiSpec(openApiSpecPath);
    await registerYCloudTools(server, openApiSpec, apiBaseUrl, headers);
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. 'Retrieve' implies a read-only operation, but it doesn't specify whether authentication is needed, if there are rate limits, what happens on failure (e.g., missing template), or the format of the returned data. This leaves significant gaps in understanding the tool's behavior beyond the basic action.

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 extremely concise with just two words, 'Retrieve a template', which is front-loaded and wastes no space. However, this brevity comes at the cost of completeness, but as per scoring rules, conciseness is evaluated independently based on efficiency, which is high here.

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

Completeness1/5

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

Given the tool's complexity (2 required parameters, no annotations, no output schema, and 0% schema description coverage), the description is completely inadequate. It doesn't explain what a template is in this context, how parameters are used, what the tool returns, or how it differs from siblings, leaving the agent with insufficient information to use the tool effectively.

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 2 required parameters (name, language) with 0% description coverage, meaning the schema provides no semantic information. The description 'Retrieve a template' adds no details about what these parameters represent (e.g., template identifier, language code), their formats, or constraints, failing to compensate for the schema's lack of documentation.

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

Purpose2/5

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

The description 'Retrieve a template' is a tautology that essentially restates the tool name 'wa_template_get' with minimal added value. While it indicates the action (retrieve) and resource (template), it lacks specificity about what kind of template or what retrieval entails, and doesn't differentiate from sibling tools like 'wa_template_list' or 'wa_template_retrieve' (if that existed).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines1/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 sibling tools like 'wa_template_list' for listing templates or 'wa_template_retrieve' (implied by context), nor does it specify prerequisites or contexts for retrieval, leaving the agent with no usage direction.

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