Skip to content

Commit f3d159d

Browse files
CopilotAniruddh25
andauthored
fix: remove extraneous source.description schema property; clarify 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>
1 parent 99ba6cc commit f3d159d

1 file changed

Lines changed: 1 addition & 5 deletions

File tree

schemas/dab.draft.schema.json

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1167,7 +1167,7 @@
11671167
"properties": {
11681168
"description": {
11691169
"type": "string",
1170-
"description": "Optional description for the entity. Will be surfaced in generated API documentation and GraphQL schema as comments."
1170+
"description": "Optional description for the entity. Will be surfaced in MCP tool discovery, generated API documentation, and GraphQL schema as comments."
11711171
},
11721172
"health": {
11731173
"description": "Health check configuration for entity",
@@ -1258,10 +1258,6 @@
12581258
"type": "string"
12591259
},
12601260
"description": "DEPRECATED. Use the 'fields' array and set 'primary-key: true' on each key field instead. List of fields to be used as primary keys."
1261-
},
1262-
"description": {
1263-
"type": "string",
1264-
"description": "Human-readable description of the database object, used for MCP tool discovery and documentation."
12651261
}
12661262
},
12671263
"required": ["type", "object"]

0 commit comments

Comments
 (0)