a2ui-project / a2ui-project/a2ui

[FEATURE]: Additional per-component metadata for each catalog component

Open
#2,368 1 comment 0 reactions 0 assignees View on GitHub
P2 status: first-line-handled
Dominant language
TypeScript
Stars
16.4k
Forks
1.3k
Avg merge
2d 13h
Merged PRs (30d)
134

Description

- [x ] I have searched the existing issues to make sure this feature has not already been requested.

## Is your feature request related to a problem? Please describe.

Currently all metadata about a component must be placed into either the `name` or `description` properties. When richer semantic information is available, it must be jammed into the `description` field with some catalog-dependent and fixed format.

## Describe the Proposed Solution

Add additional optional metadata properties to each component at the `description` level, with known semantics.

Recommendations:

1. Add `usage`: Explicit usage instructions such as `"Use small for lower emphasis, or when space is tight. Use large for higher emphasis, or when number is important. Text label above 999 should cap at \"999+\"."`
1. Add `similar_components`: A map of component names to instructions for selecting the component, e.g. `{ "Chip": "Use for longer labels.", ...}`
1. Update the catalog-to-prompt logic to include these fields.

## Describe Alternatives Considered

Jamming these into the description. Prevents future progressive disclosure opportunities and any optimizations on how to best present these to the agent (because the format in which they are jammed into the description becomes fixed by the catalog owner).

Contributor guide

Open the contributing guide

Research direction

Look at the component catalog structure, likely in a file like `src/catalog/types.ts` or similar, to understand the existing `name` and `description` properties. Identify where components are defined and where the catalog-to-prompt logic resides. Add the new optional fields (`usage`, `similar_components`) to the component metadata interface and update the prompt generation logic to include them. Test by verifying that a sample component with the new metadata is correctly processed and appears in generated prompts.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.