Vaadin Docs

listing.by

Search Vaadin documentation, look up component APIs, Java symbols, dependencies and new APIs by version for Java and React.

state.ok.long (state.ok.title)Streamable HTTP

listing.connect

listing.explain.none

https://mcp.vaadin.com/docs

listing.note.none listing.note.none_direct

listing.share.h

listing.share.p

mcp.tc/i/vaadin-docs

listing.about

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.

listing.can

  • 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

listing.tools 13

  • get_component_java_apilisting.hint.ro

    Returns Java API documentation for a Vaadin component.

  • get_component_react_apilisting.hint.ro

    Returns React API documentation for a Vaadin component.

  • get_component_stylinglisting.hint.ro

    Returns styling and theming documentation for a component in Java, React or both.

  • get_component_web_component_apilisting.hint.ro

    Returns Web Component (TypeScript) API documentation for a component.

  • get_components_by_versionlisting.hint.ro

    Lists components for a Vaadin minor version with classes, packages and commercial flag.

  • get_full_documentlisting.hint.ro

    Retrieves whole documentation pages or sections by file path.

  • get_java_symbollisting.hint.ro

    Returns declared and inherited members of a Vaadin Java type, or enum constants.

  • get_new_apislisting.hint.ro

    Lists Java API and documentation pages a Vaadin version added or deprecated.

  • get_theme_css_propertieslisting.hint.ro

    Returns CSS custom properties for the Aura, Lumo or Base theme.

  • get_vaadin_dependencylisting.hint.ro

    Returns Maven and Gradle coordinates and license status for a component or feature.

  • get_vaadin_versionslisting.hint.ro

    Lists documented Vaadin versions and the latest known releases.

  • search_vaadin_docslisting.hint.ro

    Searches Vaadin docs and returns ranked chunks filtered by version and UI language.

listing.tools_more
  • get_vaadin_primerlisting.hint.ro

    Returns a primer on what older training data gets wrong for a Vaadin version.

listing.prov.live_on listing.prov.hints

listing.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.

listing.setup.h

listing.setup.remote

Claude Code

  1. Run this in a terminal, in your project folder:
claude mcp add --transport http vaadin-docs https://mcp.vaadin.com/docs
  1. 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

  1. Open Settings → Connectors and click Add custom connector.
  2. Name it Vaadin Docs and paste this URL:
https://mcp.vaadin.com/docs
  1. 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

  1. Open the connector form on claude.ai. This button fills in the name and URL for you:
  1. Check that the URL reads https://mcp.vaadin.com/docs and click Add.
  2. 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

  1. On chatgpt.com, open Settings → Security and login and turn on Developer mode.
  2. Go to chatgpt.com/plugins and click + to create an app for a remote MCP server.
  3. Paste https://mcp.vaadin.com/docs as the server URL and choose No authentication.

Developer mode is available on the web for Plus, Pro, Business, Enterprise and Education accounts.

Cursor

Or add it by hand to ~/.cursor/mcp.json (all projects) or .cursor/mcp.json (this project):

mcp.json
{
  "mcpServers": {
    "vaadin-docs": {
      "url": "https://mcp.vaadin.com/docs"
    }
  }
}

VS Code

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:

.vscode/mcp.json
{
  "servers": {
    "vaadin-docs": {
      "type": "http",
      "url": "https://mcp.vaadin.com/docs"
    }
  }
}

Devin Desktop

  1. Add it to ~/.config/devin/mcp_config.json (macOS and Linux) or %APPDATA%\devin\mcp_config.json (Windows):
mcp_config.json
{
  "mcpServers": {
    "vaadin-docs": {
      "serverUrl": "https://mcp.vaadin.com/docs"
    }
  }
}
  1. 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/docs

Or edit ~/.codex/config.toml directly:

config.toml
[mcp_servers.vaadin-docs]
url = "https://mcp.vaadin.com/docs"

Gemini CLI

gemini mcp add --transport http vaadin-docs https://mcp.vaadin.com/docs

This 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.

listing.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 in developer mode, Cursor, VS Code, Devin Desktop, Codex, Gemini CLI, Zed and others. The setup steps cover each one.

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.

listing.em.h

listing.em.lead listing.em.how

listing.em.badge

em.prev_lightem.prev_dark
Markdown
[![Vaadin Docs on mcp.tc](https://mcp.tc/i/vaadin-docs/badge.svg)](https://mcp.tc/i/vaadin-docs)
HTML
<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>

listing.em.badge_note

listing.em.widget

HTML
<script src="https://mcp.tc/w/vaadin-docs.js" async></script>

listing.em.widget_note

iframe

HTML
<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>

listing.em.iframe_note

JSON

listing.em.json

https://mcp.tc/i/vaadin-docs.json

listing.em.fields

listing.disclaimer_checked