Skip to content

docs: clarify Cosmos OpenAI endpoint constraint#2905

Open
LiJzd wants to merge 1 commit into
microsoft:mainfrom
LiJzd:docs/cosmos-openai-endpoint-constraint
Open

docs: clarify Cosmos OpenAI endpoint constraint#2905
LiJzd wants to merge 1 commit into
microsoft:mainfrom
LiJzd:docs/cosmos-openai-endpoint-constraint

Conversation

@LiJzd

@LiJzd LiJzd commented Jun 17, 2026

Copy link
Copy Markdown

Summary

  • Clarifies that azmcp cosmos database container item vector-search --openai-endpoint must use a trusted Azure first-party HTTPS endpoint.
  • Updates the example placeholder from <endpoint> to <azure-openai-endpoint>.

Fixes #2902.

Validation

  • git diff --check
  • .\eng\common\spelling\Invoke-Cspell.ps1

I also attempted the requested local builds:

  • dotnet build servers\Azure.Mcp.Server\
  • dotnet build tools\Azure.Mcp.Tools.Cosmos\src\

Both were blocked locally because this machine has .NET SDK 8.0.301, while the repo global.json requires SDK 10.0.201.

AI assistance disclosure

This PR was prepared with assistance from OpenAI Codex. I reviewed the issue, repository contribution guidance, duplicate PR search results, and the final diff before submission.

@github-actions

Copy link
Copy Markdown
Contributor

Thank you for your contribution @LiJzd! We will review the pull request and get back to you soon.

@LiJzd LiJzd marked this pull request as ready for review June 22, 2026 04:39
@LiJzd LiJzd requested review from a team as code owners June 22, 2026 04:39

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.

Pull request overview

Clarifies the documentation for azmcp cosmos database container item vector-search by documenting the --openai-endpoint trust/allowlist constraint and updating the example placeholder to better indicate an Azure OpenAI endpoint.

Changes:

  • Documented that --openai-endpoint must be an Azure first-party HTTPS endpoint on specific Azure domains.
  • Updated the example placeholder from <endpoint> to <azure-openai-endpoint>.

Comment on lines +2148 to +2150
# --openai-endpoint must be a trusted Azure first-party HTTPS endpoint on one of the following domains:
# *.openai.azure.com, *.cognitiveservices.azure.com, *.services.ai.azure.com
# (and their US Government / China sovereign cloud equivalents). HTTP endpoints and non-Azure domains are rejected.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Untriaged

Development

Successfully merging this pull request may close these issues.

[Doc Gap] cosmos_database_container_item_vector-search — --openai-endpoint trusted-domain constraint not documented after PR #2895

2 participants