# Vaadin Docs MCP server

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

- Listing: https://mcp.tc/i/vaadin-docs
- Connect: use the server's own URL `https://mcp.vaadin.com/docs` (no sign-in); clients connect to it directly. The listing link is a page, not an MCP endpoint.
- Type: remote (Streamable HTTP)
- Auth: none
- Category: [Docs & Knowledge](https://mcp.tc/c/docs-knowledge)
- Vendor: Vaadin
- Homepage: <https://vaadin.com/docs/latest/>
- Repository: <https://github.com/vaadin/vaadin-documentation-services>

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

## What it 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_api`: Returns Java API documentation for a Vaadin component. (read-only)
- `get_component_react_api`: Returns React API documentation for a Vaadin component. (read-only)
- `get_component_styling`: Returns styling and theming documentation for a component in Java, React or both. (read-only)
- `get_component_web_component_api`: Returns Web Component (TypeScript) API documentation for a component. (read-only)
- `get_components_by_version`: Lists components for a Vaadin minor version with classes, packages and commercial flag. (read-only)
- `get_full_document`: Retrieves whole documentation pages or sections by file path. (read-only)
- `get_java_symbol`: Returns declared and inherited members of a Vaadin Java type, or enum constants. (read-only)
- `get_new_apis`: Lists Java API and documentation pages a Vaadin version added or deprecated. (read-only)
- `get_theme_css_properties`: Returns CSS custom properties for the Aura, Lumo or Base theme. (read-only)
- `get_vaadin_dependency`: Returns Maven and Gradle coordinates and license status for a component or feature. (read-only)
- `get_vaadin_versions`: Lists documented Vaadin versions and the latest known releases. (read-only)
- `search_vaadin_docs`: Searches Vaadin docs and returns ranked chunks filtered by version and UI language. (read-only)
- `get_vaadin_primer`: Returns a primer on what older training data gets wrong for a Vaadin version. (read-only)

## 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."

## Install

### Claude Code

1. Run this in a terminal, in your project folder:

```bash
claude mcp add --transport http vaadin-docs https://mcp.vaadin.com/docs
```

2. 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:

```url
https://mcp.vaadin.com/docs
```

3. 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:

[Add to claude.ai](<https://claude.ai/customize/connectors?modal=add-custom-connector&connectorName=Vaadin%20Docs&connectorUrl=https%3A%2F%2Fmcp.vaadin.com%2Fdocs>) (opens connector settings)

2. Check that the URL reads `https://mcp.vaadin.com/docs` and click **Add**.

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

[Add to Cursor](<https://cursor.com/install-mcp?name=vaadin-docs&config=eyJ1cmwiOiJodHRwczovL21jcC52YWFkaW4uY29tL2RvY3MifQ%3D%3D>) (opens Cursor)

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

`mcp.json`:

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

### VS Code

[Install in VS Code](<https://vscode.dev/redirect/mcp/install?name=vaadin-docs&config=%7B%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.vaadin.com%2Fdocs%22%7D>) (opens VS Code)

Or from a terminal:

```bash
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`:

```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`:

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

2. Refresh the MCP server list in Cascade.

Devin Desktop is the new name for Windsurf. It reads `serverUrl` (or `url`) for remote servers.

### Codex

```bash
codex mcp add vaadin-docs --url https://mcp.vaadin.com/docs
```

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

`config.toml`:

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

### Gemini CLI

```bash
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.

```json
{
  "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`.

## Details

- Server version: 1.1.0
- MCP protocol version: 2025-11-25
- Last checked: 2026-10-03 (reachable)
- Listed: 2026-10-03
- Updated: 2026-10-04

---
Source: https://mcp.tc/i/vaadin-docs (mcp.tc is an independent directory, not affiliated with this server's publisher). Corrections: https://mcp.tc/report