Cherry-pick: fix: remove extraneous source.description schema property (#3552)#3612
Open
Aniruddh25 wants to merge 2 commits into
Open
Cherry-pick: fix: remove extraneous source.description schema property (#3552)#3612Aniruddh25 wants to merge 2 commits into
source.description schema property (#3552)#3612Aniruddh25 wants to merge 2 commits into
Conversation
…`entity.description` covers MCP (#3552) ## Why make this change? `entities.*.source.description` existed in the JSON schema with documentation claiming it drove MCP tool discovery — but it was never wired to any C# model (`EntitySource` has no `Description` field) and was silently ignored at runtime. Meanwhile, `entities.*.description` — the field that *actually* surfaces in MCP — made no mention of MCP. Users following the schema would configure the wrong field and get no MCP output with no error. ## What is this change? - **Removed** `entities.*.source.description` from `schemas/dab.draft.schema.json`. The property never had a backing field in `EntitySource` and was dead schema surface area. - **Updated** the description of `entities.*.description` to explicitly mention MCP: ```diff - "Optional description for the entity. Will be surfaced in generated API documentation and GraphQL schema as comments." + "Optional description for the entity. Will be surfaced in MCP tool discovery, generated API documentation, and GraphQL schema as comments." ``` The correct config pattern for MCP-visible descriptions is: ```json "Todo": { "description": "Manages to-do items — surfaced in MCP, REST docs, and GraphQL schema.", "source": { "object": "dbo.Todos", "type": "table" } } ``` ## How was this tested? - [ ] Integration Tests - [ ] Unit Tests Schema-only change; no runtime behavior altered. The removed property had no backing model field and was never deserialized. ## Sample Request(s) N/A — schema documentation fix only. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: Aniruddh25 <3513779+Aniruddh25@users.noreply.github.com> Co-authored-by: Aniruddh Munde <anmunde@microsoft.com>
Aniruddh25
requested review from
Alekhya-Polavarapu,
JerryNixon,
RubenCerna2079,
aaronburtle,
anushakolan,
rusamant,
sourabh1007,
souvikghosh04,
stuartpa and
vadeveka
as code owners
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the DAB JSON schema documentation to remove a non-functional configuration surface (entities.*.source.description) and to clarify that entities.*.description is the field used for MCP-related entity/tool metadata.
Changes:
- Removed the unused
entities.*.source.descriptionproperty fromschemas/dab.draft.schema.json. - Updated
entities.*.descriptionschema text to explicitly mention MCP tool discovery.
Aniruddh25
assigned
RubenCerna2079,
Aniruddh25,
aaronburtle and
souvikghosh04 and unassigned
RubenCerna2079
…Schema-release-2.0
souvikghosh04
approved these changes
May 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Cherry-pick of #3552 from
maintorelease/2.0.Original PR: fix: remove extraneous
source.descriptionschema property; clarifyentity.descriptioncovers MCP (#3552)Cherry-picked commit: f3d159d