-
Notifications
You must be signed in to change notification settings - Fork 733
v0.9 Spec: Add identity fields to theme #499
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds iconUrl and agentDisplayName to the theme definition in the v0.9 specification, enhancing agent identification and security. The changes are well-documented in both the protocol markdown file and the standard catalog JSON schema. My review includes a couple of minor suggestions to improve documentation consistency and fix a formatting issue in the markdown.
| | :----------------- | :----- | :-------------------------------------------------------------------------------------------------------- | | ||
| | **primaryColor** | String | The primary UI color as a hexadecimal code (e.g., '#00BFFF'). | | ||
| | **iconUrl** | URI | A URL for an image (e.g., logo or avatar) that identifies the agent or tool associated with the surface. | | ||
| | **agentDisplayName**| String | Text to be displayed next to the surface to identify the agent or tool that created it (e.g. "Weather Bot").| |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a minor formatting issue in the markdown table. The agentDisplayName property is missing a space before the closing pipe |, which might cause rendering issues in some markdown viewers. Adding a space will ensure the table is correctly formatted.
| | **agentDisplayName**| String | Text to be displayed next to the surface to identify the agent or tool that created it (e.g. "Weather Bot").| | |
| | **agentDisplayName** | String | Text to be displayed next to the surface to identify the agent or tool that created it (e.g. "Weather Bot").| |
| "iconUrl": { | ||
| "type": "string", | ||
| "format": "uri", | ||
| "description": "A URL for an image that identifies the agent or tool associated with the surface." | ||
| }, | ||
| "agentDisplayName": { | ||
| "type": "string", | ||
| "description": "Text to be displayed next to the surface to identify the agent or tool that created it." | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For consistency with the documentation in a2ui_protocol.md, consider adding the examples to the descriptions of iconUrl and agentDisplayName. This provides more context for developers using the schema directly and ensures both documents are aligned.
| "iconUrl": { | |
| "type": "string", | |
| "format": "uri", | |
| "description": "A URL for an image that identifies the agent or tool associated with the surface." | |
| }, | |
| "agentDisplayName": { | |
| "type": "string", | |
| "description": "Text to be displayed next to the surface to identify the agent or tool that created it." | |
| } | |
| "iconUrl": { | |
| "type": "string", | |
| "format": "uri", | |
| "description": "A URL for an image (e.g., logo or avatar) that identifies the agent or tool associated with the surface." | |
| }, | |
| "agentDisplayName": { | |
| "type": "string", | |
| "description": "Text to be displayed next to the surface to identify the agent or tool that created it (e.g. \"Weather Bot\")." | |
| } |
This PR updates the v0.9 specification to include iconUrl and agentDisplayName in the standard catalog theme definition.
Changes