Vaadin Docs
MCP server by Vaadin
Search Vaadin documentation, look up component APIs, Java symbols, dependencies and new APIs by version for Java and React.
Connect to Vaadin Docs
No sign-in needed. Connect with Vaadin Docs’s own URL:
Paste it into any client that supports remote MCP servers. Your client talks to Vaadin directly, not through mcp.tc.
Share this server
Opens this page, with the URL and setup steps.
mcp.tc/i/vaadin-docsAbout
Connects to Vaadin's documentation and returns ranked doc chunks, full pages, component API and styling guides, Java type members from the javadoc, Maven coordinates and per-version lists of new APIs. Results can be filtered by UI language (Java, React or common) and by Vaadin version, covering 24 and 25.x for Java and React plus legacy 7, 8 and 14 for Java.
The server is hosted at https://mcp.vaadin.com/docs and uses streamable HTTP. No sign-in or API key is needed. Note that the URL without the trailing slash is the one that responds.
What you can do
- Search Vaadin docs filtered by version and Java or React
- Read full documentation pages or single sections
- Get Java, React and Web Component API docs for a component
- Look up Java type members, including inherited ones
- List components and Maven dependency coordinates per version
- See which APIs a Vaadin version introduced
- Read theme CSS properties for Lumo, Aura and Base styles
Tools 13
get_component_java_apiRead-onlyReturns Java API documentation for a Vaadin component.
get_component_react_apiRead-onlyReturns React API documentation for a Vaadin component.
get_component_stylingRead-onlyReturns styling and theming documentation for a component in Java, React or both.
get_component_web_component_apiRead-onlyReturns Web Component (TypeScript) API documentation for a component.
get_components_by_versionRead-onlyLists components for a Vaadin minor version with classes, packages and commercial flag.
get_full_documentRead-onlyRetrieves whole documentation pages or sections by file path.
get_java_symbolRead-onlyReturns declared and inherited members of a Vaadin Java type, or enum constants.
get_new_apisRead-onlyLists Java API and documentation pages a Vaadin version added or deprecated.
get_theme_css_propertiesRead-onlyReturns CSS custom properties for the Aura, Lumo or Base theme.
get_vaadin_dependencyRead-onlyReturns Maven and Gradle coordinates and license status for a component or feature.
get_vaadin_versionsRead-onlyLists documented Vaadin versions and the latest known releases.
search_vaadin_docsRead-onlySearches Vaadin docs and returns ranked chunks filtered by version and UI language.
Show 1 more tool
get_vaadin_primerRead-onlyReturns a primer on what older training data gets wrong for a Vaadin version.
Read from the live server on 17 Nov 2026. Read-only, Writes and Can delete are hints the server declares; your client decides whether to ask before running a tool.
Example prompts
How do I add a Grid with paginated data in Vaadin 25 Java?
What new APIs did Vaadin 25.2 introduce?
Which Maven dependency do I need for Vaadin Charts?
Show the CSS custom properties for the Lumo theme in Vaadin 24.
Set up
Every client connects to mcp.vaadin.com. Pick yours; the page remembers your choice.
Claude Code
- Run this in a terminal, in your project folder:
claude mcp add --transport http vaadin-docs https://mcp.vaadin.com/docs- Start Claude Code and type
/mcp. vaadin-docs should show as connected.
Add --scope user to make it available in every project, not just this one.
Claude Desktop
- Open Customize → Connectors, click + Add, then Add custom connector.
- Name it Vaadin Docs and paste this URL:
https://mcp.vaadin.com/docs- Click Add. Its tools appear in the chat’s tools menu.
Claude Desktop’s JSON config file only starts local servers. Remote servers go through Connectors, and connectors you add on claude.ai show up here too.
claude.ai
- Open the connector form on claude.ai. This button fills in the name and URL for you:
Add to claude.ai (opens in a new tab)
- Check that the URL reads
https://mcp.vaadin.com/docsand click Add. - Turn it on in a chat from the tools menu.
Free plans allow one custom connector. On Team and Enterprise plans an owner adds it under Organization settings → Connectors.
ChatGPT
- On chatgpt.com, go to Plugins, select +, then Add custom MCP server.
- Enter a name for the server.
- Under Connection, paste
https://mcp.vaadin.com/docsas the server URL, then for authentication choose No authentication. - Check I understand and want to continue, then select Create as a plugin.
Whether you can add a custom MCP server depends on your ChatGPT plan and your workspace permissions (in Business workspaces, admins and owners can).
Cursor
Add to Cursor (opens in a new tab)
Or add it by hand to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (this project):
{
"mcpServers": {
"vaadin-docs": {
"url": "https://mcp.vaadin.com/docs"
}
}
}VS Code
Install in VS Code (opens in a new tab)
Or from a terminal:
code --add-mcp '{"name":"vaadin-docs","type":"http","url":"https://mcp.vaadin.com/docs"}'Or commit it to the repo in .vscode/mcp.json:
{
"servers": {
"vaadin-docs": {
"type": "http",
"url": "https://mcp.vaadin.com/docs"
}
}
}Devin Desktop
- Add it to
~/.config/devin/mcp_config.json(macOS and Linux) or%APPDATA%\devin\mcp_config.json(Windows):
{
"mcpServers": {
"vaadin-docs": {
"serverUrl": "https://mcp.vaadin.com/docs"
}
}
}- Refresh the MCP server list in Cascade.
Devin Desktop is the new name for Windsurf. It reads serverUrl (or url) for remote servers.
Codex
codex mcp add vaadin-docs --url https://mcp.vaadin.com/docsOr edit ~/.codex/config.toml directly:
[mcp_servers.vaadin-docs]
url = "https://mcp.vaadin.com/docs"Gemini CLI
gemini mcp add --transport http vaadin-docs https://mcp.vaadin.com/docsThis adds it to the current project. Add -s user to use it everywhere.
Any client
Most clients accept this shape. Some name the URL field differently: serverUrl in Devin Desktop, httpUrl in Gemini CLI’s settings file.
{
"mcpServers": {
"vaadin-docs": {
"type": "http",
"url": "https://mcp.vaadin.com/docs"
}
}
}Zed puts servers under context_servers in its settings. Cline needs "type": "streamableHttp", or it assumes SSE.
Client only starts local servers? Bridge it with npx -y mcp-remote https://mcp.vaadin.com/docs.
Embed
Show Vaadin Docs in a README or on your site. Each embed links to this page, uses the server’s own URL, and sets no cookies. How embeds work
The card, the iframe and the JSON are in English. Add ?lang=it, fr, de or es to their address for another language.
README badge
[](https://mcp.tc/i/vaadin-docs)<a href="https://mcp.tc/i/vaadin-docs"><img src="https://mcp.tc/i/vaadin-docs/badge.svg" alt="Vaadin Docs on mcp.tc" height="20"></a>It follows the reader’s light or dark mode. Add ?theme=light or ?theme=dark to fix it, or ?style=compact to show the mark without the word.
Website card
<script src="https://mcp.tc/w/vaadin-docs.js" async></script>The card appears where the tag is. Add data-theme="dark" or data-size="compact" to the tag to change it. The file holds everything it needs, so it makes no other requests and sets no cookies.
iframe
<iframe src="https://mcp.tc/embed/vaadin-docs" title="Vaadin Docs on mcp.tc" width="420" height="200" loading="lazy" allow="clipboard-write" style="border:0;border-radius:8px;max-width:100%"></iframe>Use it on pages that don’t allow scripts. Add ?theme=light or ?theme=dark to the address to fix the colors.
JSON
The listing as data for your own pages and tools: name, tagline, the server’s own URL, tools and the “Add to” links. Any site can read it (CORS is open).
https://mcp.tc/i/vaadin-docs.jsonAI prompt
Paste this into an AI coding assistant, such as Claude Code or Cursor, and it adds the Vaadin Docs card to your site.
Add the mcp.tc card for Vaadin Docs, an MCP server, to my website. It is one static script: no build step, no package to install, no cookies.
Put this tag where the card should appear. The card renders right before it:
```html
<script src="https://mcp.tc/w/vaadin-docs.js" async></script>
```
To show the card somewhere else, put this placeholder there and load the same script once, for example before `</body>`. Keep the link inside: visitors without JavaScript see it.
```html
<div data-mcptc="vaadin-docs"><a href="https://mcp.tc/i/vaadin-docs">Vaadin Docs on mcp.tc</a></div>
```
Options:
- `data-theme="light"` or `"dark"` on the tag or the placeholder fixes the colors. Without it, the card follows the visitor’s light or dark mode.
- `data-size="compact"` gives a smaller card without the tagline.
- The CSS variable `--mcptc-max-width` on the placeholder or a parent sets the width (default `520px`).
- `?lang=` on the script URL sets the card’s language: `en`, `it`, `fr`, `de` or `es`.
If the site has a Content Security Policy, allow `script-src https://mcp.tc` and `img-src data:` (the icon is inline).
For a README or other Markdown docs, use the badge instead:
```markdown
[](https://mcp.tc/i/vaadin-docs)
```
Reference: https://mcp.tc/embedChange history
We read this server’s tool list every 3 hours and record what changes. Last read 18 Nov 2026, 05:34 UTC.
-
New version 1.4.0 (was 1.3.0). Reported by the server.
-
New version 1.3.0 (was 1.2.0). Reported by the server.
-
New version 1.2.0 (was 1.1.0). Reported by the server.
-
11 tools changed. Server instructions changed.
New server instructions
Details, 7 Oct 2026, 13:31 UTC
Changed 11
get_component_java_apiinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_component_react_apiinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_component_stylinginput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_component_web_component_apiinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_components_by_versioninput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_java_symbolinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_new_apisinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_theme_css_propertiesinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_vaadin_dependencyinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
get_vaadin_primerinput schema- Description of
vaadin_versionBeforeVaadin version. One of:
7,8,14,24,25.0,25.1,25.2,25.3.An unlisted bare major resolves to that major's newest released minor. Answers are per version.AfterVaadin version. One of: 7,8,14,24,25.0,25.1,25.2,25.3,25.4. An unlisted bare major resolves to that major's newest released minor. Answers are per version.
- Description of
search_vaadin_docsServer instructions
BeforeLicense valid until 2036-09-07. Vaadin documentation MCP server. Use search_vaadin_docs to retrieve ranked chunks from Vaadin's docs filtered by ui_language (java/react/common) and vaadin_version. Supported versions are 24, 25.0, 25.1, 25.2, 25.3 (Java + React) and 7, 8, 14 (Java-only legacy). The parity alias "25" resolves to the highest released 25.x. Vaadin adds API faster than model training data is refreshed: before writing code against a version, call get_vaadin_primer and get_new_apis — an API added after your cutoff is one you cannot know you are missing. get_new_apis answers with a summary and the full counts beside it; raise its max_results for a version's whole arrival history. get_new_apis answers from Vaadin's own javadoc and from the documentation pages Vaadin marks as covering newly introduced API, each with a path for get_full_document, and both halves answer for
aprereleasepartition too,whose javadoc is its newest alpha. If a tool reports a half it could not fill, that is this image saying so rather than a malfunction. And before writing a call you are not certain of, or concluding that some method or enum constant does not exist, call get_java_symbol: it returns a type's members from the same javadoc, including the ones it inherits from base classes and mixin interfaces, which is where most of a Vaadin component's API is declared.AfterLicense valid until 2036-09-07. Vaadin documentation MCP server. Use search_vaadin_docs to retrieve ranked chunks from Vaadin's docs filtered by ui_language (java/react/common) and vaadin_version. Supported versions are 24, 25.0, 25.1, 25.2, 25.3 (Java + React) and 7, 8, 14 (Java-only legacy). 25.4 is the next, unreleased minor, indexed from vaadin/docs main for pre-release testing — see get_vaadin_versions, which flags it, and don't recommend it for production work. The parity alias "25" resolves to the highest released 25.x. Vaadin adds API faster than model training data is refreshed: before writing code against a version, call get_vaadin_primer and get_new_apis — an API added after your cutoff is one you cannot know you are missing. get_new_apis answers with a summary and the full counts beside it; raise its max_results for a version's whole arrival history. get_new_apis answers from Vaadin's own javadoc and from the documentation pages Vaadin marks as covering newly introduced API, each with a path for get_full_document, and both halves answer for the prerelease partition, whose javadoc is its newest alpha. If a tool reports a half it could not fill, that is this image saying so rather than a malfunction. And before writing a call you are not certain of, or concluding that some method or enum constant does not exist, call get_java_symbol: it returns a type's members from the same javadoc, including the ones it inherits from base classes and mixin interfaces, which is where most of a Vaadin component's API is declared.
-
Tracking started: 13 tools.
FAQ
Can I paste mcp.tc/i/vaadin-docs into my MCP client?
No. mcp.tc links are pages, not server addresses. Connect with https://mcp.vaadin.com/docs, so your client talks to Vaadin Docs directly. The quick link is for sharing: it opens this page, with setup steps for every client.
Does Vaadin Docs need an API key or a sign-in?
No. Vaadin Docs doesn’t ask for an account or key.
Is Vaadin Docs a remote or a local server?
Remote. Vaadin hosts it at https://mcp.vaadin.com/docs, and it speaks Streamable HTTP. There’s nothing to install.
What can Vaadin Docs do?
It has 13 tools, including get_component_java_api, get_component_react_api and get_component_styling. You can search Vaadin docs filtered by version and Java or React, read full documentation pages or single sections and get Java, React and Web Component API docs for a component.
Which clients can use it?
Any client that supports remote MCP servers: Claude Code, Claude Desktop, claude.ai, ChatGPT, Cursor, VS Code, Devin Desktop, Codex, Gemini CLI, Zed and others. The setup steps cover each one.
Does mcp.tc track changes to Vaadin Docs?
Yes. Vaadin Docs’s History tab shows each change we find to its tools, down to descriptions and parameters, plus new versions and edits by its owner. Follow the listing to get an email when it changes.
Who wrote this page?
mcp.tc’s robot read Vaadin Docs’s own metadata (its MCP handshake, tool list and public pages), and an AI model drafted the text from it. A person reviews anything the checks can’t confirm. The text can still be wrong, so if you spot a mistake, use Report this listing on this page.
mcp.tc isn’t affiliated with Vaadin. This page was built from Vaadin Docs’s public metadata, last checked on 17 Nov 2026, and an AI model wrote the description, so it can be wrong. Names and marks belong to their owners. Something off? Report this listing.