@amcharts/amcharts5-mcp

中文文档
1.9.4发布于 2026/10/26MITES Module近 30 天下载 4111

On-demand access to amCharts 5 docs, code examples, and API reference

原始使用文档
文档目录17 节
  1. Why?
  2. Quick Start
  3. Hosted (no install) — recommended
  4. Local install (npx)
  5. Claude Code
  6. Claude Desktop
  7. Cursor
  8. Windsurf
  9. VS Code + GitHub Copilot
  10. Other MCP-compatible tools
  11. Run locally (for development)
  12. Available Tools
  13. Example Usage
  14. Content
  15. Security
  16. Privacy
  17. License

amCharts 5 MCP Server

An MCP (Model Context Protocol) server that gives AI assistants on-demand access to the complete amCharts 5 knowledge base: 160+ documentation pages, 350+ code examples (including 60+ complete JSON configs), and 1,300+ API reference pages.

Works with Claude Code, Claude Desktop, Cursor, Windsurf, VS Code + GitHub Copilot, and any other MCP-compatible AI tool.

Why?

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 code example, or an API lookup. This means better answers with less context waste.

Quick Start

The easiest way is the hosted server — no install, just add one URL. Prefer to run it yourself? See Local install below.

Point your AI client at:

https://mcp.amcharts.com/mcp

The amCharts 5 docs are also on Context7 as /amcharts/amcharts5.

Claude Code

claude mcp add --transport http amcharts5 https://mcp.amcharts.com/mcp

Claude (claude.ai, Desktop) — add amCharts 5 from the Connectors Directory. Or Settings → Connectors → Add custom connector, then paste https://mcp.amcharts.com/mcp.

Cursor — .cursor/mcp.json:

{
  "mcpServers": {
    "amcharts5": {
      "url": "https://mcp.amcharts.com/mcp"
    }
  }
}

VS Code + GitHub Copilot — .vscode/mcp.json:

{
  "servers": {
    "amcharts5": {
      "type": "http",
      "url": "https://mcp.amcharts.com/mcp"
    }
  }
}

Windsurf — ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "amcharts5": {
      "serverUrl": "https://mcp.amcharts.com/mcp"
    }
  }
}

ChatGPT (also on the Free plan) — open Plugins → + → Add custom MCP server. Give it a name, set the URL to https://mcp.amcharts.com/mcp and Authentication to No authentication, then Create as a plugin. In a chat, type @amCharts to use it.

Figma Make and the Figma agent (paid Figma plans) — in the chat, open Add context → Connectors → Manage → Create. Name it amCharts, set the URL to https://mcp.amcharts.com/mcp with no authentication, and set its tools to Always run. Then name amCharts in the prompt (Make picks Recharts otherwise), e.g. "Build a sales dashboard with amCharts: a world map colored by revenue and a line chart of monthly sales". Make installs @amcharts/amcharts5 and looks up the code through the server. A pasted amcharts.com demo or docs link works as context too.

Cline (VS Code extension) — open the MCP Servers panel → Remote Servers, paste https://mcp.amcharts.com/mcp, or add to its MCP settings JSON:

{
  "mcpServers": {
    "amcharts5": {
      "type": "streamableHttp",
      "url": "https://mcp.amcharts.com/mcp"
    }
  }
}

Clients that only support local (stdio) servers (e.g. Zed, Continue, Amazon Q Developer) — bridge to the hosted URL with mcp-remote. Use this as the server's run command in the client's config:

npx mcp-remote https://mcp.amcharts.com/mcp

For example, in a command/args style config:

{
  "mcpServers": {
    "amcharts5": {
      "command": "npx",
      "args": ["-y", "mcp-remote", "https://mcp.amcharts.com/mcp"]
    }
  }
}

Any other MCP client that accepts a remote server URL works too — use the /mcp endpoint (Streamable HTTP) or /sse (legacy SSE). For URL-only clients that still expect a command, use the mcp-remote bridge shown above.

Local install (npx)

Prefer running it yourself? The server is also published to npm and runs over stdio.

Claude Code

For all projects (global, recommended):

claude mcp add -s user amcharts5 -- npx -y @amcharts/amcharts5-mcp

For current project only:

claude mcp add amcharts5 -- npx -y @amcharts/amcharts5-mcp

Claude Desktop

Add to your claude_desktop_config.json:

{
  "mcpServers": {
    "amcharts5": {
      "command": "npx",
      "args": ["-y", "@amcharts/amcharts5-mcp"]
    }
  }
}

Cursor

Create or edit .cursor/mcp.json in your project root (or ~/.cursor/mcp.json for global):

{
  "mcpServers": {
    "amcharts5": {
      "command": "npx",
      "args": ["-y", "@amcharts/amcharts5-mcp"]
    }
  }
}

Windsurf

Edit ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "amcharts5": {
      "command": "npx",
      "args": ["-y", "@amcharts/amcharts5-mcp"]
    }
  }
}

VS Code + GitHub Copilot

Create or edit .vscode/mcp.json in your workspace:

{
  "servers": {
    "amcharts5": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "@amcharts/amcharts5-mcp"]
    }
  }
}

Other MCP-compatible tools

For any other tool that supports MCP (Cline, Continue, Amazon Q, Zed, etc.), configure it to run:

npx -y @amcharts/amcharts5-mcp

Run locally (for development)

git clone https://github.com/amcharts/amcharts5-mcp.git
cd amcharts5-mcp
npm install
npm start

Available Tools

ToolDescription
get_core_referenceGet core amCharts 5 docs — setup, themes, colors, events, common pitfalls. An overview: its first sections, up to 12,000 characters, and a list of the others; full: true for the whole file
get_chart_referenceGet the reference for a chart type (e.g. "pie", "sankey", "xy"). One longer than 12,000 characters comes as an overview with the rest listed for get_section; full: true for the whole file
list_chart_typesList all available chart types and their keywords
search_docsSearch the skill reference docs by keyword (scope: "all" adds the full docs, API reference and examples)
search_allSearch across everything — skill docs, full documentation, and code examples
get_docGet a full documentation page by its path (e.g. "charts/xy-chart/axes", "concepts/events") or its docs.amcharts.com address
get_sectionGet a specific section from a reference file by heading (a ### subsection heading returns just that subsection)
get_quick_startGet a minimal working template for any chart type
list_examplesBrowse all 350+ examples, optionally filtered by category
get_exampleGet the full code for a specific example, by its path or its amcharts.com demo address
get_api_referenceGet the API reference for a class, interface or function — settings with their defaults, events, inheritance and the import line
list_geodataFind map (geodata) files — world, continents, countries, regional packs and the per-Congress US congressional district packs — with each file's CDN path, script global and ES import

Example Usage

Once connected, your AI assistant can:

  • "Build me a pie chart" → AI calls get_quick_start("pie") and adapts the template
  • "How do I format date axis labels?" → AI calls search_all("date axis label format")
  • "Show me the Sankey diagram example" → AI calls get_example("examples/flow/sankey-diagram")
  • "What settings does XYChart support?" → AI calls get_doc("reference/xychart")
  • "How do I integrate with React?" → AI calls get_doc("getting-started/integrations/react"), which covers the @amcharts/amcharts5-react package
  • "What chart types are available?" → AI calls list_chart_types()
  • "Map the current US congressional districts" → AI calls list_geodata("congressional whole country")
  • A pasted amcharts.com link, e.g. "make one like https://www.amcharts.com/demos/sankey-diagram/" → whichever tool the AI tries with it (a search, get_doc, get_example) points to the call that returns that demo's code or that docs page or section

Content

The server includes 1,900+ documents:

  • 160+ documentation pages — getting started, chart guides, concepts (themes, events, adapters, data binding, animations, accessibility, etc.), and framework integration guides for amCharts' React, Vue, Angular, Svelte and React Native packages (with Next.js, Nuxt, SvelteKit, React Router and Remix 3)
  • 350+ code examples — 290+ working demos across 16 categories including column/bar, line/area, pie/donut, maps, hierarchy, flow, radar/polar, stock, gauges, Gantt, timeline, and more, plus 60+ complete JSON configs from the amCharts npm package
  • 1,300+ API reference pages — every class, interface and function in the amCharts 5 library, generated from the release's typings: settings with their real defaults (theme rules included), events, properties, data item fields, the inheritance chain and the import line
  • 670+ geodata entries — every map in @amcharts/amcharts5-geodata, for list_geodata
  • Curated skill reference — quick-start templates, chart-specific guides and a guide to writing JSON configs, from the amCharts 5 AI Skill

Security

  • Read-only tools. Every tool reads the bundled amCharts documentation and returns text. No tool writes files, runs commands or fetches URLs.
  • The hosted endpoint has no authentication, by design. https://mcp.amcharts.com/mcp serves the same public documentation as amcharts.com. There are no accounts, API keys, user data or write operations behind it.
    • It runs on Cloudflare Workers.
    • MCP session state is kept in a Durable Object, as the MCP agents framework requires. It is deleted when the session ends, or 24 hours after its last request.
    • Per-request logs (Workers invocation logs) are off. Only error messages are logged, and they hold no tool arguments. See "Privacy" below.
  • Local install. The npm package runs over stdio on your machine and reads only the content bundled in it; it makes no network requests. Its only runtime dependencies are @modelcontextprotocol/sdk and zod.
  • Maintainer scripts. The scripts in scripts/ (the demo and docs scrapers, the API reference generator) are not part of the npm package and never run in the server.
  • Reporting a vulnerability: https://www.amcharts.com/report-vulnerability/

Privacy

Neither the hosted server nor the npm package needs an account or asks for personal data.

  • Hosted server (https://mcp.amcharts.com/mcp):
    • What your AI app sends: a search phrase, a chart type, a doc path. These are used only to build the answer, and are not logged or stored. A response is kept in the session's storage only until it has been delivered (so a dropped stream can resume), then deleted.
    • Session record: when an AI app connects, the server keeps its MCP initialize message in the session's storage. That message holds what the app says about itself (its name and version, and whatever else it puts there), the protocol version and the app's MCP capabilities. All of the session's storage is deleted when the app ends the session, or 24 hours after its last request.
    • Logs: the server keeps no request logs (Workers invocation logs are off). It runs on Cloudflare Workers, and Cloudflare processes each request, including its IP address, to deliver it. Error and warning messages are logged and kept for up to 7 days; they hold no request contents or tool arguments.
  • npm package: it runs on your computer over stdio and sends nothing to amCharts or anyone else.
  • Policy and questions: see the amCharts privacy policy, or write to [email protected].

License

MIT

版本与发布记录

@amcharts/amcharts5-mcp 共发布 24 个版本,首次发布于 2026/03/15;过去 12 个月发布了 24 个版本。

版本发布日期距今
1.9.4latest2026/10/2613 天前
1.9.32026/10/2513 天前
1.9.22026/10/2315 天前
1.9.12026/10/2315 天前
1.9.02026/10/2216 天前
1.8.02026/10/1920 天前

关于 @amcharts/amcharts5-mcp 的常见问题

@amcharts/amcharts5-mcp 是什么?

On-demand access to amCharts 5 docs, code examples, and API reference

如何安装 @amcharts/amcharts5-mcp?

在项目目录运行 npm install @amcharts/amcharts5-mcp,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 amcharts5-mcp,可以用 npx amcharts5-mcp 直接运行。

@amcharts/amcharts5-mcp 支持 TypeScript 吗?

该包的 package.json 没有声明类型入口。需要类型提示时,可以在 npm 上查找社区维护的 @types/amcharts__amcharts5-mcp 是否存在。

@amcharts/amcharts5-mcp 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@amcharts/amcharts5-mcp 可以商用吗?

@amcharts/amcharts5-mcp 使用 MIT 许可。宽松许可:允许商业使用、修改和再分发,通常只需在分发时保留原版权与许可声明。以上为概括,不构成法律意见,请以许可原文为准。

@amcharts/amcharts5-mcp 的下载量有多少?

根据 npm 官方下载统计,@amcharts/amcharts5-mcp 在 2026/10/06 – 2026/11/04 这 30 天内被下载 4,111 次,日均约 137 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。

@amcharts/amcharts5-mcp 还在维护吗?

最新版本 1.9.4 发布于 2026/10/26(13 天前);至今共发布 24 个版本,其中过去 12 个月发布了 24 个;首次发布于 2026/03/15。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。