Skip to main content
Glama

generate_flow_diagram

Read-only

Create flow diagrams to visualize process steps and decision points for linear scenarios. Input node and edge data to generate structured charts.

Instructions

Generate a flow diagram chart to show the steps and decision points of a process or system, such as, scenarios requiring linear process presentation.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYesData for flow diagram chart, such as, { nodes: [{ name: 'node1' }, { name: 'node2' }], edges: [{ source: 'node1', target: 'node2', name: 'edge1' }] }.
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.

Implementation Reference

  • Generic handler function for all chart generation tools. For 'generate_flow_diagram', it maps to chartType 'flow-diagram', validates input using the chart's schema, calls generateChartUrl to get the chart URL from external API, and returns the MCP tool result with the 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."}`,
        );
      }
    }
  • Input schema using Zod for validation and tool descriptor including name, description, and inputSchema converted to JSON schema for the generate_flow_diagram tool.
    const schema = {
      data: z
        .object({
          nodes: z
            .array(NodeSchema)
            .nonempty({ message: "At least one node is required." }),
          edges: z.array(EdgeSchema),
        })
        .describe(
          "Data for flow diagram chart, such as, { nodes: [{ name: 'node1' }, { name: 'node2' }], edges: [{ source: 'node1', target: 'node2', name: 'edge1' }] }.",
        )
        .refine(validatedNodeEdgeDataSchema, {
          message: "Invalid parameters",
          path: ["data", "edges"],
        }),
      style: z
        .object({
          texture: TextureSchema,
        })
        .optional()
        .describe(
          "Style configuration for the chart with a JSON object, optional.",
        ),
      theme: ThemeSchema,
      width: WidthSchema,
      height: HeightSchema,
    };
    
    // Flow diagram tool descriptor
    const tool = {
      name: "generate_flow_diagram",
      description:
        "Generate a flow diagram chart to show the steps and decision points of a process or system, such as, scenarios requiring linear process presentation.",
      inputSchema: zodToJsonSchema(schema),
      annotations: {
        title: "Generate Flow Diagram",
        readOnlyHint: true,
      },
    };
  • src/server.ts:64-77 (registration)
    Registers the MCP protocol handlers for listing available tools (returns descriptors including generate_flow_diagram from charts) and for calling any tool by name (delegates to callTool).
    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_flow_diagram' to the internal chart type 'flow-diagram' used for schema lookup and chart generation.
    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 tool handler to generate the chart URL by posting the chart type ('flow-diagram') and options to an external visualization API 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 already declare readOnlyHint=true, indicating this is a safe read operation. The description adds minimal behavioral context beyond this—it doesn't mention output format (e.g., image file, URL), performance characteristics, or any side effects. However, it doesn't contradict the annotations, and the example in the schema description provides some practical guidance on data structure.

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 a single, efficient sentence that front-loads the core purpose. The second clause ('such as, scenarios requiring linear process presentation') adds useful context without redundancy. However, it could be slightly more structured by explicitly mentioning the input data format or output type.

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 moderate complexity (5 parameters, nested objects) and rich schema coverage, the description is adequate but minimal. It lacks details on output (no output schema provided), doesn't explain how the flow diagram is rendered or delivered, and misses sibling differentiation. With annotations covering safety, it's complete enough for basic use but leaves gaps for advanced scenarios.

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 parameters. The description doesn't add any parameter-specific semantics beyond what's in the schema—it doesn't explain the 'data' structure's purpose or how 'nodes' and 'edges' relate to flow diagrams. With high schema coverage, the baseline is 3, and the description doesn't enhance this.

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

Purpose4/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 flow diagram chart to show the steps and decision points of a process or system.' It specifies the verb ('generate'), resource ('flow diagram chart'), and target ('process or system'). However, it doesn't explicitly differentiate from sibling tools like 'generate_network_graph' or 'generate_mind_map' which might also visualize processes.

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 provides some implied usage context with 'scenarios requiring linear process presentation,' suggesting this tool is for linear workflows. However, it doesn't explicitly state when to use this versus alternatives like 'generate_sankey_chart' for flows or 'generate_organization_chart' for hierarchical processes. No explicit exclusions or prerequisites are mentioned.

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