v7.3.0
SupportExamplesFree Trial

Bryntum Model Context Protocol (MCP) Server

The Bryntum MCP server provides AI coding assistants with access to version-specific Bryntum documentation, including API references, configuration options, and live examples. Use it to get accurate, context-aware guidance when integrating and configuring Bryntum components.

Installation

You can install the MCP server in your AI coding tool of choice.

Claude CodeOpenAI CodexCursorVS Code
claude mcp add --transport http bryntum https://mcp.bryntum.com

codex mcp add bryntum --url https://mcp.bryntum.com
  • Open the Command Palette (Cmd + Shift + P on Mac, Ctrl + Shift + P on Windows) and run View: Open MCP Settings. This opens the .cursor/mcp.json file.
  • Add the following property to the mcpServers JSON object:
"Bryntum": {
  "url": "https://mcp.bryntum.com",
  "type": "http"
}
  • Open the Command Palette (Cmd + Shift + P on Mac, Ctrl + Shift + P on Windows) and run MCP: Add Server....
  • Select HTTP (HTTP or Server-Sent Events) Connect to a remote HTTP server that implements the MCP protocol.
  • Enter https://mcp.bryntum.com in the Server URL input.
This adds the following JSON object property to the .vscode/mcp.json file: 
{
    "servers": {
        "Bryntum MCP": {
            "url": "https://mcp.bryntum.com",
            "type": "http"
        }
    },
    "inputs": []
}

You can also install it in AI building platforms that support custom MCP servers, such as Lovable, Replit, and Bolt.

Documentation search tool

The MCP server has a search_bryntum_docs tool that accepts a natural language query and returns version-specific documentation results, including source code, configuration options, and links to live examples. You can filter results by product (for example, Scheduler, Gantt, Calendar) and by version.

The tool name is search_bryntum_docs (full name: mcp__bryntum__search_bryntum_docs).

The search_bryntum_docs tool supports the following parameters:

Name Type Required Description
query string Yes Search term, for example, "infinite scroll"
limit number No Maximum number of results to return (default: 10, max: 100)
product string No Filter by a specific Bryntum product, for example, scheduler
version string No Filter by documentation version. Use "latest" for the most recent version

For example, you could ask your AI coding assistant: "How to create a zoom in and zoom out button"

Here's the first part of the search_bryntum_docs response:

## Result 1
**Product:** schedulerpro
**Version:** 7.2.1
**File:** 
**Relevance:** 0.466

[zoomToSpan](https://bryntum.com/docs/schedulerpro/api/Scheduler/view/mixin/TimelineZoomable#function-zoomToSpan)
Sets time frame to specified range and applies zoom level which allows to fit all columns to this range.

The given time span will be centered in the scheduling view, in the same time, the start/end date of the whole time axis will be extended in the same way as [zoomToLevel](https://bryntum.com/docs/schedulerpro/api/#Scheduler/view/mixin/TimelineZoomable#function-zoomToLevel) method does, to allow scrolling for user.
...

The Relevance score shows how closely a search result matches your query. Higher scores mean a better match, they are used for ranking results within the same search.

Usage example

With the MCP server installed, you can ask your AI coding assistant to help you build and configure Bryntum components. For example, you could give it the following prompt:

Add a zoom in and zoom out buttons to the top of the scheduler

The AI coding assistant uses the search_bryntum_docs tool to look up the relevant API references and generates code based on the official documentation:

The MCP server provides version-specific documentation, which means the generated code uses the correct API for your version of Bryntum. It uses the latest version if not specified.

Contents