Skip to main content
Glama
vchart-mcp-server

vchart-mcp-server

Official
by VisActor

A Model Context Protocol (MCP) server for the @visactor/vchart that enables AI assistants to generate interactive charts and visualizations.

MCP Server npm Version npm License

English | 简体中文

Table of Contents

Related MCP server: MCP Server Chart

Features

Chart Output Formats

Each chart can be generated in multiple formats:

  • Image - PNG/JPG image format for embedding (default)

  • Spec - VChart spec object for programmatic use

  • HTML - Interactive HTML chart for web display

Common Parameters Supported by All Charts

Parameter

Description

Type/Options

Default

output

Output format

"spec" | "image" | "html"

"image"

width

Chart width

Number

500

height

Chart height

Number

500

title

Chart title

String

Optional

subTitle

Chart subtitle

String

Optional

titleOrient

Title position

String

Optional

chartTheme

Chart theme

String

Optional

background

Background color

String

Optional

colors

Color palette

Array/String

Optional

Supported Chart Types and Tools

generate_cartesian_chart

Generates Cartesian coordinate system charts, including area, bar, line, waterfall, funnel, and animated ranking bar charts.

Parameter

Description

Type

Required

dataTable

Data object array

Array

Yes

chartType

Chart type

"line" | "area" | "bar" | "waterfall" | "funnel" | "ranking_bar"

Yes

xField

X axis field name

string

Yes

yField

Y axis field name

string

Yes

colorField

Color mapping field

string

Optional

timeField

Time field for animated ranking bar chart

string

Optional

stackOrPercent

Stack or percent mode

"stack" | "percent"

Optional

transpose

Display bar chart horizontally (as bar chart)

boolean

Optional

xAxisType

X axis type

"band" | "linear"

Optional

xAxisOrient

X axis position

"top" | "bottom"

Optional

xAxisTitle

X axis title

string

Optional

xAxisHasGrid

Show X axis grid lines

boolean

Optional

xAxisHasLabel

Show X axis labels

boolean

Optional

xAxisHasTick

Show X axis ticks

boolean

Optional

yAxisType

Y axis type

"band" | "linear"

Optional

yAxisOrient

Y axis position

"left" | "right"

Optional

yAxisTitle

Y axis title

string

Optional

yAxisHasGrid

Show Y axis grid lines

boolean

Optional

yAxisHasLabel

Show Y axis labels

boolean

Optional

yAxisHasTick

Show Y axis ticks

boolean

Optional

generate_polar_chart

Generates polar coordinate system charts, including radar, rose, and pie charts.

Parameter

Description

Type/Options

Required

dataTable

Data object array

Array

Yes

chartType

Chart type

"radar" | "rose" | "pie"

Yes

categoryField

Category field name

string

Yes

valueField

Value field name

string

Yes

colorField

Color mapping field

string

Optional

angleAxisTitle

Angle axis title

string

Optional

angleAxisHasGrid

Show angle axis grid lines

boolean

Optional

angleAxisHasLabel

Show angle axis labels

boolean

Optional

angleAxisHasTick

Show angle axis ticks

boolean

Optional

angleAxisType

Angle axis type

"band" | "linear"

Optional

radiusAxisTitle

Radius axis title

string

Optional

radiusAxisHasGrid

Show radius axis grid lines

boolean

Optional

radiusAxisHasLabel

Show radius axis labels

boolean

Optional

radiusAxisHasTick

Show radius axis ticks

boolean

Optional

radiusAxisType

Radius axis type

"band" | "linear"

Optional

generate_hierarchical_chart

Generates hierarchical charts, including treemap, circle packing, and sunburst charts.

Parameter

Description

Type/Options

Required

dataTable

Data object array

Array

Yes

chartType

Chart type

"sunburst" | "treemap" | "circle_packing"

Yes

colorField

Color mapping field

string

Yes

valueField

Value mapping field

string

Yes

generate_progress_chart

Generates progress charts, including circular, linear, gauge, and liquid charts.

Parameter

Description

Type/Options

Required

dataTable

Data object array

Array

Yes

chartType

Chart type

"linear_progress" | "circular_progress" | "gauge" | "liquid"

Yes

valueField

Progress value field name

string

Yes

colorField

Color mapping field (optional for liquid, required otherwise)

string

Optional

generate_wordcloud_venn

Generates word cloud or Venn diagrams, suitable for displaying keywords and frequencies in text data.

Parameters:

Parameter

Description

Type/Options

Required

dataTable

Data object array

Array

Yes

chartType

Chart type

"wordcloud" | "venn"

Yes

colorField

Text field or Venn set field name

string

Yes

valueField

Value field name (required for Venn)

string

Optional

generate_range_column_chart

Generates horizontal range bar charts, suitable for displaying data ranges and comparisons.

Parameter

Description

Type/Options

Required

dataTable

Data object array

any[]

Yes

xField

Category field name

string

Yes

yField

Value field names

[string, string]

Yes

colorField

Color mapping field

string

Optional

xAxisType

X axis type

"band" | "linear"

Optional

xAxisOrient

X axis position

"top" | "bottom"

Optional

xAxisTitle

X axis title

string

Optional

xAxisHasGrid

Show X axis grid lines

boolean

Optional

xAxisHasLabel

Show X axis labels

boolean

Optional

xAxisHasTick

Show X axis ticks

boolean

Optional

yAxisType

Y axis type

"band" | "linear"

Optional

yAxisOrient

Y axis position

"left" | "right"

Optional

yAxisTitle

Y axis title

string

Optional

yAxisHasGrid

Show Y axis grid lines

boolean

Optional

yAxisHasLabel

Show Y axis labels

boolean

Optional

yAxisHasTick

Show Y axis ticks

boolean

Optional

generate_dual_axis_chart

Combination chart with two Y axes, for comparing two metrics with different units.

Parameter

Description

Type/Options

Required

dataTable

Data object array

any[]

Yes

xField

X axis field name

string

Yes

yField

Two Y axis field names

[string, string]

Yes

colorField

Color mapping field

string

Optional

stackOrPercent

Stack or percent mode

"stack" | "percent"

Optional

xAxisOrient

X axis position

"top" | "bottom"

Optional

xAxisTitle

X axis title

string

Optional

xAxisHasGrid

Show X axis grid lines

boolean

Optional

xAxisHasLabel

Show X axis labels

boolean

Optional

xAxisHasTick

Show X axis ticks

boolean

Optional

leftYAxisTitle

Left Y axis title

string

Optional

leftYAxisHasGrid

Left Y axis grid lines

boolean

Optional

leftYAxisHasLabel

Left Y axis labels

boolean

Optional

leftYAxisHasTick

Left Y axis ticks

boolean

Optional

rightYAxisTitle

Right Y axis title

string

Optional

rightYAxisHasGrid

Right Y axis grid lines

boolean

Optional

rightYAxisHasLabel

Right Y axis labels

boolean

Optional

rightYAxisHasTick

Right Y axis ticks

boolean

Optional

generate_scatter_chart

Displays the relationship between two variables, suitable for discovering patterns and outliers.

Parameter

Description

Type/Options

Required

dataTable

Data object array

any[]

Yes

xField

X axis field name

string

Yes

yField

Y axis field name

string

Yes

colorField

Color mapping field

string

Optional

sizeField

Size mapping field

string

Optional

xAxisType

X axis type

"band" | "linear"

Optional

xAxisOrient

X axis position

"top" | "bottom"

Optional

xAxisTitle

X axis title

string

Optional

xAxisHasGrid

Show X axis grid lines

boolean

Optional

xAxisHasLabel

Show X axis labels

boolean

Optional

xAxisHasTick

Show X axis ticks

boolean

Optional

yAxisType

Y axis type

"band" | "linear"

Optional

yAxisOrient

Y axis position

"left" | "right"

Optional

yAxisTitle

Y axis title

string

Optional

yAxisHasGrid

Show Y axis grid lines

boolean

Optional

yAxisHasLabel

Show Y axis labels

boolean

Optional

yAxisHasTick

Show Y axis ticks

boolean

Optional

generate_sankey_chart

Generates Sankey diagrams.

Parameter

Description

Type

Required

dataTable

Data object array

any[]

Yes

sourceField

Source node field

string

Yes

targetField

Target node field

string

Yes

valueField

Value field

string

Yes

generate_heatmap_chart

Generates heatmaps, suitable for displaying data density and distribution.

Parameter

Description

Type/Options

Required

dataTable

Data object array

any[]

Yes

xField

X axis field name

string

Yes

yField

Y axis field name

string

Yes

sizeField

Value field name

string

Yes

xAxisType

X axis type

"band" | "linear"

Optional

xAxisOrient

X axis position

"top" | "bottom"

Optional

xAxisTitle

X axis title

string

Optional

xAxisHasGrid

Show X axis grid lines

boolean

Optional

xAxisHasLabel

Show X axis labels

boolean

Optional

xAxisHasTick

Show X axis ticks

boolean

Optional

yAxisType

Y axis type

"band" | "linear"

Optional

yAxisOrient

Y axis position

"left" | "right"

Optional

yAxisTitle

Y axis title

string

Optional

yAxisHasGrid

Show Y axis grid lines

boolean

Optional

yAxisHasLabel

Show Y axis labels

boolean

Optional

yAxisHasTick

Show Y axis ticks

boolean

Optional

Usage

To use in desktop applications (such as Trae, Claude, VSCode, Cline, Cherry Studio, Cursor, etc.), add the following MCP server configuration:

MacOS

{
  "mcpServers": {
    "vchart-mcp-server": {
      "command": "npx",
      "args": ["-y", "@visactor/vchart-mcp-server"]
    }
  }
}

Windows

{
  "mcpServers": {
    "vchart-mcp-server": {
      "command": "cmd",
      "args": ["/c", "npx", "-y", "@visactor/vchart-mcp-server"]
    }
  }
}

Installing via Smithery

To install vchart-mcp-server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install @VisActor/vchart-mcp-server --client claude

Running with SSE or Streamable Transport

Install and Start

Install @visactor/vchart-mcp-server globally:

npm install -g @visactor/vchart-mcp-server

Start the server:

# For SSE transport (default endpoint: /sse)
mcp-server-chart --transport sse

# For Streamable transport (default endpoint: /streamable)
mcp-server-chart --transport streamable

Then you can access the server at:

  • SSE transport: http://localhost:3001/sse

  • Streamable transport: http://localhost:3001/streamable

Other CLI Options

Options:
  -t, --transport <type>   Transport type (stdio, sse, streamable) [default: stdio]
  -p, --port <port>        Port number for HTTP-based transports [default: 3000]
  -e, --endpoint <path>    Endpoint path for HTTP-based transports [default: /message]
  -h, --help               Show this help message

Examples:
  node index.js                                    # Start with stdio transport
  node index.js -t sse -p 3000                     # Start with SSE transport on port 3000
  node index.js -t sse -p 3000 -e /api/sse         # Start with SSE transport on custom endpoint
  node index.js -t streamable -p 3001 -e /stream   # Start with streamable transport on custom endpoint

Example Usage in AI Conversations

Once configured, you can ask your AI assistant to create charts:

"Create an area chart showing monthly sales data"

The assistant will use the generate_cartesian_chart tool with parameters:
- chartType: "area"
- dataTable: your sales data
- xField: "month"
- yField: "sales"

"Generate a dual-axis chart comparing revenue and user growth"

The assistant will use the generate_dual_axis_chart tool with parameters:
- dataTable: your business data
- xField: "time"
- yField: ["revenue", "userGrowth"]

"Show me an interactive HTML bar chart of quarterly performance"

The assistant will use the generate_cartesian_chart tool with parameters:
- chartType: "bar"
- dataTable: your quarterly data
- xField: "quarter"
- yField: "performance"
- output: "html"

"Create a pie chart of product sales share"

The assistant will use the generate_polar_chart tool with parameters:
- chartType: "pie"
- dataTable: your sales data
- categoryField: "product"
- valueField: "sales"

"Draw a scatter plot of height and weight"

The assistant will use the generate_scatter_chart tool with parameters:
- dataTable: your body data
- xField: "height"
- yField: "weight"
- colorField: "gender" (optional)

"Create a radar chart for team skill assessment"

The assistant will use the generate_polar_chart tool with parameters:
- chartType: "radar"
- dataTable: your assessment data
- categoryField: "skill"
- valueField: "score"

"Generate a Sankey diagram showing data flow"

The assistant will use the generate_sankey_chart tool with parameters:
- dataTable: your flow data
- sourceField: "from"
- targetField: "to"
- valueField: "amount"

"Create a heatmap showing data distribution"

The assistant will use the generate_heatmap_chart tool with parameters:
- dataTable: your distribution data
- xField: "x_category"
- yField: "y_category"
- sizeField: "value"

Development

Prerequisites

  • Node.js version >= 22.7.5

Build

npm run build

Development Mode (Auto Rebuild)

npm run watch

Testing

# Test chart generation
npm run test-tool

# Run MCP Inspector for debugging
npm run inspector

Debugging

Since the MCP server communicates via stdio, debugging can be challenging. Use MCP Inspector for development:

npm run inspector

Testing in AI Editors

To test the MCP server in an AI editor, use the following configuration:

{
  "mcpServers": {
    "vchart-mcp-server": {
      "command": "node",
      "args": ["/Users/path/to/your/project/vchart-mcp-server/build/index.js"]
    }
  }
}

Environment Variables

Private Deployment

Currently, images and HTML generated by vchart-mcp-server are produced via https://vmind.visactor.com/export. For private deployment, set the VIMD_IMAGE_SERVER environment variable to specify your own image generation server.

{
  "mcpServers": {
    "mcp-server-chart": {
      "command": "npx",
      "args": [
        "-y",
        "@visactor/vchart-mcp-server"
      ],
      "env": {
        "VIMD_IMAGE_SERVER": "<YOUR_VIS_REQUEST_SERVER>"
      }
    }
  }
}

Image generation service can be deployed privately refer to https://github.com/VisActor/vchart-mcp-server-export.

Star History

License

MIT License

Contributing

Contributions are welcome! Please feel free to submit issues and pull requests.

Available Tools

10 tools
generate_cartesian_chartB

Generates Cartesian charts: line (trends over time), area (cumulative totals), bar (category comparison), waterfall (incremental changes), ranking bar (ordered categories), and funnel (visualizes stages in a process or conversion rates).

Inputs: chartType (required), dataTable (required), xField (required), yField (required), +25 more.

generate_dual_axis_chartA

Generate a dual-axis chart for visualizing two quantitative variables using a combination of bar and line series. Ideal for comparing trends and magnitudes across two metrics with distinct y-axes.

Inputs: dataTable (required), xField (required), yField (required), output, +23 more.

generate_heatmap_chartB

Generates a heatmap chart based on a Cartesian coordinate system. It is used to visualize the intensity or density of values at the intersection of two discrete variables, suitable for revealing association patterns and distribution characteristics between variables.

Inputs: dataTable (required), xField (required), yField (required), sizeField (required), +22 more.

generate_hierarchical_chartC

Generate a chart for hierarchical visualization of multi-level categorical data proportions, include sunburst, treemap, circle_packing.

Inputs: chartType (required), dataTable (required), colorField (required), valueField (required), +9 more.

generate_polar_chartC

Generate a polar chart (rose, radar, pie) to display numerical differences among different categories using radius and angle in polar coordinates.

Inputs: dataTable (required), chartType (required), categoryField (required), valueField (required), +22 more.

generate_progress_chartB

Generates a progress chart for visualizing quantitative values normalized between 0 and 1. Ideal for representing progress, completion rates, or proportional metrics. The gauge chart and liquid chart currently only supports displaying data for a single dimension.

Inputs: dataTable (required), chartType (required), valueField (required), output, +9 more.

generate_range_column_chartB

Generate a range column chart to display the value range (such as minimum and maximum) for each category, suitable for comparing the range distribution across different categories.

Inputs: dataTable (required), xField (required), yField (required), output, +21 more.

generate_sankey_chartC

Generate a Sankey diagram to visualize the flow relationships between nodes in complex networks, suitable for displaying the distribution and flow paths of source and target data.

Inputs: dataTable (required), sourceField (required), targetField (required), valueField (required), +9 more.

generate_scatter_chartB

Generate a scatter chart to visually display the distribution, clustering trends, and correlations of data points in two-dimensional or multi-dimensional space. Suitable for analyzing relationships between variables, outlier detection, and similar scenarios.

Inputs: dataTable (required), xField (required), yField (required), output, +22 more.

generate_wordcloud_vennC

Generate a word cloud to visualize word frequency or importance, or a Venn diagram to show relationships such as intersections and unions between sets.

Inputs: chartType (required), dataTable (required), colorField (required), valueField (required), +9 more.

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    A3.6/5.0

    Scored across 10 tools

    Disambiguation5/5

    Each tool is clearly distinct, targeting a specific chart type or visualization method (e.g., Cartesian, heatmap, hierarchical, Sankey). The descriptions precisely differentiate purposes, such as trend analysis for Cartesian charts versus flow relationships for Sankey diagrams, leaving no ambiguity for selection.

    Naming Consistency5/5

    All tool names follow a consistent verb_noun pattern with 'generate_' as the prefix (e.g., generate_cartesian_chart, generate_heatmap_chart). This uniform naming convention makes the tool set predictable and easy to navigate for agents.

    Tool Count5/5

    With 10 tools, the server is well-scoped for chart generation, covering a comprehensive range of visualization types from basic charts like scatter and bar to specialized ones like Sankey and word clouds. Each tool earns its place without redundancy or excessive bloat.

    Completeness5/5

    The tool set provides complete coverage for data visualization, including common chart types (Cartesian, scatter, polar), specialized visualizations (heatmap, hierarchical, Sankey), and utility charts (progress, word cloud/Venn). There are no obvious gaps; agents can handle diverse visualization needs without dead ends.

    Related MCP Connectors

    Related MCP Servers