Update agent models to match TypeSpec definition by trangevi · Pull Request #8789 · Azure/azure-dev

trangevi · 2026-06-23T22:46:33Z

Motivation

Our Go agent model structs (AgentObject, AgentEndpoint) were outdated compared to the service TypeSpec at azure-rest-api-specs. Missing fields meant the CLI silently dropped properties returned by the API.

Changes

AgentObject -- added fields present in the TypeSpec but missing from Go:

State (operational state: enabled/disabled)
InstanceIdentity, Blueprint, BlueprintReference (identity/blueprint info already on AgentVersionObject but missing at the agent level)

AgentEndpoint -- added ProtocolConfiguration field and supporting types:

ProtocolConfiguration struct with per-protocol config pointers (activity, responses, a2a, mcp, invocations, invocations_ws)
ActivityProtocolConfiguration with EnableM365PublicEndpoint
Empty marker structs for the other protocols (matching the TypeSpec which reserves them for future fields)

Constants -- added AgentEndpointAuthSchemeBotServiceTenant to match the TypeSpec AgentEndpointAuthorizationSchemeType union.

Tests -- added two round-trip tests covering the new fields:

TestAgentObject_RoundTrip_AllFields
TestAgentEndpoint_ProtocolConfiguration_RoundTrip

Notes

AgentVersionObject was already aligned with TypeSpec -- no changes needed there.
The agent show command calls GetAgentVersion (returns AgentVersionObject), so its output is unaffected. The AgentObject changes benefit commands that use GetAgent (e.g., list).

Fixes: #8338

Add missing fields to AgentObject (State, InstanceIdentity, Blueprint, BlueprintReference), add ProtocolConfiguration type and field to AgentEndpoint, add BotServiceTenant auth scheme constant, and add per-protocol configuration types (Activity, Responses, A2A, MCP, Invocations, InvocationsWs). Fixes #8338 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

github-actions · 2026-06-23T22:46:48Z

📋 Prioritization Note

Thanks for the contribution! The linked issue isn't in the current milestone yet.
Thank you for logging this issue; our team is reviewing it. If you need urgent prioritization, tag @RickWinter and @kristenwomack to let us know.

Copilot

Pull request overview

This PR updates the azure.ai.agents extension’s Go agent API model structs to better match the Foundry service TypeSpec, preventing fields returned by the service from being silently dropped during JSON unmarshaling.

Changes:

Added missing AgentObject fields (State, InstanceIdentity, Blueprint, BlueprintReference).
Added AgentEndpoint.ProtocolConfiguration and per-protocol configuration types (including marker structs for future expansion).
Added round-trip JSON tests to cover the newly introduced fields.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
cli/azd/extensions/azure.ai.agents/internal/pkg/agents/agent_api/models.go	Extends agent/endpoint model structs with additional TypeSpec-aligned fields and protocol configuration types.
cli/azd/extensions/azure.ai.agents/internal/pkg/agents/agent_api/models_test.go	Adds JSON round-trip tests validating the new fields serialize/deserialize correctly.

Address PR review comments: rename McpProtocolConfiguration to MCPProtocolConfiguration and InvocationsWsProtocolConfiguration to InvocationsWSProtocolConfiguration to follow Go naming conventions for initialisms. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

The deprecated Protocols field is replaced by ProtocolConfiguration in the TypeSpec. Update printEndpointTable to derive enabled protocols from ProtocolConfiguration keys (presence = enabled), falling back to the deprecated Protocols field for backward compatibility with older API responses. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

jongio

Solid TypeSpec sync. The model additions are well-scoped, the resolveEndpointProtocols extraction is a clean refactor, and the round-trip tests cover the new shapes thoroughly. One CI fix needed before merge.

CI: golangci-lint is failing on gofmt. The ProtocolConfiguration and AgentEndpoint structs have manually-padded spaces aligning struct tags. Running gofmt -s -w models.go will fix it. Same likely applies to the AgentObject struct fields added in this PR.

jongio

Two issues still blocking merge:

resolveEndpointProtocols falls through to the deprecated Protocols field when ProtocolConfiguration is non-nil but empty ({}). A non-nil ProtocolConfiguration should be treated as authoritative, even if no protocols are enabled inside it. See inline comment for the fix.
CI (golangci-lint) is still failing on gofmt formatting. The ProtocolConfiguration, AgentEndpoint, and AgentObject structs in models.go have manual space-padding for struct tag alignment. Run gofmt -s -w models.go to fix.

- Run gofmt -s -w to fix space-padded struct tag alignment - Make non-nil ProtocolConfiguration authoritative even when empty, so it never falls through to the deprecated Protocols field - Add test case for empty ProtocolConfiguration with populated Protocols Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

jongio

Incremental review of aca656b (since my prior review on 9d81a0c).

All three prior findings are addressed:

gofmt alignment in ProtocolConfiguration, AgentEndpoint, and AgentObject structs is fixed.
resolveEndpointProtocols now treats a non-nil ProtocolConfiguration as authoritative, returning immediately even when empty. This prevents the incorrect fallthrough to the deprecated Protocols field.
Test case added for the empty-ProtocolConfiguration-with-populated-Protocols scenario, confirming the authoritative behavior.

Lint and tests are passing. No new issues in the incremental diff.

Note: my prior CHANGES_REQUESTED verdict is still active on this PR. A maintainer with approval rights should clear it if the review is satisfactory.

jongio

Verified the four commits in aca656b:

resolveEndpointProtocols treats a non-nil ProtocolConfiguration as authoritative, returning immediately when empty instead of falling through to the deprecated Protocols field.
Model additions (State, InstanceIdentity, Blueprint, BlueprintReference on AgentObject; ProtocolConfiguration on AgentEndpoint; BotServiceTenant auth scheme) match the TypeSpec and use omitempty for optional fields.
Go initialism casing is correct (MCPProtocolConfiguration, InvocationsWSProtocolConfiguration).
Test coverage includes round-trip tests for new model shapes and table-driven tests for protocol resolution, including the empty-ProtocolConfiguration-with-populated-Protocols edge case.

No new issues found. My prior CHANGES_REQUESTED is still active and needs to be cleared by a maintainer with approval rights.

Dismissing "changes requested" status as requested in most recent comment

Copilot AI review requested due to automatic review settings June 23, 2026 22:46

trangevi requested review from JeffreyCA, glharper, huimiu, hund030, therealjohn and trrwilson as code owners June 23, 2026 22:46

microsoft-github-policy-service Bot assigned trangevi Jun 23, 2026

Copilot started reviewing on behalf of trangevi June 23, 2026 22:47 View session

Copilot AI reviewed Jun 23, 2026

View reviewed changes

github-actions Bot added the ext-agents azure.ai.agents extension label Jun 23, 2026

trangevi and others added 2 commits June 23, 2026 16:07

jongio reviewed Jun 24, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.agents/internal/pkg/agents/agent_api/models.go

huimiu reviewed Jun 24, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.agents/internal/cmd/endpoint_show.go Outdated

jongio previously requested changes Jun 24, 2026

View reviewed changes

Comment thread cli/azd/extensions/azure.ai.agents/internal/cmd/endpoint_show.go Outdated

Comment thread cli/azd/extensions/azure.ai.agents/internal/cmd/endpoint_show_test.go

jongio reviewed Jun 24, 2026

View reviewed changes

huimiu approved these changes Jun 25, 2026

View reviewed changes

jongio reviewed Jun 25, 2026

View reviewed changes

trangevi merged commit e587e54 into main Jun 25, 2026
26 checks passed

trangevi deleted the trangevi/update-agent-models-typespec-sync branch June 25, 2026 21:25

jongio mentioned this pull request Jun 25, 2026

fix(agents): use venv for pip fallback in azd ai agent run #8787

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Update agent models to match TypeSpec definition#8789

Update agent models to match TypeSpec definition#8789
trangevi merged 4 commits into
mainfrom
trangevi/update-agent-models-typespec-sync

trangevi commented Jun 23, 2026

Uh oh!

github-actions Bot commented Jun 23, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Uh oh!

jongio left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

trangevi commented Jun 23, 2026

Motivation

Changes

Notes

Uh oh!

github-actions Bot commented Jun 23, 2026

📋 Prioritization Note

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jongio left a comment

Choose a reason for hiding this comment

Uh oh!

jongio left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants