Skip to content

Populate OpenAPI description from MCP configuration - #3885

Open
Souvik Ghosh (souvikghosh04) with Copilot wants to merge 3 commits into
mainfrom
copilot/update-openapi-info-description
Open

Souvik Ghosh (souvikghosh04) with Copilot wants to merge 3 commits into
mainfrom
copilot/update-openapi-info-description

Conversation

Copilot AI commented Oct 28, 2026 •

Copy link
Copy Markdown
Contributor

Why make this change?

Generated OpenAPI documents omitted info.description even when runtime.mcp.description was configured. The document should use the top-level description, including when multiple configuration files are combined.

What is this change?

  • Set OpenApiInfo.Description from the resolved runtime MCP description in BuildOpenApiDocument.
  • Add unit coverage for the serialized OpenAPI description.

How was this tested?

  • Integration Tests
  • Unit Tests

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."
  }
}

@azure-pipelines

Copy link
Copy Markdown
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 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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.Description from 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Review In Progress

Development

Successfully merging this pull request may close these issues.

[Enh]: The info.description field in the OpenAPI output is never populated.

6 participants