a2ui-project / a2ui-project/a2ui
[FEATURE]: Additional per-component metadata for each catalog component
- 主要语言
- TypeScript
- 星标
- 16.4k
- 派生
- 1.3k
- 平均合并
- 2 天 13 小时
- 30 天内合并 PR
- 134
描述
- [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).
贡献指南
调研方向
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.
由索引模型根据 Issue 内容生成。
评估
- 技术栈
- typescript
- 领域
- developer-experience, documentation
- Issue 类型
- 功能
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 活跃度
- 活跃
- 描述清晰度
- 描述清楚
- 新手友好度
- 65/100