@amcharts/amcharts5-mcp 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/.gitmodules ADDED
@@ -0,0 +1,3 @@
1
+ [submodule "amcharts5-skill"]
2
+ path = amcharts5-skill
3
+ url = https://github.com/amcharts/amcharts5-skill.git
package/README.md ADDED
@@ -0,0 +1,82 @@
1
+ # amCharts 5 MCP Server
2
+
3
+ An [MCP (Model Context Protocol)](https://modelcontextprotocol.io) server that gives AI assistants on-demand access to amCharts 5 documentation, examples, and API reference.
4
+
5
+ Works with **Claude Code**, **Claude Desktop**, **Cursor**, and any other MCP-compatible AI tool.
6
+
7
+ ## Why?
8
+
9
+ Instead of loading the entire amCharts reference into the AI's context window, the MCP server lets the AI **query exactly what it needs** — a specific chart type reference, a search for "tooltip formatting", or a quick-start template. This means better answers with less context waste.
10
+
11
+ ## Quick Start
12
+
13
+ ### Claude Code
14
+
15
+ ```bash
16
+ claude mcp add amcharts5 -- npx -y @amcharts/amcharts5-mcp
17
+ ```
18
+
19
+ ### Claude Desktop / Cursor
20
+
21
+ Add to your MCP config (`claude_desktop_config.json` or Cursor settings):
22
+
23
+ ```json
24
+ {
25
+ "mcpServers": {
26
+ "amcharts5": {
27
+ "command": "npx",
28
+ "args": ["-y", "@amcharts/amcharts5-mcp"]
29
+ }
30
+ }
31
+ }
32
+ ```
33
+
34
+ ### Run locally (for development)
35
+
36
+ ```bash
37
+ git clone https://github.com/amcharts/amcharts5-mcp.git
38
+ cd amcharts5-mcp
39
+ npm install
40
+ npm start
41
+ ```
42
+
43
+ ## Available Tools
44
+
45
+ | Tool | Description |
46
+ |------|-------------|
47
+ | `list_chart_types` | List all available chart types and their keywords |
48
+ | `get_chart_reference` | Get full reference docs for a chart type (e.g. "pie", "sankey", "xy") |
49
+ | `get_core_reference` | Get core amCharts 5 docs — setup, themes, colors, events, common pitfalls |
50
+ | `search_docs` | Search across all docs by keyword or topic |
51
+ | `get_section` | Get a specific section by heading name from any reference file |
52
+ | `get_quick_start` | Get a minimal working example for a chart type (HTML or ESM format) |
53
+
54
+ ## Example Usage
55
+
56
+ Once connected, your AI assistant can:
57
+
58
+ - **"Build me a pie chart"** → AI calls `get_quick_start("pie")` and adapts the template
59
+ - **"How do I format axis labels?"** → AI calls `search_docs("axis label format")`
60
+ - **"Show me the full radar chart API"** → AI calls `get_chart_reference("radar")`
61
+ - **"What chart types are available?"** → AI calls `list_chart_types()`
62
+
63
+ ## Content
64
+
65
+ The server indexes the [amCharts 5 AI Skill](https://github.com/amcharts/amcharts5-skill) documentation covering:
66
+
67
+ - **Core**: setup, themes, colors, legends, tooltips, events, data, adapters, disposal
68
+ - **XY charts**: line, area, bar, column, candlestick, scatter, stacked
69
+ - **Pie & Sliced**: pie, donut, funnel, pyramid
70
+ - **Maps**: world, country, choropleth, bubble map, point map
71
+ - **Hierarchy**: treemap, sunburst, force-directed, pack, partition
72
+ - **Flow**: Sankey, chord, arc diagram
73
+ - **Radar**: radar, spider, polar, gauge
74
+ - **Stock**: financial/trading charts
75
+ - **Timeline**: serpentine, spiral, curve
76
+ - **Gantt**: project timelines
77
+ - **Word Cloud & Venn**
78
+ - **UI Elements**: buttons, sliders, steppers, color pickers
79
+
80
+ ## License
81
+
82
+ MIT
@@ -0,0 +1,50 @@
1
+ # amcharts5-skill
2
+
3
+ An AI skill for building [amCharts 5](https://www.amcharts.com/docs/v5/) charts and data visualizations. Works with Claude, Cursor, GitHub Copilot, and any AI assistant that supports custom context or skill files.
4
+
5
+ Supports XY (line, bar, area, scatter), pie/donut, maps, hierarchy (treemap, sunburst), flow (Sankey, chord), radar, stock/financial, Gantt, word cloud, Venn, and timeline charts.
6
+
7
+ AI docs: https://www.amcharts.com/docs/v5/ai/
8
+
9
+ ## Installation
10
+
11
+ ### Claude Code
12
+
13
+ Add the skill to your project's `.claude/skills/` directory:
14
+
15
+ ```sh
16
+ git clone https://github.com/amcharts/amcharts5-skill .claude/skills/amcharts5-skill
17
+ ```
18
+
19
+ ### Claude.ai (web)
20
+
21
+ 1. Download this repo as a ZIP
22
+ 2. Go to **Claude.ai → Settings → Skills**
23
+ 3. Click **Upload skill** and select the ZIP
24
+ 4. Toggle the skill on
25
+
26
+ ### Cursor / Windsurf / other editors
27
+
28
+ Copy or symlink the skill files into your project, then add them to your AI context. For example, in Cursor add the files to `.cursorrules` or reference them via `@file` in chat.
29
+
30
+ ### Any AI assistant
31
+
32
+ The skill is plain Markdown. You can paste the contents of `SKILL.md` and the relevant `references/*.md` files directly into any AI chat as context before asking your question.
33
+
34
+ ## Usage
35
+
36
+ Once installed, just ask your AI assistant to build a chart:
37
+
38
+ ```
39
+ Create a bar chart showing monthly sales data using amCharts 5
40
+ ```
41
+
42
+ ```
43
+ Build a world map choropleth with country GDP data
44
+ ```
45
+
46
+ ```
47
+ Add a legend and animated transitions to my amCharts pie chart
48
+ ```
49
+
50
+ The skill automatically loads the right reference documentation for the chart type you're building.