get_api_reference

Get the per-class API reference for an amCharts 5 class: the class page plus its settings table (with defaults) and, optionally, its private/read-only settings. It is generated from the library's typings, so it has the exact setting names and default values (e.g. tooltip background cornerRadius, axis tick `visible` default). Takes a class name in any casing, e.g. 'XYCursor', 'Tooltip', 'PieSeries', 'AxisRendererX'.

read-only

Argument	Type	Description
className*	string	amCharts 5 class name, e.g. 'XYCursor', 'Tooltip', 'PieSeries', 'ColumnSeries', 'AxisRendererX'. Casing/punctuation are ignored.
includePrivate	boolean	Also include the private (read-only / internal) settings table. Default false.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "className"
  ],
  "properties": {
    "className": {
      "type": "string",
      "description": "amCharts 5 class name, e.g. 'XYCursor', 'Tooltip', 'PieSeries', 'ColumnSeries', 'AxisRendererX'. Casing/punctuation are ignored."
    },
    "includePrivate": {
      "type": "boolean",
      "default": false,
      "description": "Also include the private (read-only / internal) settings table. Default false."
    }
  }
}

get_chart_reference

Get the reference documentation for a specific amCharts 5 chart type. A reference longer than 12,000 characters comes as an overview: its first parts in full and a list of the others, each of which get_section returns. With `full: true` it is the whole file. The chart type keywords are listed by list_chart_types.

read-only

Argument	Type	Description
full	boolean	true: the whole reference, however long. false (default): an overview when it is long.
chartType*	string	Chart type keyword, e.g. 'pie', 'sankey', 'xy', 'treemap', 'map', 'radar', 'stock', 'gantt', 'venn', 'wordcloud', 'timeline', 'flow', 'hierarchy', 'ui-elements'

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "chartType"
  ],
  "properties": {
    "full": {
      "type": "boolean",
      "default": false,
      "description": "true: the whole reference, however long. false (default): an overview when it is long."
    },
    "chartType": {
      "type": "string",
      "description": "Chart type keyword, e.g. 'pie', 'sankey', 'xy', 'treemap', 'map', 'radar', 'stock', 'gantt', 'venn', 'wordcloud', 'timeline', 'flow', 'hierarchy', 'ui-elements'"
    }
  }
}

get_core_reference

Get the core amCharts 5 reference (SKILL.md) — covers setup, colors, themes, legends, tooltips, events, data, adapters, disposal, and common pitfalls. It is the base for every chart type; the chart-specific references build on it. It comes as an overview: its first sections, up to 12,000 characters, and a list of the others, each of which get_section("SKILL", heading) returns. With `full: true` it is the whole file.

read-only

Argument	Type	Description
full	boolean	true: the whole SKILL.md (about 105,000 characters). false (default): the overview.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "full": {
      "type": "boolean",
      "default": false,
      "description": "true: the whole SKILL.md (about 105,000 characters). false (default): the overview."
    }
  }
}

get_doc

Get a full documentation page — an extended doc by path, or a skill file by 'skill/<name>'. Paths are the source labels that search_docs and search_all print.

read-only

Argument	Type	Description
path*	string	Doc path, e.g. 'charts/xy-chart/cursor', 'concepts/events', 'getting-started/integrations/react', 'reference/xycursor' (per-class API), or a skill file such as 'skill/SKILL.md' / 'skill/xy'. A class's full settings and defaults are in its API reference (get_api_reference).

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "path"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Doc path, e.g. 'charts/xy-chart/cursor', 'concepts/events', 'getting-started/integrations/react', 'reference/xycursor' (per-class API), or a skill file such as 'skill/SKILL.md' / 'skill/xy'. A class's full settings and defaults are in its API reference (get_api_reference)."
    }
  }
}

get_example

Get the full code for a specific amCharts 5 example/demo. Paths are listed by list_examples and printed in search results.

read-only

Argument	Type	Description
path*	string	Example path, e.g. 'examples/flow/sankey-diagram', 'examples/pie-donut/donut-chart', 'examples/maps/drill-down-map'

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "path"
  ],
  "properties": {
    "path": {
      "type": "string",
      "description": "Example path, e.g. 'examples/flow/sankey-diagram', 'examples/pie-donut/donut-chart', 'examples/maps/drill-down-map'"
    }
  }
}

get_quick_start

Get a quick-start template for a specific chart type — a minimal working example ready to customize.

read-only

Argument	Type	Description
format	string	Output format: 'html' for a full HTML page with CDN scripts, 'esm' for ES module imports
chartType*	string	Chart type, e.g. 'pie', 'line', 'bar', 'map', 'sankey', 'treemap'

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "chartType"
  ],
  "properties": {
    "format": {
      "enum": [
        "html",
        "esm"
      ],
      "type": "string",
      "default": "html",
      "description": "Output format: 'html' for a full HTML page with CDN scripts, 'esm' for ES module imports"
    },
    "chartType": {
      "type": "string",
      "description": "Chart type, e.g. 'pie', 'line', 'bar', 'map', 'sankey', 'treemap'"
    }
  }
}

get_section

Get the full text of one section of a doc by heading, for example a section that a search_docs or search_all result shows truncated. `file` accepts the source label exactly as search results print it ('skill/SKILL.md', 'skill/xy', 'extended/charts/xy-chart/cursor', 'reference/xycursor') as well as a bare skill file name ('SKILL', 'xy', 'map').

read-only

Argument	Type	Description
file*	string	Doc identifier: a skill file ('SKILL', 'xy', 'pie', 'map') or a source label from search results ('skill/SKILL.md', 'extended/concepts/events', 'reference/xycursor'). '.md' and 'skill/' / 'extended/' prefixes are optional.
heading*	string	Section heading to retrieve (case-insensitive substring), e.g. 'Core setup pattern', 'Axis types', 'Common pitfalls', 'Recent API changes'. A ### subsection heading returns just that subsection.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "file",
    "heading"
  ],
  "properties": {
    "file": {
      "type": "string",
      "description": "Doc identifier: a skill file ('SKILL', 'xy', 'pie', 'map') or a source label from search results ('skill/SKILL.md', 'extended/concepts/events', 'reference/xycursor'). '.md' and 'skill/' / 'extended/' prefixes are optional."
    },
    "heading": {
      "type": "string",
      "description": "Section heading to retrieve (case-insensitive substring), e.g. 'Core setup pattern', 'Axis types', 'Common pitfalls', 'Recent API changes'. A ### subsection heading returns just that subsection."
    }
  }
}

list_chart_types

List all amCharts 5 chart types with their categories and reference file names

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {}
}

list_examples

List all available amCharts 5 code examples, optionally filtered by category.

read-only

Argument	Type	Description
category	string	Filter by category, e.g. 'column-bar', 'line-area', 'pie-donut', 'maps', 'flow', 'hierarchy', 'stock', 'gantt', 'gauges', 'radar-polar', 'timeline', 'funnel-pyramid', or 'json-configs' (complete JSON configs from the amCharts npm package). Without it, all categories are listed.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "category": {
      "type": "string",
      "description": "Filter by category, e.g. 'column-bar', 'line-area', 'pie-donut', 'maps', 'flow', 'hierarchy', 'stock', 'gantt', 'gauges', 'radar-polar', 'timeline', 'funnel-pyramid', or 'json-configs' (complete JSON configs from the amCharts npm package). Without it, all categories are listed."
    }
  }
}

list_geodata

List amCharts 5 geodata (map) files with each one's CDN path, script global name and ES module import: world maps, continents, every country map, regional packs (US states and counties, Canada, Mexico) and the US congressional-district packs, which are versioned per Congress (congressional120 = 120th Congress is the newest). Also the data/countries2 and lang/* helper files. It gives the exact file path and global name that map code needs.

read-only

Argument	Type	Description
filter	string	Words that must all match (case-insensitive) a map's path, label, group, ISO code or pack, e.g. 'germany', 'FR', 'region/canada', 'usa counties', 'congressional120', 'congressional whole country', 'continents', 'countries2'. A file or global name ('usaCongressionalLow', 'am5geodata_worldLow') works too. Without it, the result is an overview.

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "properties": {
    "filter": {
      "type": "string",
      "description": "Words that must all match (case-insensitive) a map's path, label, group, ISO code or pack, e.g. 'germany', 'FR', 'region/canada', 'usa counties', 'congressional120', 'congressional whole country', 'continents', 'countries2'. A file or global name ('usaCongressionalLow', 'am5geodata_worldLow') works too. Without it, the result is an overview."
    }
  }
}

search_all

Search across all amCharts 5 content: skill references, full documentation, and code examples. For broad searches across everything.

read-only

Argument	Type	Description
query*	string	Search query, e.g. 'react integration', 'date axis formatting', 'stacked bar example'
maxResults	number	Maximum results (default 10)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query, e.g. 'react integration', 'date axis formatting', 'stacked bar example'"
    },
    "maxResults": {
      "type": "number",
      "default": 10,
      "description": "Maximum results (default 10)"
    }
  }
}

search_docs

Search the curated amCharts 5 skill docs (SKILL.md + chart references) for a keyword or topic, returning matching sections ranked by relevance. By default it searches only the skill layer. With scope 'all' it also searches the extended docs, the per-class API reference and the code examples. Per-setting defaults (e.g. tooltip background cornerRadius, axis tick `visible` default, cursor line strokeDasharray) are in the extended docs and the API reference, which search_all, get_api_reference and get_doc also return.

read-only

Argument	Type	Description
query*	string	Search query, e.g. 'legend', 'axis label rotation', 'tooltip format', 'data processor'
scope	string	'skill' (default) searches only the curated skill docs; 'all' also searches the extended docs / per-class API reference where settings and defaults live, and the code examples.
maxResults	number	Maximum number of results to return (default 5)

Input schema (JSON)

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "query"
  ],
  "properties": {
    "query": {
      "type": "string",
      "description": "Search query, e.g. 'legend', 'axis label rotation', 'tooltip format', 'data processor'"
    },
    "scope": {
      "enum": [
        "skill",
        "all"
      ],
      "type": "string",
      "default": "skill",
      "description": "'skill' (default) searches only the curated skill docs; 'all' also searches the extended docs / per-class API reference where settings and defaults live, and the code examples."
    },
    "maxResults": {
      "type": "number",
      "default": 5,
      "description": "Maximum number of results to return (default 5)"
    }
  }
}

amCharts 5

Try it

get_api_reference Read-only

amCharts 5

Try it

get_api_reference Read-only

Tools (12)