Xperience Community: Component Registry

Description

This project enables administrators to view all registered custom components in an Xperience by Kentico application, like Page Builder widgets, and explore which channels and web pages use those components all through a friendly user interface in the Xperience administration.

It optionally exposes the entire component registry over an in-application hosted MCP server, giving agents the ability to identify where components are used across channels, and even visit Page Builder pages using components to visually validate their configuration and design.

Interested in how and why this library was created? Read the blog post Dream and Experiment: Building a Component Registry Dashboard with AI.

Requirements

Library Version Matrix

Xperience Version	Library Version
>= 31.1.1	>= 1.0.0

Dependencies

• ASP.NET Core 10.0
• Xperience by Kentico

Package Installation

Add the "Admin" package to your ASP.NET Core application using the .NET CLI. This includes the custom admin UI application and all required services.

dotnet add package XperienceCommunity.ComponentRegistry.Admin

If you wish to separately install just the registry services, you can use the following:

dotnet add package XperienceCommunity.ComponentRegistry

Quick Start

Register the library's services in your ASP.NET Core application:

// Program.cs

// ...

builder.Services.AddComponentRegistry();
builder.Services.AddComponentRegistryMcp(builder.Configuration);

Run the application and navigate to the "Component Registry" application in the Xperience administration under the "Development" category.

To expose registry definitions and usage data over MCP, enable the configuration section below (disabled by default):

{
  "XperienceCommunity": {
    "ComponentRegistry": {
      "Mcp": {
        "Enabled": true,
        "EndpointPath": "/mcp/component-registry"
      }
    }
  }
}

Then map the endpoint in Program.cs:

app.MapComponentRegistryMcp(app.Configuration);

Configure your project's MCP servers using your AI development tool of choice.

Example: VS Code and GitHub Copilot .vscode/mcp.json

{
  "servers": {
    "kentico-docs-mcp": {
      "type": "http",
      "url": "https://docs.kentico.com/mcp"
    },

    "xperience-community.component-registry": {
      "type": "http",
      "url": "http://localhost:53856/mcp/component-registry"
    }
  }
}

Full Instructions

View the Usage Guide for more detailed instructions on permission management and custom scenarios.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project is provided freely to the Kentico community and has no guaranteed support policy. If updates to this repository are not made on timelines that meet your needs, you are welcome to fork it and customize your version to add features and resolve bugs 😄.