[MCP] Added description property to entities and GraphQL Schema.

[anushakolan]

Why make this change?

• Adds support for entity-level descriptions in Data API Builder GraphQL schema.
• This feature request aims to surface entity descriptions from the config file in the generated GraphQL schema, improving API documentation and discoverability.
• See related discussion: [https://github.com/[Enh]: Add entity description (metadata) #2834]

What is this change?

• Adds a description property to the entity model and ensures it is deserialized from the config.
• Updates the GraphQL schema generator and converter to include entity descriptions as comments in the SDL and as HotChocolate type descriptions.
• Adds unit tests to verify that entity descriptions appear in the generated schema.

How was this tested?

• Unit Tests: Added tests to check for presence of entity description in generated GraphQL schema.
• Manual verification: Ran GraphQL introspection queries and checked schema SDL output.

Sample Request(s)

GraphQL Introspection Query:

{
  __type(name: "Todo") {
    name
    description
  }
}

Sample Query Response:

{
  "data": {
    "__type": {
      "name": "Todo",
      "description": "Represents a todo item in the system"
    }
  }
}

Sample SDL output:

"""Represents a todo item in the system"""
type Todo {
  ...
}

[Copilot]

Pull Request Overview

This PR adds support for entity descriptions in Data API Builder's GraphQL schema generation. The feature allows developers to include descriptive comments in their configuration that will be surfaced as documentation in the generated GraphQL schema.

• Adds a description property to the Entity model for storing entity-level documentation
• Updates GraphQL schema generators to include entity descriptions as GraphQL comments and HotChocolate type descriptions
• Adds JSON schema validation and unit tests for the new description functionality

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
src/Config/ObjectModel/Entity.cs	Adds optional Description property to Entity record
src/Core/Generator/SchemaGenerator.cs	Updates Cosmos DB schema generator to include entity descriptions as GraphQL comments
src/Service.GraphQLBuilder/Sql/SchemaConverter.cs	Updates SQL schema converter to include entity descriptions in GraphQL type definitions
schemas/dab.draft.schema.json	Adds JSON schema definition for the new description property
src/Service.Tests/SqlTests/GraphQLQueryTests/MsSqlGraphQLQueryTests.cs	Adds unit test to verify entity descriptions appear in generated GraphQL schema

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[anushakolan]

@microsoft-github-policy-service agree company="Microsoft"

[RubenCerna2079]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 6 pipeline(s).

[souvikghosh04]

LGTM

[aaronburtle]

Looks good, might want to add a test case for edge case like empty string, make sure it behaves as desired.

[anushakolan]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 6 pipeline(s).

[anushakolan]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 6 pipeline(s).