a2ui-project / a2ui-project/a2ui

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

オープン
#2,368 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
P2 status: first-line-handled
主要言語
TypeScript
スター
16.4k
フォーク
1.3k
平均マージ
2日 13時間
マージ済み PR(30日)
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).

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。