Skip to main content
Glama

generate_waterfall_chart

Read-only

Visualize cumulative effects of sequential positive or negative values to show how initial values change through intermediate steps to final results, useful for financial analysis and budget tracking.

Instructions

Generate a waterfall chart to visualize the cumulative effect of sequentially introduced positive or negative values, such as showing how an initial value is affected by a series of intermediate positive or negative values leading to a final result. Waterfall charts are ideal for financial analysis, budget tracking, profit and loss statements, and understanding the composition of changes over time or categories.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesData for waterfall chart, it should be an array of objects. Each object must contain a `category` field. For regular items, a `value` field is also required. The `isIntermediateTotal` field marks intermediate subtotals, and the `isTotal` field marks the final total. For example, [{ category: 'Initial', value: 100 }, { category: 'Increase', value: 50 }, { category: 'Subtotal', isIntermediateTotal: true }, { category: 'Decrease', value: -30 }, { category: 'Total', isTotal: true }].
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.
axisXTitleNoSet the x-axis title of chart.
axisYTitleNoSet the y-axis title of chart.

Implementation Reference

  • Core handler function that executes the generate_waterfall_chart tool. Maps tool name to 'waterfall' chart type, validates input schema, generates chart URL via external service, and returns the 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."}`,
        );
      }
    }
  • Input schema (Zod) for validating arguments to generate_waterfall_chart, including data array with categories, values, totals, and styling options.
    const schema = {
      data: z
        .array(data)
        .describe(
          "Data for waterfall chart, it should be an array of objects. Each object must contain a `category` field. For regular items, a `value` field is also required. The `isIntermediateTotal` field marks intermediate subtotals, and the `isTotal` field marks the final total. For example, [{ category: 'Initial', value: 100 }, { category: 'Increase', value: 50 }, { category: 'Subtotal', isIntermediateTotal: true }, { category: 'Decrease', value: -30 }, { category: 'Total', isTotal: true }].",
        )
        .nonempty({ message: "Waterfall chart data cannot be empty." }),
      style: z
        .object({
          backgroundColor: BackgroundColorSchema,
          texture: TextureSchema,
          palette: z
            .object({
              positiveColor: z
                .string()
                .optional()
                .describe(
                  "Color for positive values (increases). Default is '#FF4D4F'.",
                ),
              negativeColor: z
                .string()
                .optional()
                .describe(
                  "Color for negative values (decreases). Default is '#2EBB59'.",
                ),
              totalColor: z
                .string()
                .optional()
                .describe(
                  "Color for total and intermediate total bars. Default is '#1783FF'.",
                ),
            })
            .optional(),
        })
        .optional()
        .describe(
          "Style configuration for the chart with a JSON object, optional.",
        ),
      theme: ThemeSchema,
      width: WidthSchema,
      height: HeightSchema,
      title: TitleSchema,
      axisXTitle: AxisXTitleSchema,
      axisYTitle: AxisYTitleSchema,
    };
  • src/server.ts:64-77 (registration)
    Registers the MCP handlers for tools/list (includes generate_waterfall_chart descriptor from Charts.waterfall.tool) and tools/call (invokes generic callTool handler).
    function setupToolHandlers(server: Server): void {
      logger.info("setting up tool handlers...");
      server.setRequestHandler(ListToolsRequestSchema, async () => ({
        tools: getEnabledTools().map((chart) => chart.tool),
      }));
    
      // biome-ignore lint/suspicious/noExplicitAny: <explanation>
      server.setRequestHandler(CallToolRequestSchema, async (request: any) => {
        logger.info("calling tool", request.params.name, request.params.arguments);
    
        return await callTool(request.params.name, request.params.arguments);
      });
      logger.info("tool handlers set up");
    }
  • Mapping from tool name 'generate_waterfall_chart' to internal chart type 'waterfall' used by the handler.
    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;
  • Tool descriptor defining name, description, input schema, and annotations for registration in MCP tools/list.
    const tool = {
      name: "generate_waterfall_chart",
      description:
        "Generate a waterfall chart to visualize the cumulative effect of sequentially introduced positive or negative values, such as showing how an initial value is affected by a series of intermediate positive or negative values leading to a final result. Waterfall charts are ideal for financial analysis, budget tracking, profit and loss statements, and understanding the composition of changes over time or categories.",
      inputSchema: zodToJsonSchema(schema),
      annotations: {
        title: "Generate Waterfall Chart",
        readOnlyHint: true,
      },
    };
Behavior3/5

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

Annotations indicate readOnlyHint=true, which the description does not contradict (it describes a generation/visualization tool, not a destructive operation). The description adds useful context about what the tool produces (a visualization of cumulative effects) and typical use cases, but does not disclose additional behavioral traits like rate limits, authentication needs, or output format details. With annotations covering the safety profile, this is adequate but not rich in behavioral context.

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

Conciseness4/5

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

The description is appropriately sized and front-loaded: it starts with the core purpose, then explains the visualization concept, and ends with ideal use cases. Both sentences earn their place by adding value. It could be slightly more concise by combining some phrases, but it avoids redundancy and waste.

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

Completeness4/5

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

Given the tool's complexity (8 parameters, nested objects) and rich schema coverage (100%), the description provides good contextual completeness. It explains the tool's purpose, use cases, and what it visualizes. Since there is no output schema, it does not describe return values (e.g., chart format or output type), which is a minor gap. However, for a generation tool with detailed schema, the description is largely complete.

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 8 parameters thoroughly with descriptions and examples. The description does not add any parameter-specific information beyond what the schema provides. According to the rules, when schema coverage is high (>80%), the baseline score is 3 even with no param info in the description, which applies here.

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 waterfall chart to visualize the cumulative effect of sequentially introduced positive or negative values.' It specifies the verb ('generate') and resource ('waterfall chart'), distinguishes it from siblings by explaining what waterfall charts are ideal for (financial analysis, budget tracking, etc.), and provides concrete examples of use cases that differentiate it from other chart types.

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

Usage Guidelines4/5

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

The description provides clear context for when to use this tool: 'Waterfall charts are ideal for financial analysis, budget tracking, profit and loss statements, and understanding the composition of changes over time or categories.' This gives the agent guidance on appropriate scenarios. However, it does not explicitly state when not to use it or name specific alternatives among the many sibling chart tools, which prevents a score of 5.

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