get-collections

Instructions

Implementation Reference

• src/index.ts:523-537 (handler)

  The handler function for the 'get-collections' tool. It creates a ShopifyClient instance, calls loadCollections with the provided limit and name filters, and returns the collections as JSON or an error response.

  async ({ limit, name }) => {
    const client = new ShopifyClient();
    try {
      const collections = await client.loadCollections(
        SHOPIFY_ACCESS_TOKEN,
        MYSHOPIFY_DOMAIN,
        { limit, name }
      );
      return {
        content: [{ type: "text", text: JSON.stringify(collections, null, 2) }],
      };
    } catch (error) {
      return handleError("Failed to retrieve collections", error);
    }
  }

• src/index.ts:516-522 (schema)

  Zod schema defining the input parameters for the 'get-collections' tool: optional limit (default 10) and optional name filter.

    limit: z
      .number()
      .optional()
      .default(10)
      .describe("Maximum number of collections to return"),
    name: z.string().optional().describe("Filter collections by name"),
  },

• src/index.ts:512-538 (registration)

  The server.tool registration for the 'get-collections' tool, including name, description, input schema, and inline handler function.

  server.tool(
    "get-collections",
    "Get all collections",
    {
      limit: z
        .number()
        .optional()
        .default(10)
        .describe("Maximum number of collections to return"),
      name: z.string().optional().describe("Filter collections by name"),
    },
    async ({ limit, name }) => {
      const client = new ShopifyClient();
      try {
        const collections = await client.loadCollections(
          SHOPIFY_ACCESS_TOKEN,
          MYSHOPIFY_DOMAIN,
          { limit, name }
        );
        return {
          content: [{ type: "text", text: JSON.stringify(collections, null, 2) }],
        };
      } catch (error) {
        return handleError("Failed to retrieve collections", error);
      }
    }
  );

• src/ShopifyClient/ShopifyClient.ts:914-976 (helper)

  The loadCollections method in ShopifyClient, which implements the core logic for fetching both custom and smart collections from Shopify's REST API, supporting limit, name filters, and pagination via 'next'.

  async loadCollections(
    accessToken: string,
    shop: string,
    queryParams: ShopifyCollectionsQueryParams,
    next?: string
  ): Promise<LoadCollectionsResponse> {
    const nextList = next?.split(",");
    const customNext = nextList?.[0];
    const smartNext = nextList?.[1];
    let customCollections: ShopifyCollection[] = [];
    let customCollectionsNextPage;
    let smartCollections: ShopifyCollection[] = [];
    let smartCollectionsNextPage;
  
    if (customNext !== "undefined") {
      const customRes =
        await this.shopifyHTTPRequest<ShopifyCustomCollectionsResponse>({
          method: "GET",
          url: `https://${shop}/admin/api/${this.SHOPIFY_API_VERSION}/custom_collections.json`,
          accessToken,
          params: {
            limit: queryParams.limit,
            page_info: customNext,
            title: customNext ? undefined : queryParams.name,
            since_id: customNext ? undefined : queryParams.sinceId,
          },
        });
  
      customCollections = customRes.data?.custom_collections || [];
  
      customCollectionsNextPage = ShopifyClient.getShopifyOrdersNextPage(
        customRes.headers?.get("link")
      );
    }
    if (smartNext !== "undefined") {
      const smartRes =
        await this.shopifyHTTPRequest<ShopifySmartCollectionsResponse>({
          method: "GET",
          url: `https://${shop}/admin/api/${this.SHOPIFY_API_VERSION}/smart_collections.json`,
          accessToken,
          params: {
            limit: queryParams.limit,
            page_info: smartNext,
            title: smartNext ? undefined : queryParams.name,
            since_id: smartNext ? undefined : queryParams.sinceId,
          },
        });
  
      smartCollections = smartRes.data?.smart_collections || [];
  
      smartCollectionsNextPage = ShopifyClient.getShopifyOrdersNextPage(
        smartRes.headers?.get("link")
      );
    }
    const collections = [...customCollections, ...smartCollections];
  
    if (customCollectionsNextPage || smartCollectionsNextPage) {
      next = `${customCollectionsNextPage},${smartCollectionsNextPage}`;
    } else {
      next = undefined;
    }
    return { collections, next };
  }

• src/ShopifyClient/ShopifyClientPort.ts:336-339 (schema)

  Type definition for the output of loadCollections, used by the tool handler.

    collections: ShopifyCollection[];
    next?: string;
  };