Repository navigation
Populate OpenAPI description from MCP configuration - #3885
Open
Souvik Ghosh (souvikghosh04) with Copilot wants to merge 3 commits into
Open
Souvik Ghosh (souvikghosh04) with Copilot wants to merge 3 commits into
Souvik Ghosh (souvikghosh04) with Copilot wants to merge 3 commits into
Conversation
|
Azure Pipelines: There may be pipelines that require an authorized user to comment /azp run to run. |
Co-authored-by: souvikghosh04 <210500244+souvikghosh04@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Update OpenAPI output to populate info.description field
Populate OpenAPI description from MCP configuration
Oct 28, 2026
Souvik Ghosh (souvikghosh04)
marked this pull request as ready for review
October 28, 2026 10:26
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
There are no active review issues for the change that populates the OpenAPI description from the runtime MCP description.
No open issues 🎉
What changed in this PR
Populates OpenAPI info.description from the existing runtime MCP description, giving DAB a shared server description without adding a separate configuration setting.
Changes:
- Sets
OpenApiInfo.Descriptionfrom the resolved runtime configuration. - Adds a unit test verifying that the description appears in serialized OpenAPI output.
| File | Description |
|---|---|
src/Service.Tests/UnitTests/OpenApiDocumentorUnitTests.cs |
Adds description serialization coverage and updates test helpers to accept an MCP description. |
src/Core/Services/OpenAPI/OpenApiDocumentor.cs |
Maps the runtime MCP description to OpenAPI document metadata. |
Review effort: Balanced
Mohit G (gmohit21)
approved these changes
Oct 28, 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.
Why make this change?
Generated OpenAPI documents omitted
info.descriptioneven whenruntime.mcp.descriptionwas configured. The document should use the top-level description, including when multiple configuration files are combined.What is this change?
OpenApiInfo.Descriptionfrom the resolved runtime MCP description inBuildOpenApiDocument.How was this tested?
Sample Request(s)
Configure the server description:
{ "runtime": { "mcp": { "description": "This server provides access to the company database." } } }The generated OpenAPI document includes:
{ "info": { "description": "This server provides access to the company database." } }info.descriptionfield in the OpenAPI output is never populated. #3702