microsoft / microsoft/documentdb-mcp

[DX] Add 3 labeled quickstart paths at top of README

Open
#51 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

Replace the current feature-first README intro with three labeled, copy-paste quickstart paths covering 90% of first-run scenarios.

What to ship

At the top of the README, add three side-by-side or sequential quickstart blocks:

  1. Local quickstart (VS Code, stdio, connection string) — for the "I just want to try it" user. Includes mcp.json snippet, sample prompt, expected response.
  2. Copilot CLI quickstart (stdio, connection string) — for the CLI-first user.
  3. Hosted deployment quickstart (Container Apps, HTTP, Entra) — for the "we're going to production" user.

Acceptance criteria

  • Each block is ≤ 10 lines of config + 1 terminal command + 1 sample prompt.
  • All snippets are JSON-correct and tested end-to-end on a clean machine.
  • Each block names the persona it serves in the heading (no inference required).
  • Links to deeper docs for each, but stands on its own without them.

Why

Today users have to assemble the recipe themselves from a feature list. Three labeled paths cover the common cases and remove decision-paralysis at the door.

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 top of README and review the existing feature-first introduction and links to deeper setup documentation. Draft three labeled quickstart blocks for VS Code, Copilot CLI, and hosted Azure Container Apps with the specified snippets, commands, prompts, and persona headings. Validate JSON syntax and test each path end-to-end on a clean machine; done means all acceptance criteria are met and each block stands alone.

Written by the indexing model from the issue text.

Assessment

Tech stack
azure, json, vscode
Domain
cloud, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 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.