Skip to main content
Glama

Get Component React API

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

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
component_nameYesThe name of the component (e.g., 'Button', 'button', 'TextField', 'text-field')
vaadin_versionYesRequired. Vaadin version: "7", "8", "14", "24", "25.0", "25.1", "25.2", or "25.3".

TDQS

A3.7/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It adds a useful behavioral trait (component names accepted in any format) but lacks details on return format, error behavior, or version handling, which for a read-only lookup is only partially transparent.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences are front-loaded with the core purpose, followed by a useful note on input flexibility. No extraneous words or redundant details.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a two-parameter tool with no output schema, the description is mostly adequate. However, it does not mention that vaadin_version is required (left to schema) and provides no guidance on when to choose this over sibling tools, leaving moderate gaps.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3. The description reinforces component_name flexibility but adds no new semantics for vaadin_version beyond what the schema already documents via enum and description.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a specific verb ('Returns') and resource ('React API documentation for a specific Vaadin component'), clearly differentiating it from sibling tools like get_component_java_api and get_component_web_component_api via the 'React' qualifier.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied to be for obtaining React-specific API docs, but no explicit when-to-use or alternatives are mentioned. The flexible naming example is helpful context but does not guide selection among the related component API tools.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A4.1/5.0
Disambiguation5/5

Each tool targets a distinct aspect of Vaadin documentation: Java API, React API, Web Component API, styling, versions, theming, and search. Even the three component API tools are clearly differentiated by the programming model. No ambiguity.

Naming Consistency5/5

All tool names consistently follow the `get_` prefix followed by a descriptive noun phrase (e.g., `get_component_java_api`, `get_supported_vaadin_versions`). No mixing of conventions.

Tool Count5/5

With 11 tools, the server covers the core documentation needs for Vaadin across multiple dimensions (API types, styling, versions, theming, search) without being bloated. Each tool has a clear purpose.

Completeness4/5

The tool set covers most documentation needs: component APIs (Java, React, Web Component), styling, versions, theming, search, and a primer. Minor gaps exist (e.g., direct release notes or changelog), but search and full document retrieval can compensate.