Add entity-level MCP configuration support #2989

souvikghosh04 · 2025-11-21T15:13:42Z

Why make this change?

This change allows entity-level MCP configuration to control which entities participate in MCP runtime tools, providing granular control over DML operations and custom tool exposure.

Closes on Add mcp option at entity level #2948

What is this change?

This change introduces an optional mcp property at the entity level that controls participation in MCP's runtime tools. This is a prerequisite for custom tools support.

The MCP property supports two formats:

Boolean shorthand: "mcp": true or "mcp": false
Object format: {"dml-tools": boolean, "custom-tool": boolean}

Property Behavior:

Boolean Shorthand ("mcp": true/false)

"mcp": true: Enables DML tools only; custom tools remain disabled.
"mcp": false: Disables all MCP functionality for the entity.

Object Format ("mcp": { ... })

{ "dml-tools": true, "custom-tool": true }: Enables both (valid only for stored procedures).
{ "dml-tools": true, "custom-tool": false }: DML only.
{ "dml-tools": false, "custom-tool": true }: Custom tool only (stored procedures).
{ "dml-tools": false, "custom-tool": false }: Fully disabled.

Single-property cases:

{"dml-tools": true}: Enables DML only; auto-serializes to "mcp": true.
{"custom-tool": true}: Enables custom tool only; serializes as given.

No MCP Configuration in Entity (default)

dml-tools will still be enabled by default and no other change is behavior

How was this tested?

Unit Tests
Integrations Tests
CLI Command Testing

Sample CLI commands:

Add table with DML tools enabled

dab add Book --source books --permissions "anonymous:*" --mcp.dml-tools true

Add stored procedure with custom tool enabled

dab add GetBookById --source dbo.get_book_by_id --source.type stored-procedure --permissions "anonymous:execute" --mcp.custom-tool true

Add stored procedure with both properties

dab add UpdateBook --source dbo.update_book --source.type stored-procedure --permissions "anonymous:execute" --mcp.custom-tool true --mcp.dml-tools false

souvikghosh04 · 2025-11-21T15:16:52Z

/azp run

azure-pipelines · 2025-11-21T15:17:17Z

Azure Pipelines successfully started running 6 pipeline(s).

Copilot

Pull request overview

This PR introduces entity-level MCP (Model Context Protocol) configuration support, allowing fine-grained control over entity participation in MCP runtime tools. The changes enable entities to specify whether they participate in DML tools and custom tools through a new mcp property that accepts either a boolean or an object with dml-tools and custom-tool keys.

Added EntityMcpOptions class with custom JSON converter for flexible boolean/object serialization
Implemented schema validation to restrict custom-tool property to stored procedures only
Updated all test configurations and entity constructors to include the new Mcp parameter
Added CLI support for --mcp.custom-tool and --mcp.dml-tools flags

Reviewed changes

Copilot reviewed 67 out of 68 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
dab-config.PostgreSql.json	Added runtime-level MCP config and reordered rest/graphql sections for consistency
dab-config.MySql.json	Added runtime-level MCP config, reordered sections, and added Default_Books entity
dab-config.MsSql.json	Complete reformatting with whitespace changes and runtime-level MCP config addition
dab-config.CosmosDb_NoSql.json	Added runtime-level MCP config, removed telemetry section, reordered rest/graphql blocks
SqlMetadataProviderUnitTests.cs	Added `Mcp: null` to Entity constructor calls
RequestValidatorUnitTests.cs	Added `Mcp: null` parameter to Entity constructor
ConfigValidationUnitTests.cs	Added `Mcp: null` to multiple Entity constructor calls
TestHelper.cs	Added `Mcp: null` to Entity constructor in helper method
MsSqlGraphQLQueryTests.cs	Fixed Entity constructor parameter ordering issue
GraphQLQueryTestBase.cs	Added `Mcp: null` to Entity constructors
ConfigurationTests snapshots	Updated to reflect mapping changes from Fields to Mappings section
OpenApiDocumentor tests	Added `Mcp: null` to all Entity constructor calls
GraphQLBuilder tests	Added `Mcp: null` to Entity constructors in test helpers
CosmosTests	Added `Mcp: null` to Entity constructors across query and mutation tests

Comments suppressed due to low confidence (1)

src/Service.Tests/SqlTests/GraphQLQueryTests/MsSqlGraphQLQueryTests.cs:1

Missing parameter in Entity constructor call. The constructor expects 8 parameters but line 876 adds an extra null parameter before the permissions array, shifting the parameter positions incorrectly. The Mcp parameter should be added after permissions, not before.

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

Aniruddh25

Posting comments so far

config-generators/config-generator.ps1

schemas/dab.draft.schema.json

...Tests/Snapshots/UpdateEntityTests.TestConversionOfSourceObject_036a859f50ce167c.verified.txt

src/Cli/ConfigGenerator.cs

souvikghosh04 · 2025-11-24T12:41:19Z

/azp run

azure-pipelines · 2025-11-24T12:41:43Z

Azure Pipelines successfully started running 6 pipeline(s).

souvikghosh04 · 2025-11-24T14:42:05Z

/azp run

azure-pipelines · 2025-11-24T14:42:28Z

Azure Pipelines successfully started running 6 pipeline(s).

Going OOF for a few days - dont want to block

schemas/dab.draft.schema.json

src/Cli/Commands/AddOptions.cs

src/Cli/Commands/EntityOptions.cs

src/Config/ObjectModel/Entity.cs

src/Config/ObjectModel/EntityMcpOptions.cs

src/Config/Converters/EntityMcpOptionsConverterFactory.cs

… Usr/sogh/entity-level-mcp-config

souvikghosh04 · 2025-12-11T13:57:27Z

/azp run

azure-pipelines · 2025-12-11T13:58:00Z

Azure Pipelines successfully started running 6 pipeline(s).

souvikghosh04 · 2025-12-11T14:08:44Z

/azp run

azure-pipelines · 2025-12-11T14:09:09Z

Azure Pipelines successfully started running 6 pipeline(s).

Aniruddh25

Left some suggestions to optimise test code. But main requesting change is to ensure DmlToolsEnabled is true even if not provided.

schemas/dab.draft.schema.json

src/Cli.Tests/AddEntityTests.cs

src/Cli.Tests/Snapshots/AddEntityTests.AddStoredProcedureWithBothMcpProperties.verified.txt

src/Cli.Tests/UpdateEntityTests.cs

src/Cli/ConfigGenerator.cs

src/Config/ObjectModel/EntityMcpOptions.cs

src/Service.Tests/Configuration/EntityMcpConfigurationTests.cs

RubenCerna2079

Address issues with tests and give answers to comments that were resolved with no visible changes

src/Config/Converters/EntityMcpOptionsConverterFactory.cs

src/Service.Tests/Configuration/EntityMcpConfigurationTests.cs

- Updated MCP DML tools default value to true in EntityMcpOptions. - Simplified MCP properties in various test snapshots by removing unnecessary fields. - Consolidated test methods for updating table entities with MCP DML tools into a single parameterized test. - Removed obsolete test snapshots related to MCP DML tools. - Enhanced MCP configuration tests to assert default values and behavior more effectively. - Updated CLI command options help text to reflect new default values for MCP properties.

souvikghosh04 · 2025-12-15T07:24:03Z

/azp run

azure-pipelines · 2025-12-15T07:24:26Z

Azure Pipelines successfully started running 6 pipeline(s).

Aniruddh25

LGTM. Thanks for addressing all the feedback!

src/Cli.Tests/ModuleInitializer.cs

souvikghosh04 · 2025-12-16T18:48:01Z

/azp run

azure-pipelines · 2025-12-16T18:48:27Z

Azure Pipelines successfully started running 6 pipeline(s).

RubenCerna2079

LGTM! Thanks for the changes :)

Aniruddh25 · 2025-12-17T00:56:18Z

/azp run

azure-pipelines · 2025-12-17T00:56:42Z

Azure Pipelines successfully started running 6 pipeline(s).

souvikghosh04 self-assigned this Nov 21, 2025

souvikghosh04 added mssql an issue thats specific to mssql config changes related to config mcp-server labels Nov 21, 2025

souvikghosh04 added this to Data API builder Nov 21, 2025

github-project-automation bot moved this to Todo in Data API builder Nov 21, 2025

souvikghosh04 added this to the Nov 2025 milestone Nov 21, 2025

souvikghosh04 linked an issue Nov 21, 2025 that may be closed by this pull request

Add mcp option at entity level #2948

Closed

souvikghosh04 moved this from Todo to Review In Progress in Data API builder Nov 21, 2025

souvikghosh04 marked this pull request as ready for review November 21, 2025 15:16

souvikghosh04 requested a review from Aniruddh25 as a code owner November 21, 2025 15:16

Copilot AI review requested due to automatic review settings November 21, 2025 15:16

souvikghosh04 requested review from Alekhya-Polavarapu, RubenCerna2079, aaronburtle, anushakolan, neeraj-sharma2592, rusamant, sourabh1007 and vadeveka as code owners November 21, 2025 15:16

Copilot started reviewing on behalf of souvikghosh04 November 21, 2025 15:17 View session

Copilot finished reviewing on behalf of souvikghosh04 November 21, 2025 15:17

Copilot AI reviewed Nov 21, 2025

View reviewed changes

Aniruddh25 requested changes Nov 24, 2025

View reviewed changes

RubenCerna2079 reviewed Dec 11, 2025

View reviewed changes

souvikghosh04 added 2 commits December 11, 2025 18:38

Merge branch 'main' of https://github.com/Azure/data-api-builder into…

a964d8e

… Usr/sogh/entity-level-mcp-config

nits and suggesstions

dc28696

fix formatting

7e764d2

souvikghosh04 requested a review from RubenCerna2079 December 12, 2025 04:46

Aniruddh25 requested changes Dec 13, 2025

View reviewed changes

RubenCerna2079 requested changes Dec 14, 2025

View reviewed changes

src/Config/Converters/EntityMcpOptionsConverterFactory.cs Show resolved Hide resolved

src/Service.Tests/Configuration/EntityMcpConfigurationTests.cs Show resolved Hide resolved

souvikghosh04 requested review from Aniruddh25 and RubenCerna2079 December 15, 2025 08:28

Aniruddh25 approved these changes Dec 16, 2025

View reviewed changes

RubenCerna2079 reviewed Dec 16, 2025

View reviewed changes

src/Cli.Tests/ModuleInitializer.cs Show resolved Hide resolved

Ignore user provided poperty flag for service test

e7dab7b

souvikghosh04 requested a review from RubenCerna2079 December 16, 2025 18:47

souvikghosh04 enabled auto-merge (squash) December 16, 2025 18:48

RubenCerna2079 approved these changes Dec 16, 2025

View reviewed changes

souvikghosh04 merged commit 9dad3d5 into main Dec 17, 2025
11 checks passed

souvikghosh04 deleted the Usr/sogh/entity-level-mcp-config branch December 17, 2025 04:07

github-project-automation bot moved this from Review In Progress to Done in Data API builder Dec 17, 2025

Add entity-level MCP configuration support #2989

Add entity-level MCP configuration support #2989

Uh oh!

Conversation

souvikghosh04 commented Nov 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Why make this change?

What is this change?

How was this tested?

Uh oh!

souvikghosh04 commented Nov 21, 2025

Uh oh!

azure-pipelines bot commented Nov 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Aniruddh25 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

souvikghosh04 commented Nov 24, 2025

Uh oh!

azure-pipelines bot commented Nov 24, 2025

Uh oh!

souvikghosh04 commented Nov 24, 2025

Uh oh!

azure-pipelines bot commented Nov 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

souvikghosh04 commented Dec 11, 2025

Uh oh!

azure-pipelines bot commented Dec 11, 2025

Uh oh!

souvikghosh04 commented Dec 11, 2025

Uh oh!

azure-pipelines bot commented Dec 11, 2025

Uh oh!

Aniruddh25 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

RubenCerna2079 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

souvikghosh04 commented Dec 15, 2025

Uh oh!

azure-pipelines bot commented Dec 15, 2025

Uh oh!

Aniruddh25 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

souvikghosh04 commented Dec 16, 2025

Uh oh!

souvikghosh04 commented Nov 21, 2025 •

edited

Loading