microsoft / microsoft/documentdb-mcp

[DX] Build interactive `npx documentdb-mcp init` wizard

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

Nobody has claimed this yet.

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

Description

Goal

Replace the JSON-editing first-run with a 3-question wizard that writes the correct config to the right file.

What to ship

A new command npx @microsoft/documentdb-mcp init (or equivalent) that:

  1. Detects the client (or asks: VS Code / Copilot CLI / Claude Desktop / other).
  2. Asks for transport (stdio recommended for local).
  3. Asks for the DocumentDB connection target (URI or Entra endpoint).
  4. Writes the config to the correct location for the detected client (e.g. %APPDATA%/Code/User/mcp.json, ~/.config/copilot/...).
  5. Prints next steps: Restart VS Code, then ask: 'list the databases I can access.'

Acceptance criteria

  • Works on Windows, macOS, Linux.
  • Detects existing config and offers to merge rather than overwrite.
  • Validates the resulting config by running the server in --validate mode.
  • Has at least one unit test per client target.

Why

First-run JSON escape is the single biggest friction point. init collapses it to a single command.

Depends on

  • Tier 1: --validate flag (for post-write verification).

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 at the command entry point for npx @microsoft/documentdb-mcp init and review the --validate flag it depends on. The work is done when the wizard detects or asks for a client, merges existing configuration, writes platform-appropriate settings, validates them, prints next steps, and has one unit test per client target.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.