com.vaadin/docs-mcp

Official11 tools

Provides Vaadin Documentation and help with development tasks

Vaadin documentation access and development task assistance.

Captured live from the server via tools/list.

get_vaadin_primer

IMPORTANT: Always use this tool FIRST before working with Vaadin. Returns a comprehensive primer document with current (2025+) information about modern Vaadin development. This addresses common AI misconceptions about Vaadin and provides up-to-date information about Java vs React development models, project structure, components, and best practices. Essential reading to avoid outdated assumptions. For legacy versions (7, 8, 14), returns guidance on version-specific resources.

Parameters (1)

vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3". For legacy versions (7, 8, 14), returns guidance on version-specific resources.

search_vaadin_docs

Search Vaadin documentation for relevant information about Vaadin development, components, and best practices. Uses hybrid semantic + keyword search. USE THIS TOOL for questions about: Vaadin components (Button, Grid, Dialog, etc.), TestBench, UI testing, unit testing, integration testing, @BrowserCallable, Binder, DataProvider, validation, styling, theming, security, Push, Collaboration Engine, PWA, production builds, Docker, deployment, performance, and any Vaadin-specific topics. When using this tool, try to deduce the correct development model from context: use "java" for Java-based views, "react" for React-based views, or "common" for both. Use get_full_document with file_paths containing the result's file_path when you need complete context.

Parameters (5)

questionstringrequired
The search query or question about Vaadin. Will be used to query a vector database with hybrid search (semantic + keyword).
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".
max_resultsnumber
Maximum number of results to return (default: 5)
max_tokensnumber
Maximum number of tokens to return (default: 1500)
ui_languagestring
The UI implementation language: "java" for Java-based views, "react" for React-based views, or "common" for both. If not specified, the agent should try to deduce the correct language from context or asking the user for clarification.

get_full_document

Retrieves complete documentation pages for one or more file paths. Use this when you need full context beyond what search results provide. Provide file_paths only (array).

Parameters (1)

file_pathsarrayrequired
Array of file paths from search results. Use this to fetch one or more documents in a single call.

get_latest_vaadin_version

Returns the latest stable version of Vaadin as a simple JSON object. This is useful when setting up new projects, checking for updates, or when helping with dependency management. Returns: {version, released}.

No parameters.

get_supported_vaadin_versions

Returns the latest stable release for each supported Vaadin major version (25, 24, 23, 14, 8, 7) with version number, release date, and whether it requires a commercial license. Useful for migration planning and understanding which versions are available.

No parameters.

get_components_by_version

Returns a comprehensive list of components available in a specific Vaadin version, including component names, React component names, Java class names, and npm packages.

Parameters (1)

versionstringrequired
The Vaadin version as a minor version (e.g., '24.8', '24.9', '25.0')

get_component_java_api

Returns the Java API documentation for a specific Vaadin component. The component name can be in any format (e.g., 'Button', 'button', 'vaadin-button').

Parameters (2)

component_namestringrequired
The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

get_component_react_api

Returns the React API documentation for a specific Vaadin component. The component name can be in any format (e.g., 'Button', 'button', 'vaadin-button').

Parameters (2)

component_namestringrequired
The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

get_component_web_component_api

Returns the Web Component/TypeScript API documentation for a specific Vaadin component by fetching from external TypeScript API docs. The component name can be in any format (e.g., 'Button', 'button', 'vaadin-button').

Parameters (2)

component_namestringrequired
The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

get_component_styling

Returns the styling/theming documentation for a specific Vaadin component. Returns both Java and React styling documentation when available. The component name can be in any format (e.g., 'Button', 'button', 'vaadin-button').

Parameters (2)

component_namestringrequired
The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

get_theme_css_properties

Returns CSS custom properties documentation for a specific Vaadin theme (Aura, Lumo, or Base styles). Use this to look up the correct CSS variables for the theme the application is using. Base style properties (--vaadin-*) are available in all themes.

Parameters (2)

themestringrequired
The theme to get CSS custom properties for: "aura" (Vaadin 25+ default), "lumo" (classic theme), or "base" (base styles available in all themes, Vaadin 25+ only).
vaadin_versionstringrequired
Required. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

Install

claude_desktop_config.json

{
  "mcpServers": {
    "docs-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.vaadin.com/docs/"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.