Skip to content

[TypeSpec Authoring] Make it more explicit that versioning evolution should use agentic search#16460

Open
haolingdong-msft wants to merge 6 commits into
mainfrom
haolingdong-msft/fix-16317-case3-fallback
Open

[TypeSpec Authoring] Make it more explicit that versioning evolution should use agentic search#16460
haolingdong-msft wants to merge 6 commits into
mainfrom
haolingdong-msft/fix-16317-case3-fallback

Conversation

@haolingdong-msft

Copy link
Copy Markdown
Member

Problem

In .github/skills/azure-typespec-author/references/authoring-plan.md, the General Fallback conflicted with the Case 3 — API Version Evolution instruction:

  • General Fallback: "If agentic search fails … proceed with the MCP tool result alone."
  • Case 3: "Must use Agentic Search … do not call the MCP tool."

When all reference URLs are unreachable, Case 3 forbade the MCP tool while the Fallback pointed to it — leaving no valid path forward (dead-end).

Fix

Case 3 now defines an explicit degraded path instead of dead-ending:

  • Keeps agentic search as the required primary source.
  • Falls back to the MCP tool result (per the General Fallback) when agentic search fails.
  • Clarifies the concrete Case 3 steps (example-file migration + readme.md update) are mandatory regardless of grounding path — these map directly to the examples/<version>/ graders that were failing in the versioning eval suite.

Fixes #16317

Ref: Copilot review comment #15840 (comment)

Resolves the contradiction where the General Fallback tells the agent to use the MCP tool when agentic search fails, while Case 3 forbids the MCP tool -- previously dead-ending the API version evolution workflow when all reference URLs were unreachable.

Case 3 now explicitly falls back to the MCP tool result (per the General Fallback) instead of dead-ending, keeps agentic search as the required primary path, and clarifies the concrete example-migration/readme steps are mandatory regardless of grounding path.

Fixes #16317

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot-Session: d4912c91-426b-4cb5-8bd2-5ef89f4158fc
Copilot AI review requested due to automatic review settings July 23, 2026 03:59
@haolingdong-msft
haolingdong-msft requested review from a team and catalinaperalta as code owners July 23, 2026 03:59
@azure-pipelines

Copy link
Copy Markdown
Azure Pipelines:
66 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Resolves a contradiction in the azure-typespec-author skill reference docs where Case 3 (API Version Evolution) could dead-end when agentic search is unavailable by defining an explicit degraded path.

Changes:

  • Updates Case 3 guidance to treat agentic search as the primary grounding mechanism.
  • Adds a Case 3-specific fallback to use the MCP tool result when agentic search fails, aligning with the General Fallback.
  • Clarifies that the concrete Case 3 file-migration steps remain mandatory even in degraded mode.

Comment thread .github/skills/azure-typespec-author/references/authoring-plan.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@haolingdong-msft

haolingdong-msft commented Jul 23, 2026

Copy link
Copy Markdown
Member Author

@haolingdong-msft haolingdong-msft changed the title [TypeSpec Authoring] Resolve agentic-search Fallback vs Case 3 conflict in authoring-plan.md [TypeSpec Authoring] Make it more explicit that versioning evolution should use agentic search Jul 23, 2026
haolingdong-msft and others added 4 commits July 23, 2026 16:12
…or version evolution

Version-evolution cases (001005-001008) were calling both the MCP
generate_authoring_plan tool and agentic search. The MCP plan omits the
example-file migration and preview-rebase steps these cases require, so
its guidance conflicts with the correct end-state. Restrict Case 3 to
agentic search only and forbid the MCP tool; on agentic-search failure,
retry rather than fall back to the MCP tool.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: d4912c91-426b-4cb5-8bd2-5ef89f4158fc
…ch only)

Add an explicit precedence note so the general 'use both tools' guidance
does not appear to conflict with Case 3's agentic-search-only rule.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot-Session: d4912c91-426b-4cb5-8bd2-5ef89f4158fc
### Case 3 — API Version Evolution (ARM / Data-plane)

> **Must** use Agentic Search (option 2 above) to build the plan — do not call the MCP tool.
> **Use Agentic Search (option 2 above) ONLY.** For version-evolution requests you **must not** call the MCP tool `azsdk_typespec_generate_authoring_plan` at all — it does not cover the example-file migration and version-rebase steps this case requires. This exclusive rule overrides the "use both tools" guidance in [3.1 General](#31-general-all-cases).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So just for clarity we're not allowing any other fallback in this case?

@catalinaperalta catalinaperalta left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving to not block progress here, but had a question

@catalinaperalta

Copy link
Copy Markdown
Member

Falls back to the MCP tool result (per the General Fallback) when agentic search fails.

This is in the PR description but I dont see if reflected in the actual guidance for the agent, it looks like this path is still blocked

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[TypeSpec Authoring] Resolve conflict between agentic-search Fallback and Case 3 in authoring-plan.md

4 participants