> Markdown version of [Vaadin Directory MCP Server](https://vaadin.com/docs/next/building-apps/agentic-development/directory-mcp). Section index: [llms.txt](https://vaadin.com/docs/next/building-apps/llms.txt)

# Vaadin Directory MCP Server

The Vaadin Directory MCP server gives AI coding agents access to the [Vaadin Directory](https://vaadin.com/directory) add-on catalog. An agent can search for add-ons, get Maven or Gradle installation instructions, and check compatibility with a Vaadin major version.

> **Important:** The **Vaadin Directory MCP server** and the [Vaadin MCP server](https://vaadin.com/docs/next/building-apps/agentic-development/mcp.md) are separate services with different purposes and endpoints:
>
> - `https://vaadin.com/directory/mcp` searches the Vaadin Directory add-on catalog.
>
> - `https://mcp.vaadin.com/docs` searches the Vaadin documentation.
>
> Give them distinct names in your MCP configuration, such as `vaadin-directory` and `vaadin`. You can configure and use both at the same time.

## <a id="configure-your-mcp-client"></a>Configure Your MCP Client

The Directory server uses streamable HTTP transport. Use one of the following configurations, or point any client with native HTTP support to:

```
https://vaadin.com/directory/mcp
```

### <a id="claude-code"></a>Claude Code

Add the server for your user account:

```terminal
claude mcp add vaadin-directory --transport http https://vaadin.com/directory/mcp --scope user
```

To share the configuration with a project instead, run the command from the project directory with `--scope project`. This creates a `.mcp.json` file in the project root.

Alternatively, add the following entry to the `mcpServers` object in `~/.claude.json` or a project `.mcp.json` file:

```json
{
  "mcpServers": {
    "vaadin-directory": {
      "type": "http",
      "url": "https://vaadin.com/directory/mcp"
    }
  }
}
```

Restart Claude Code after changing the configuration.

### <a id="codex"></a>Codex

Add the following to `~/.codex/config.toml`:

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

Restart Codex after changing the configuration. HTTP-based MCP servers require Codex CLI 0.43 or later.

### <a id="other-http-clients"></a>Other HTTP Clients

Add a uniquely named HTTP server to your client’s MCP configuration. The exact outer structure depends on the client; a common JSON format is:

```json
{
  "mcpServers": {
    "vaadin-directory": {
      "type": "http",
      "url": "https://vaadin.com/directory/mcp"
    }
  }
}
```

### <a id="stdio-only-clients"></a>stdio-Only Clients

For a client that supports only stdio transport, use an HTTP adapter:

```json
{
  "mcpServers": {
    "vaadin-directory": {
      "command": "npx",
      "args": ["@pyroprompts/mcp-stdio-to-streamable-http-adapter"],
      "env": {
        "URI": "https://vaadin.com/directory/mcp",
        "MCP_NAME": "vaadin-directory"
      }
    }
  }
}
```

Adapt the outer JSON structure and file location to your client. The adapter requires Node.js 18 or later.

## <a id="use-the-directory-tools"></a>Use the Directory Tools

The server provides two tools:

- `directory_search`

  Searches add-ons by name or keyword. You can filter by Vaadin major version and add-on type, such as component, integration, theme, or tool.

- `directory_getAddon`

  Gets details about a specific add-on, including its latest version, compatibility, installation instructions, documentation, and source links. Use the add-on identifier returned by `directory_search`.

For example, ask your agent:

- "Search Vaadin Directory for chart integrations compatible with Vaadin 24."

- "Find theme add-ons for Vaadin 25."

- "Get installation instructions for this add-on."

When compatibility is important, include the target Vaadin major version in the request. The search result reports a confidence level: an exact version match is high confidence, a major-version match is medium confidence, and a result without a matching version is low confidence.

## <a id="verify-the-connection"></a>Verify the Connection

After restarting your MCP client, ask it to search Vaadin Directory for an add-on. Confirm that the client invokes `directory_search` from `vaadin-directory`, rather than a documentation search tool from the Vaadin MCP server.

For client-specific setup instructions and the current tool reference, see the [Vaadin Directory MCP configuration page](https://vaadin.com/directory/mcp-configuration).