Skip to main content
Glama

Get Component Java API

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

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.9/5.0
Behavior3/5

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

With no annotations provided, the description carries the burden. It adds a useful behavioral detail (component name can be in any format) but does not disclose output format, error behavior, or whether the operation is read-only. The description is not misleading, but lacks depth for a tool with no annotations.

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 sentences, both informative. The first states the purpose, the second clarifies input format. No wasted words, and the key information is front-loaded.

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?

The tool is simple, but because there is no output schema and no annotations, the description should explain what the returned documentation looks like. It only says 'documentation', which is vague. However, the purpose and required parameters are sufficiently clear for an agent to invoke the tool correctly.

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 description coverage is 100%, so the baseline is 3. The description's mention of component name format is already present in the schema, and it adds no new meaning for vaadin_version. It does not compensate beyond the schema.

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 uses a specific verb ('Returns') and names the exact resource ('Java API documentation for a specific Vaadin component'). It clearly differentiates from sibling tools like get_component_react_api and get_component_web_component_api by explicitly stating 'Java API'.

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

Usage Guidelines4/5

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

The description provides clear context: use this when you need Java API docs for a specific component. It also clarifies input flexibility (any format for component name). However, it does not explicitly mention alternatives or when not to use it, so it stops short of a 5.

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.