Add agent icon authoring guidance to architect - #25
Open
alicja-gilderdale wants to merge 1 commit into
Open
Conversation
The modern CLI-authoring template picks up icon.png from the project root during pac copilot push and encodes it as iconBase64 in the compiled bot definition. The architect's current guidance does not mention this convention, so architect-authored agents ship with the generic default icon and makers have to upload one via the UI. This change adds a dedicated 'Agent Icon' section to agents/copilot-studio-architect.md documenting: - the on-disk convention: icon.png at project root (not assets/) - 192x192 PNG format - server-side encoding as iconBase64 in botdefinition.json - pull/push round-trip behaviour Verified round-trip: uploaded a custom icon via the Copilot Studio UI, pac copilot pull emitted icon.png at the project root (3.4 KB), and the compiled botdefinition.json contained a 5,037-char iconBase64 field. Placing icon.png under assets/ is silently ignored.
Contributor
|
Is this PR enough to get icons? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds authoring guidance for the agent icon to the Copilot Studio Architect agent (
agents/copilot-studio-architect.md).Motivation
The modern CLI-authoring template accepts an agent icon via a top-level
icon.pngfile at the project root —pac copilot pushencodes it asiconBase64in the compiled bot definition and applies it to the agent identity server-side. The current architect guidance does not mention this convention, so architect-authored agents ship with the generic default icon and the maker has to upload one manually via the Copilot Studio UI after every push.Empirically verified against a freshly authored CLI-authoring agent using the
cliagent-1.0.0template.What changed
## Agent Iconinagents/copilot-studio-architect.md(placed between## Settings YAMLand## Knowledge YAML)icon.pngat the project root (notassets/, not referenced fromsettings.mcs.yml)iconBase64, and the pull/push round-trip behaviourVerification (round-trip test)
Confirmed against a live modern agent:
pac copilot pullre-emitted the file to the project root asicon.png(3.4 KB PNG).mcs/botdefinition.jsoncontains"iconBase64": "iVBORw0KGgo..."— 5,037 chars of base64 encoding the PNGsettings.mcs.ymlwas not modified — the icon is not referenced by any YAML property, the file-name convention is the entire interfaceassets/icon.png(as the current architect would author) is silently ignored; the file must be at the project root forpac copilot pushto pick it upScope
Documentation-only. No changes to plugin agents, commands, hooks, or scripts. The architect follows the guidance the next time it initializes a new agent project.
Testing
Related work
mcs-assistant@copilot-studio-plugin v1.0.22.9.3+ga17df1d