Skip to content

Commit 96107e1

Browse files
CopilotJerryNixon
andcommitted
Expand describe_entities parameter descriptions for better clarity
Co-authored-by: JerryNixon <[email protected]>
1 parent a4871ef commit 96107e1

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

src/Azure.DataApiBuilder.Mcp/BuiltInTools/DescribeEntitiesTool.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,14 +40,14 @@ public Tool GetToolMetadata()
4040
""properties"": {
4141
""nameOnly"": {
4242
""type"": ""boolean"",
43-
""description"": ""True: names and summaries only. False (default): full metadata.""
43+
""description"": ""If true, the response includes only entity names and short summaries, omitting detailed metadata such as fields, parameters, and permissions. Use this when the database contains many entities and the full payload would be too large. The usual strategy is: first call describe_entities with nameOnly=true to get a lightweight list, then call describe_entities again with nameOnly=false for specific entities that require full metadata. This flag is meant for discovery, not execution planning. The model must not assume that nameOnly=true provides enough detail for CRUD or EXECUTE operations.""
4444
},
4545
""entities"": {
4646
""type"": ""array"",
4747
""items"": {
4848
""type"": ""string""
4949
},
50-
""description"": ""Optional: specific entity names. Omit for all.""
50+
""description"": ""Optional list of entity names to describe in full detail. Use this to reduce payload size when only certain entities are relevant. Do NOT pass both entities[] and nameOnly=true together, as that combination is nonsensical: nameOnly=true ignores detailed metadata, while entities[] explicitly requests it. Choose one approach—broad discovery with nameOnly=true OR targeted metadata with entities[].""
5151
}
5252
}
5353
}"

0 commit comments

Comments
 (0)