Skip to main content
Glama

generate_liquid_chart

Read-only

Visualize a single percentage value as a liquid-filled chart for metrics like occupancy rates or project completion.

Instructions

Generate a liquid chart to visualize a single value as a percentage, such as, the current occupancy rate of a reservoir or the completion percentage of a project.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
percentYesThe percentage value to display in the liquid chart, should be a number between 0 and 1, where 1 represents 100%. For example, 0.75 represents 75%.
shapeNoThe shape of the liquid chart, can be 'circle', 'rect', 'pin', or 'triangle'. Default is 'circle'.circle
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

  • The core handler function for executing chart generation tools, including 'generate_liquid_chart'. It maps the tool name to the chart type 'liquid', validates inputs using the chart-specific schema, and generates the chart URL.
    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."}`,
        );
      }
    }
  • Zod schema defining the input parameters for the 'generate_liquid_chart' tool, including percent, shape, style, theme, dimensions, and title.
    const schema = {
      percent: z
        .number()
        .describe(
          "The percentage value to display in the liquid chart, should be a number between 0 and 1, where 1 represents 100%. For example, 0.75 represents 75%.",
        )
        .min(0, { message: "Value must be at least 0." })
        .max(1, { message: "Value must be at most 1." }),
      shape: z
        .enum(["circle", "rect", "pin", "triangle"])
        .optional()
        .default("circle")
        .describe(
          "The shape of the liquid chart, can be 'circle', 'rect', 'pin', or 'triangle'. Default is 'circle'.",
        ),
      style: z
        .object({
          backgroundColor: BackgroundColorSchema,
          texture: TextureSchema,
          color: z
            .string()
            .optional()
            .describe(
              "Custom color for the liquid chart, if not specified, defaults to the theme color.",
            ),
        })
        .optional()
        .describe(
          "Style configuration for the chart with a JSON object, optional.",
        ),
      theme: ThemeSchema,
      width: WidthSchema,
      height: HeightSchema,
      title: TitleSchema,
    };
  • src/server.ts:64-77 (registration)
    Registers the ListTools and CallTool handlers on the MCP server. ListTools provides the tool definitions (including 'generate_liquid_chart') from imported charts, and CallTool dispatches to callTool function.
    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");
    }
  • Constant mapping that associates the tool name 'generate_liquid_chart' to the chart type 'liquid', used by the handler to determine the chart type.
    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;
  • Helper function called by the handler to generate the chart URL by sending the chart type ('liquid') and options to an external visualization service.
    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 already declare readOnlyHint=true, indicating this is a safe read operation that generates a chart without modifying data. The description adds value by specifying the output is a visualization (liquid chart) and providing example use cases, but it does not disclose additional behavioral traits like performance considerations, error handling, or format of the generated chart (e.g., image file, URL).

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 usage with zero waste. It is front-loaded with the core function and includes illustrative examples, making it easy to understand quickly without unnecessary details.

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 (7 parameters, nested objects) and rich schema coverage (100%), the description is complete enough for its purpose. It clarifies the tool's niche among siblings and provides usage context. However, without an output schema, it does not explain the return value (e.g., chart image or data), leaving a minor gap in completeness.

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 fully documents all 7 parameters, including their types, defaults, and constraints. The description adds minimal semantic context by mentioning 'percentage' and examples like occupancy rate, which aligns with the 'percent' parameter, but does not provide additional meaning beyond what the schema already covers.

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 with a specific verb ('generate') and resource ('liquid chart'), and explicitly distinguishes it from sibling tools by specifying it visualizes 'a single value as a percentage' (e.g., occupancy rate, completion percentage), unlike other chart types like bar, line, or pie charts that typically show multiple data points or categories.

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—for visualizing a single percentage value—with examples like occupancy rate or project completion. However, it does not explicitly state when not to use it or name alternatives among the sibling tools, such as using a pie chart for parts of a whole or a bar chart for comparisons.

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