Skip to content

Refactor response for Read and Update MCP tools to use built in utility functions #2984

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Refactor response for Read and Update MCP tools to use built in utility functions #2984

wants to merge 3 commits into from
+151 −286

Conversation

@aaronburtle
Copy link
Contributor

@aaronburtle aaronburtle commented Nov 18, 2025

Why make this change?

Closes #2919

What is this change?

Refactors the Read and Update built in MCP tools so that they use the common BuildErrorResult and BuildSuccessResult functiosn in the Utils, aligning their usage with the other tools.

How was this tested?

Run against normal test suite.

Sample Request(s)

N/A

Copilot AI review requested due to automatic review settings November 18, 2025 22:22
@aaronburtle
Copy link
Contributor Author

aaronburtle commented Nov 18, 2025

/azp run

@azure-pipelines
Copy link

azure-pipelines bot commented Nov 18, 2025

Azure Pipelines successfully started running 6 pipeline(s).

Copilot finished reviewing on behalf of aaronburtle November 18, 2025 22:25
Copilot AI reviewed Nov 18, 2025
View reviewed changes
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR refactors the ReadRecordsTool and UpdateRecordTool to use centralized utility functions from McpResponseBuilder, improving code consistency and maintainability across all MCP tools.

  • Replaces local BuildErrorResult, BuildSuccessResult, and ExtractResultJson methods with calls to McpResponseBuilder utilities
  • Enhances response format to include entity and message fields, aligning with other MCP tools
  • Moves result filtering logic inline in UpdateRecordTool before passing to the utility function

Reviewed Changes

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

File Description
src/Azure.DataApiBuilder.Mcp/BuiltInTools/ReadRecordsTool.cs Refactored to use McpResponseBuilder utilities; removed duplicate helper methods; improved exception handling to capture exception details
src/Azure.DataApiBuilder.Mcp/BuiltInTools/UpdateRecordTool.cs Refactored to use McpResponseBuilder utilities; moved result filtering logic inline; removed duplicate helper methods while preserving GetJsonValue utility

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Aniruddh25
Aniruddh25 requested changes Nov 20, 2025
View reviewed changes
Copy link
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

Need to ensure we log the kind of tool it is in BuildErrorResult

Aniruddh25
Aniruddh25 reviewed Nov 20, 2025
View reviewed changes
Copy link
Collaborator

@Aniruddh25 Aniruddh25 left a comment

Choose a reason for hiding this comment

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

Since there are no automated tests yet, have you tested the refactoring did not introduce any regressions using Mcp Inspector?

@aaronburtle
Copy link
Contributor Author

aaronburtle commented Nov 20, 2025

Since there are no automated tests yet, have you tested the refactoring did not introduce any regressions using Mcp Inspector?

Still need to test with the inspector, will add the test results to the PR description when done.

@aaronburtle
Copy link
Contributor Author

aaronburtle commented Nov 21, 2025

/azp run

@azure-pipelines
Copy link

azure-pipelines bot commented Nov 21, 2025

Azure Pipelines successfully started running 6 pipeline(s).

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

Reviewers

@Aniruddh25 Aniruddh25 Aniruddh25 requested changes

Copilot code review Copilot Copilot left review comments

@anushakolan anushakolan Awaiting requested review from anushakolan anushakolan is a code owner

@RubenCerna2079 RubenCerna2079 Awaiting requested review from RubenCerna2079 RubenCerna2079 is a code owner

@souvikghosh04 souvikghosh04 Awaiting requested review from souvikghosh04 souvikghosh04 is a code owner

@neeraj-sharma2592 neeraj-sharma2592 Awaiting requested review from neeraj-sharma2592 neeraj-sharma2592 is a code owner

@sourabh1007 sourabh1007 Awaiting requested review from sourabh1007 sourabh1007 is a code owner

@vadeveka vadeveka Awaiting requested review from vadeveka vadeveka is a code owner

@Alekhya-Polavarapu Alekhya-Polavarapu Awaiting requested review from Alekhya-Polavarapu Alekhya-Polavarapu is a code owner

@rusamant rusamant Awaiting requested review from rusamant rusamant is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

1.7-rc

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Align successful response for built-in mcp tools to all use the mcp utility function

4 participants

@aaronburtle @Aniruddh25 @RubenCerna2079