microsoft / microsoft/documentdb-mcp
[DX] Add transport × auth × scenario decision table to README
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 4
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 3
Description
Goal
A single table that answers which auth do I need? by lookup, not deduction.
What to ship
A table at the top of the auth/configuration section:
| Transport | Default auth | When to use | Client examples |
|---|---|---|---|
| stdio | Connection-string profile or ALLOW_UNAUTHENTICATED_STDIO |
Local dev, single user | VS Code, Claude Desktop, Copilot CLI |
| HTTP/SSE (hosted) | Entra JWT (required) | Production, multi-user | Foundry, API Center, custom apps |
| HTTP (self-hosted) | Entra JWT recommended; connection-string profiles for trusted networks | Internal deployments | Customer-operated |
Acceptance criteria
- Lives in the README at the top of any auth-related discussion.
- Covers all three transports the server supports.
- Each row links to a deeper section or example.
- Re-validated whenever a new transport or auth mode is added.
Why
Auth behavior currently differs per transport but is documented in pieces. The reviewer (and customers) are doing the matrix math in their heads. Solve it once.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in the README and locate the auth/configuration section. Add the transport, default auth, usage, and client-example matrix for stdio, hosted HTTP/SSE, and self-hosted HTTP, with links to the deeper sections or examples. Done means the table is at the top of the auth discussion and covers all three supported transports.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, typescript
- Domain
- authentication, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 76/100