docs-mcp

Server Details

Provides Vaadin Documentation and help with development tasks

Status: Healthy
Last Tested: 2026-03-02 20:30
Transport: Streamable HTTP
URL
Repository: vaadin/vaadin-mcp
GitHub Stars: 12

See and control every tool call

Log every tool call with full inputs and outputs

Control which tools are enabled per connector

Manage credentials once, use from any MCP client

Monitor uptime and get alerted when servers go down

Available Tools

9 tools

get_component_java_apiTry in Inspector

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

ParametersJSON Schema

Name	Required	Description	Default
`component_name`	Yes	The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1".

get_component_react_apiTry in Inspector

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

ParametersJSON Schema

Name	Required	Description	Default
`component_name`	Yes	The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1".

get_components_by_versionTry in Inspector

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

ParametersJSON Schema

Name	Required	Description	Default
`version`	Yes	The Vaadin version as a minor version (e.g., '24.8', '24.9', '25.0')

get_component_stylingTry in Inspector

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').

ParametersJSON Schema

Name	Required	Description	Default
`component_name`	Yes	The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1".

get_component_web_component_apiTry in Inspector

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').

ParametersJSON Schema

Name	Required	Description	Default
`component_name`	Yes	The name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1".

get_full_documentTry in Inspector

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

ParametersJSON Schema

Name	Required	Description	Default
`file_paths`	Yes	Array of file paths from search results. Use this to fetch one or more documents in a single call.

get_vaadin_primerTry in Inspector

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.

ParametersJSON Schema

Name	Required	Description	Default
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1". For legacy versions (7, 8, 14), returns guidance on version-specific resources.

get_vaadin_versionTry in Inspector

Returns the latest stable version of Vaadin Core 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}.

ParametersJSON Schema

Name	Required	Description	Default
No parameters

search_vaadin_docsTry in Inspector

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.

ParametersJSON Schema

Name	Required	Description
`question`	Yes	The search query or question about Vaadin. Will be used to query a vector database with hybrid search (semantic + keyword).
`max_tokens`	No	Maximum number of tokens to return (default: 1500)
`max_results`	No	Maximum number of results to return (default: 5)
`ui_language`	No	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.
`vaadin_version`	Yes	Required. Vaadin version: "7", "8", "14", "24", "25", or "25.1".

To claim this server, publish a /.well-known/glama.json file on your server's domain with the following structure:

{
  "$schema": "https://glama.ai/mcp/schemas/connector.json",
  "maintainers": [
    {
      "email": "your-email@example.com"
    }
  ]
}

The email address must match the email associated with your Glama account. Once verified, the server will appear as claimed by you.

Server Details

Available Tools

Discussions

Your Connectors

Resources