list-charts

Instructions

Implementation Reference

• build/index.js:764-793 (handler)

  The 'list-charts' tool registration and handler. It accepts optional 'filter', 'page', and 'pageSize' parameters. Parses filters using parseFilters(), then makes an authenticated GET request to '/charts' endpoint. Returns the list of charts as JSON text.

  server.tool("list-charts", "List all charts with filtering support", {
      filter: z.string().optional().describe("Filter criteria in the format 'fieldName(operator)=value'. Multiple filters can be combined with & (e.g., 'description(like)=revenue&categoryId(eq)=5'). Available operators: eq, ne, gt, lt, ge, le, like, nlike. Use get-filterable-attributes tool to see available fields."),
      page: z.number().optional().default(1).describe("Page number for pagination"),
      pageSize: z.number().optional().default(20).describe("Number of items per page")
  }, async ({ filter, page, pageSize }) => {
      try {
          let queryParams = {
              page: page.toString(),
              pageSize: pageSize.toString()
          };
          // Parse and add filter parameters
          if (filter) {
              const filterParams = parseFilters(filter);
              queryParams = { ...queryParams, ...filterParams };
          }
          const charts = await authenticatedRequest("/charts", "GET", null, queryParams);
          return {
              content: [{
                      type: "text",
                      text: `Charts retrieved successfully:\n${JSON.stringify(charts, null, 2)}`
                  }]
          };
      }
      catch (error) {
          return {
              isError: true,
              content: [{ type: "text", text: `Error fetching charts: ${getErrorMessage(error)}` }]
          };
      }
  });

• build/index.js:764-768 (schema)

  Schema definition for the 'list-charts' tool. Defines three parameters: filter (optional string), page (optional number, default 1), and pageSize (optional number, default 20).

  server.tool("list-charts", "List all charts with filtering support", {
      filter: z.string().optional().describe("Filter criteria in the format 'fieldName(operator)=value'. Multiple filters can be combined with & (e.g., 'description(like)=revenue&categoryId(eq)=5'). Available operators: eq, ne, gt, lt, ge, le, like, nlike. Use get-filterable-attributes tool to see available fields."),
      page: z.number().optional().default(1).describe("Page number for pagination"),
      pageSize: z.number().optional().default(20).describe("Number of items per page")
  }, async ({ filter, page, pageSize }) => {

• build/index.js:127-142 (helper)

  The parseFilters helper function used by list-charts to parse filter strings in the format 'fieldName(operator)=value'. Supports combining multiple filters with '&'.

  function parseFilters(filterString) {
      const queryParams = {};
      if (!filterString)
          return queryParams;
      // Split by & to handle multiple filters
      const filters = filterString.split('&');
      for (const filter of filters) {
          // Match the pattern fieldName(operator)=value
          const match = filter.match(/([a-zA-Z]+)\(([a-zA-Z]+)\)=(.+)/);
          if (match) {
              const [_, field, operator, value] = match;
              queryParams[`${field}(${operator})`] = value;
          }
      }
      return queryParams;
  }

• build/index.js:57-125 (helper)

  The authenticatedRequest helper function used by list-charts to make authenticated HTTP requests to the API backend. Handles auth headers, query params, orgId, and response parsing.

  async function authenticatedRequest(endpoint, method = "GET", body = null, queryParams = {}) {
      if (!apiUrlSet) {
          throw new Error("API URL not set. Please set the API URL using the set-api-url tool.");
      }
      if (!authToken) {
          throw new Error("Not authenticated. Please authenticate first.");
      }
      // Build URL with query parameters
      let url = `${API_BASE_URL}${endpoint}`;
      // Add orgId if available
      if (orgId !== null) {
          queryParams.orgId = orgId.toString();
      }
      // Add query parameters if any
      if (Object.keys(queryParams).length > 0) {
          const queryString = Object.entries(queryParams)
              .map(([key, value]) => `${encodeURIComponent(key)}=${encodeURIComponent(value)}`)
              .join("&");
          url = `${url}?${queryString}`;
      }
      logInfo(`Making ${method} request to ${url}`);
      const headers = {
          "Authorization": `bearer ${authToken}`,
          "Content-Type": "application/json"
      };
      const options = {
          method,
          headers
      };
      if (body !== null && ["POST", "PUT"].includes(method)) {
          options.body = JSON.stringify(body);
          logInfo(`Request body: ${JSON.stringify(body)}`);
      }
      try {
          const response = await fetch(url, options);
          if (!response.ok) {
              const errorText = await response.text();
              logError(`API request failed with status ${response.status}: ${errorText}`);
              throw new Error(`API request failed with status ${response.status}: ${response.statusText}`);
          }
          // Check if the response is JSON or binary
          const contentType = response.headers.get("content-type") || "";
          if (contentType.includes("application/json")) {
              const jsonData = await response.json();
              logInfo(`Received JSON response: ${JSON.stringify(jsonData).substring(0, 200)}...`);
              return jsonData;
          }
          else if (contentType.includes("text/csv")) {
              // For binary/file responses, return a base64 encoded string
              const buffer = await response.arrayBuffer();
              const base64 = Buffer.from(buffer).toString("base64");
              logInfo(`Received binary response of type ${contentType}, length: ${base64.length}`);
              return {
                  contentType,
                  data: base64
              };
          }
          else {
              // Otherwise, return as text
              const text = await response.text();
              logInfo(`Received text response: ${text.substring(0, 200)}...`);
              return text;
          }
      }
      catch (error) {
          logError(`API request error: ${getErrorMessage(error)}`);
          throw error;
      }
  }