search_products

Instructions

Implementation Reference

• mcp-server.js:425-456 (handler)

  The main handler function for the search_products tool that constructs Magento API search criteria for product name matching, fetches results, formats them, and handles errors.

  async ({ query, page_size = 10, current_page = 1 }) => {
    try {
      // Build search criteria for a simple name search
      const searchCriteria = `searchCriteria[filter_groups][0][filters][0][field]=name&` +
                            `searchCriteria[filter_groups][0][filters][0][value]=%25${encodeURIComponent(query)}%25&` +
                            `searchCriteria[filter_groups][0][filters][0][condition_type]=like&` +
                            `searchCriteria[pageSize]=${page_size}&` +
                            `searchCriteria[currentPage]=${current_page}`;
      
      const productData = await callMagentoApi(`/products?${searchCriteria}`);
      const formattedResults = formatSearchResults(productData);
      
      return {
        content: [
          {
            type: "text",
            text: JSON.stringify(formattedResults, null, 2)
          }
        ]
      };
    } catch (error) {
      return {
        content: [
          {
            type: "text",
            text: `Error searching products: ${error.message}`
          }
        ],
        isError: true
      };
    }
  }

• mcp-server.js:420-424 (schema)

  Zod schema defining input parameters: query (required string), page_size and current_page (optional numbers).

  {
    query: z.string().describe("Search query (product name, description, etc.)"),
    page_size: z.number().optional().describe("Number of results per page (default: 10)"),
    current_page: z.number().optional().describe("Page number (default: 1)")
  },

• mcp-server.js:417-457 (registration)

  MCP server.tool registration call that defines the tool name, description, input schema, and handler function.

  server.tool(
    "search_products",
    "Search for products using Magento search criteria",
    {
      query: z.string().describe("Search query (product name, description, etc.)"),
      page_size: z.number().optional().describe("Number of results per page (default: 10)"),
      current_page: z.number().optional().describe("Page number (default: 1)")
    },
    async ({ query, page_size = 10, current_page = 1 }) => {
      try {
        // Build search criteria for a simple name search
        const searchCriteria = `searchCriteria[filter_groups][0][filters][0][field]=name&` +
                              `searchCriteria[filter_groups][0][filters][0][value]=%25${encodeURIComponent(query)}%25&` +
                              `searchCriteria[filter_groups][0][filters][0][condition_type]=like&` +
                              `searchCriteria[pageSize]=${page_size}&` +
                              `searchCriteria[currentPage]=${current_page}`;
        
        const productData = await callMagentoApi(`/products?${searchCriteria}`);
        const formattedResults = formatSearchResults(productData);
        
        return {
          content: [
            {
              type: "text",
              text: JSON.stringify(formattedResults, null, 2)
            }
          ]
        };
      } catch (error) {
        return {
          content: [
            {
              type: "text",
              text: `Error searching products: ${error.message}`
            }
          ],
          isError: true
        };
      }
    }
  );

• mcp-server.js:364-380 (helper)

  Helper function used by the handler to format raw Magento product search results into a simplified structure with essential fields.

  function formatSearchResults(results) {
    if (!results || !results.items || !Array.isArray(results.items)) {
      return "No products found";
    }
    
    return {
      total_count: results.total_count,
      items: results.items.map(item => ({
        id: item.id,
        sku: item.sku,
        name: item.name,
        price: item.price,
        status: item.status,
        type_id: item.type_id
      }))
    };
  }