microsoft / microsoft/documentdb-mcp

[DX] Provide paste-ready mcp.json / claude_desktop_config.json snippets per client

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

Nobody has claimed this yet.

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

Description

Goal

Eliminate JSON-escape gymnastics for first-time users.

What to ship

A clients/ directory at the repo root with subdirectories per client:

  • clients/vscode/mcp.json (stdio + connection string)
  • clients/vscode/mcp.entra.json (HTTP + Entra)
  • clients/copilot-cli/config.json
  • clients/claude-desktop/claude_desktop_config.json

Each file is:

  • A literal, paste-ready config snippet (no placeholder text the user has to manually substitute beyond a clearly-marked connection string).
  • Annotated with // comments (or a sibling README) explaining each field.
  • Tested end-to-end against the actual client.

Acceptance criteria

  • A first-run user can copy one file, replace the connection string, restart their client, and have a working setup.
  • Snippets handle the double-encoding correctly (CONNECTION_PROFILES is stringified JSON inside outer JSON).
  • README links to clients/<your-client> from the relevant quickstart.

Why

The single most error-prone step today is hand-escaping the config JSON. Pre-baking it removes the entire class of error.

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 requested clients/ directory layout and inspect the relevant quickstart README links. Prepare the four client-specific configuration files, checking the nested stringified CONNECTION_PROFILES encoding and the client-specific annotation format. Verify each snippet end-to-end with its actual client and confirm that a user can replace the connection string and connect after restarting.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.