[MCP] Added read_records tool implementation #2893
Conversation
RubenCerna2079
requested review from
Alekhya-Polavarapu,
aaronburtle,
akashkumar58,
anushakolan,
neeraj-sharma2592,
rusamant,
sourabh1007,
souvikghosh04 and
vadeveka
as code owners
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
There was a problem hiding this comment.
Pull Request Overview
This PR implements the read_records tool for the MCP (Model Context Protocol), enabling reading of entity records with parameters like select, filter, first, orderby, and after for pagination. The implementation includes proper authorization checks and handles both REST and MCP endpoint responses differently.
- Added a new
ReadRecordsToolclass that implements the MCP read_records functionality - Modified response formatting to support both REST (nextLink) and MCP (after) pagination approaches
- Changed
GenerateOrderByListsmethod visibility from private to public for reuse
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
src/Azure.DataApiBuilder.Mcp/BuiltInTools/ReadRecordsTool.cs |
Complete implementation of the read_records tool with argument parsing, authorization, and query execution |
src/Core/Resolvers/SqlResponseHelpers.cs |
Enhanced response formatting to support both REST nextLink and MCP after pagination patterns |
src/Core/Parsers/RequestParser.cs |
Changed GenerateOrderByLists method from private to public for reuse |
src/Core/Parsers/FilterParser.cs |
Removed blank line formatting change |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
| public FilterClause GetFilterClause(string filterQueryString, string resourcePath, ODataUriResolver? customResolver = null) | ||
| { | ||
| if (_model is null) | ||
| { |
There was a problem hiding this comment.
nit: Is this new line introduced on purpose, if not we can revert it.
There was a problem hiding this comment.
I am not following, I deleted the line that shouldn't be there. I did not introduce a new line.
github-project-automation
bot
moved this from Todo
to Review In Progress
in Data API builder
|
nit: Fix the description, |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
There was a problem hiding this comment.
LGTM. please address the open comments. also please add a task to address the refactoring as requested in https://github.com/Azure/data-api-builder/pull/2893/files#r2411041957
|
/azp run |
|
/azp run |
|
Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command. |
|
Azure Pipelines successfully started running 6 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
4 participants
Why make this change?
read_records#2833One of the main DML tools that will be used is
read_records, which will allow the MCP to read the records of an entity based on the needs of the user.What is this change?
read_recordstool:SqlQueryEnginein order to create and run the query and receive the resultsGenerateOrderByListsfunction inside theRequestParser.csfile was changed from private to public in order to allow theread_recordstool to also use it to generate the proper context for the query.SqlResponseHelper.csfile were changed to check if the query request comes from theread_recordstool. This is done in order to output the correct information, right now the REST requests can also return anextLinkobject which gives the API link necessary to get values in the case that not all of them were shown. We want to do something similar with theread_recordstool, however we only want to return theafterobject which is the parameter that allows the query to know the exact place where it left from the previous query. This gets rid of unecessary information that can be found in thenextLinkobject.Exceptions thrown when:
orderbyparameter are empty or null. (Note:orderbyis an optional value as a whole, but the individual values it contains need to exist)Errors:
How was this tested?
Sample Request(s)
{ Entity: Book }{ Select: title,publisher_id }{ First: 3 }{ Orderby: ["publisher_id asc", "title desc"] }