microsoft / microsoft/documentdb-mcp

[DX] Publish client compatibility matrix

Open
#61 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation dx tier-2
Dominant language
TypeScript
Stars
2
Forks
4
Avg merge
6d 21h
Merged PRs (30d)
3

Description

Goal

Set expectations for which clients work, with what known caveats.

What to ship

A docs/compatibility.md (or section in README) listing:

Client Transport supported Auth supported Status Known issues
VS Code (Copilot) stdio, HTTP conn-string, Entra ✅ Tested
Copilot CLI stdio conn-string ✅ Tested
Claude Desktop stdio conn-string ✅ Tested
Cursor stdio conn-string ⚠️ Best-effort (any known issues)
Foundry HTTP Entra 🚧 Pending registry Requires hosted runtime

Acceptance criteria

  • Every row has been verified against a real install at least once.
  • Status column uses a consistent vocabulary (Tested / Best-effort / Pending / Unsupported).
  • Linked from the README near the install instructions.

Why

Customers stop filing client-side bugs as if they were server-side. Sets correct expectations before the user invests setup time.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the proposed docs/compatibility.md and the README install instructions. Verify each listed client against a real install, recording supported transports, authentication, status, and known issues. Done means every row is verified, status labels use the stated vocabulary, and the matrix is linked near the README install instructions.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, vscode
Domain
developer-experience, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.