Skip to main content
Glama

get_lists

Retrieve and filter customer lists from Klaviyo with pagination controls to manage marketing audience data.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
filterNoFilter query for lists
page_sizeNoNumber of lists per page (1-100)
page_cursorNoCursor for pagination

Implementation Reference

  • Handler function for the 'get_lists' tool. Fetches lists from Klaviyo API using the generic klaviyoClient.get method, formats the response as a JSON string in a text content block, and handles errors by returning an error message.
    async (params) => {
      try {
        const lists = await klaviyoClient.get('/lists/', params);
        return {
          content: [{ type: "text", text: JSON.stringify(lists, null, 2) }]
        };
      } catch (error) {
        return {
          content: [{ type: "text", text: `Error retrieving lists: ${error.message}` }],
          isError: true
        };
      }
    },
  • Zod schema defining the input parameters for the 'get_lists' tool: optional filter string, page_size (1-100), and page_cursor for pagination.
    {
      filter: z.string().optional().describe("Filter query for lists"),
      page_size: z.number().min(1).max(100).optional().describe("Number of lists per page (1-100)"),
      page_cursor: z.string().optional().describe("Cursor for pagination")
    },
  • Direct registration of the 'get_lists' tool using server.tool(), specifying the name, input schema, execution handler, and description.
    server.tool(
      "get_lists",
      {
        filter: z.string().optional().describe("Filter query for lists"),
        page_size: z.number().min(1).max(100).optional().describe("Number of lists per page (1-100)"),
        page_cursor: z.string().optional().describe("Cursor for pagination")
      },
      async (params) => {
        try {
          const lists = await klaviyoClient.get('/lists/', params);
          return {
            content: [{ type: "text", text: JSON.stringify(lists, null, 2) }]
          };
        } catch (error) {
          return {
            content: [{ type: "text", text: `Error retrieving lists: ${error.message}` }],
            isError: true
          };
        }
      },
      { description: "Get lists from Klaviyo" }
    );
  • src/server.js:33-33 (registration)
    Top-level invocation of registerListTools(server), which registers the 'get_lists' tool (and other list-related tools).
    registerListTools(server);
  • Generic 'get' helper function used by the handler. Builds the API URL with query parameters (filter, page_size, page_cursor), performs the axios GET request via executeWithRetry (with caching, rate limiting retries), and handles Klaviyo-specific API formatting.
    export async function get(endpoint, params = {}, fallbackFn) {
      // Build the URL with query parameters according to Klaviyo API specs
      let url = endpoint;
      const queryParams = [];
      
      // Special handling for campaign endpoint - add required filter if missing
      if (endpoint === '/campaigns/' && !params.filter) {
        logger.debug('Adding default email filter for campaigns endpoint');
        params.filter = "equals(messages.channel,'email')";
      }
      
      // Handle filter parameter if provided
      if (params.filter) {
        queryParams.push(`filter=${encodeURIComponent(params.filter)}`);
      }
      
      // Handle include parameter if provided
      if (params.include) {
        queryParams.push(`include=${encodeURIComponent(params.include)}`);
      }
      
      // Handle page_size parameter if provided
      if (params.page_size) {
        queryParams.push(`page[size]=${params.page_size}`);
      }
      
      // Handle pagination cursor if provided
      if (params.page_cursor) {
        queryParams.push(`page[cursor]=${params.page_cursor}`);
      }
      
      // Add query parameters to URL
      if (queryParams.length > 0) {
        url = `${endpoint}?${queryParams.join('&')}`;
      }
      
      logger.debug(`Prepared GET request to: ${url}`);
      
      return executeWithRetry(
        () => client.get(url),
        'GET',
        endpoint,
        params,
        fallbackFn
      );
    }
Behavior1/5

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

Tool has no description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness1/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Tool has no description.

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?

Tool has no description.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters1/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Tool has no description.

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

Purpose1/5

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

Tool has no description.

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?

Tool has no description.

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/ivan-rivera-projects/Klaviyo-MCP-Server-Enhanced'

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