Skip to main content
Glama

generate_funnel_chart

Read-only

Visualize progressive data reduction across stages like conversion rates from website visits to purchases using funnel charts.

Instructions

Generate a funnel chart to visualize the progressive reduction of data as it passes through stages, such as, the conversion rates of users from visiting a website to completing a purchase.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesData for funnel chart, such as, [{ category: '浏览网站', value: 50000 }, { category: '放入购物车', value: 35000 }, { category: '生成订单', value: 25000 }, { category: '支付订单', value: 15000 }, { category: '完成交易', value: 8000 }].
styleNoStyle configuration for the chart with a JSON object, optional.
themeNoSet the theme for the chart, optional, default is 'default'.default
widthNoSet the width of chart, default is 600.
heightNoSet the height of chart, default is 400.
titleNoSet the title of chart.

Implementation Reference

  • Input schema for the generate_funnel_chart tool, defining data (array of category-value pairs), optional style, theme, width, height, and title.
    const schema = {
      data: z
        .array(data)
        .describe(
          "Data for funnel chart, such as, [{ category: '浏览网站', value: 50000 }, { category: '放入购物车', value: 35000 }, { category: '生成订单', value: 25000 }, { category: '支付订单', value: 15000 }, { category: '完成交易', value: 8000 }].",
        )
        .nonempty({ message: "Funnel chart data cannot be empty." }),
      style: z
        .object({
          backgroundColor: BackgroundColorSchema,
          palette: PaletteSchema,
          texture: TextureSchema,
        })
        .optional()
        .describe(
          "Style configuration for the chart with a JSON object, optional.",
        ),
      theme: ThemeSchema,
      width: WidthSchema,
      height: HeightSchema,
      title: TitleSchema,
    };
  • src/server.ts:66-68 (registration)
    MCP server registration for tools/list, which includes the generate_funnel_chart tool from Charts.funnel.tool if enabled.
    server.setRequestHandler(ListToolsRequestSchema, async () => ({
      tools: getEnabledTools().map((chart) => chart.tool),
    }));
  • Handler function that validates input using the funnel schema, maps 'generate_funnel_chart' to 'funnel' chart type, generates chart URL via generateChartUrl, and returns MCP tool result.
    export async function callTool(tool: string, args: object = {}) {
      logger.info(`Calling tool: ${tool}`);
      const chartType = CHART_TYPE_MAP[tool as keyof typeof CHART_TYPE_MAP];
    
      if (!chartType) {
        logger.error(`Unknown tool: ${tool}`);
        throw new McpError(ErrorCode.MethodNotFound, `Unknown tool: ${tool}.`);
      }
    
      try {
        // Validate input using Zod before sending to API.
        // Select the appropriate schema based on the chart type.
        const schema = Charts[chartType].schema;
    
        if (schema) {
          // Use safeParse instead of parse and try-catch.
          const result = z.object(schema).safeParse(args);
          if (!result.success) {
            logger.error(`Invalid parameters: ${result.error.message}`);
            throw new McpError(
              ErrorCode.InvalidParams,
              `Invalid parameters: ${result.error.message}`,
            );
          }
        }
    
        const isMapChartTool = [
          "generate_district_map",
          "generate_path_map",
          "generate_pin_map",
        ].includes(tool);
    
        if (isMapChartTool) {
          // For map charts, we use the generateMap function, and return the mcp result.
          const { metadata, ...result } = await generateMap(tool, args);
          return result;
        }
    
        const url = await generateChartUrl(chartType, args);
        logger.info(`Generated chart URL: ${url}`);
    
        return {
          content: [
            {
              type: "text",
              text: url,
            },
          ],
          _meta: {
            description:
              "This is the chart's spec and configuration, which can be renderred to corresponding chart by AntV GPT-Vis chart components.",
            spec: { type: chartType, ...args },
          },
        };
        // biome-ignore lint/suspicious/noExplicitAny: <explanation>
      } catch (error: any) {
        logger.error(
          `Failed to generate chart: ${error.message || "Unknown error"}.`,
        );
        if (error instanceof McpError) throw error;
        if (error instanceof ValidateError)
          throw new McpError(ErrorCode.InvalidParams, error.message);
        throw new McpError(
          ErrorCode.InternalError,
          `Failed to generate chart: ${error?.message || "Unknown error."}`,
        );
      }
    }
  • Mapping from tool name 'generate_funnel_chart' to internal chart type 'funnel' used in dispatch.
    const CHART_TYPE_MAP = {
      generate_area_chart: "area",
      generate_bar_chart: "bar",
      generate_boxplot_chart: "boxplot",
      generate_column_chart: "column",
      generate_district_map: "district-map",
      generate_dual_axes_chart: "dual-axes",
      generate_fishbone_diagram: "fishbone-diagram",
      generate_flow_diagram: "flow-diagram",
      generate_funnel_chart: "funnel",
      generate_histogram_chart: "histogram",
      generate_line_chart: "line",
      generate_liquid_chart: "liquid",
      generate_mind_map: "mind-map",
      generate_network_graph: "network-graph",
      generate_organization_chart: "organization-chart",
      generate_path_map: "path-map",
      generate_pie_chart: "pie",
      generate_pin_map: "pin-map",
      generate_radar_chart: "radar",
      generate_sankey_chart: "sankey",
      generate_scatter_chart: "scatter",
      generate_treemap_chart: "treemap",
      generate_venn_chart: "venn",
      generate_violin_chart: "violin",
      generate_waterfall_chart: "waterfall",
      generate_word_cloud_chart: "word-cloud",
    } as const;
  • Generates the chart URL by posting the chart type 'funnel' and options to the visualization server.
    export async function generateChartUrl(
      type: string,
      // biome-ignore lint/suspicious/noExplicitAny: <explanation>
      options: Record<string, any>,
    ): Promise<string> {
      const url = getVisRequestServer();
    
      const response = await axios.post(
        url,
        {
          type,
          ...options,
          source: "mcp-server-chart",
        },
        {
          headers: {
            "Content-Type": "application/json",
          },
        },
      );
      const { success, errorMessage, resultObj } = response.data;
    
      if (!success) {
        throw new Error(errorMessage);
      }
    
      return resultObj;
    }
Behavior3/5

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

Annotations provide readOnlyHint=true, indicating this is a safe read operation. The description adds value by explaining the chart's purpose (visualizing progressive data reduction) and giving a real-world example, which helps the agent understand the tool's behavioral context beyond just being read-only. However, it does not disclose additional traits like rate limits, authentication needs, or output format details, which would be useful given the lack of an output schema.

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 a single, well-structured sentence that efficiently conveys the tool's purpose and includes a practical example. It is front-loaded with the core functionality and avoids unnecessary details, making it easy for an agent to parse quickly. Every part of the sentence earns its place by clarifying the tool's use case.

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

Completeness3/5

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

Given the tool's complexity (6 parameters, nested objects) and rich schema coverage (100%), the description adequately explains what the tool does with a clear example. However, there is no output schema, and the description does not specify the return type (e.g., image URL, chart object), leaving a gap in understanding the tool's output. With annotations covering safety but no output details, the description is moderately complete but could be improved by addressing the output.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents all parameters thoroughly (e.g., data structure, style options, dimensions). The description adds minimal parameter semantics by implying the 'data' parameter should represent sequential stages with reducing values, as in the conversion rate example. This provides some contextual meaning beyond the schema but does not significantly enhance parameter understanding, aligning with the baseline score for high schema coverage.

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

Purpose5/5

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

The description clearly states the tool's purpose: 'Generate a funnel chart to visualize the progressive reduction of data as it passes through stages.' It specifies the verb ('generate'), resource ('funnel chart'), and provides a concrete example ('conversion rates of users from visiting a website to completing a purchase'), which distinguishes it from sibling tools like generate_bar_chart or generate_pie_chart that serve different visualization purposes.

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

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context by mentioning 'progressive reduction of data as it passes through stages' and giving an example of conversion rates, suggesting this tool is for visualizing sequential data reduction. However, it does not explicitly state when to use this tool versus alternatives (e.g., when to choose a funnel chart over a waterfall chart or other siblings), nor does it provide exclusions or prerequisites, leaving some ambiguity for the agent.

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/antvis/mcp-server-chart'

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