microsoft / microsoft/documentdb-mcp
[DX] Author VS Code Notebook walkthrough
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 2
- Forks
- 4
- Avg merge
- 6d 21h
- Merged PRs (30d)
- 3
Description
Goal
Lowest-friction show me, don't tell me learning path.
What to ship
A walkthrough.ipynb (or VS Code .dib) file at the repo root:
- Cell 1:
docker compose upfor local DocumentDB (or instructions). - Cell 2: Configure the MCP server with a local-dev profile.
- Cell 3: Insert sample data.
- Cell 4-N: Markdown cells explaining each step, interleaved with prompts to try.
The notebook should be runnable end-to-end on a clean machine in under 5 minutes.
Acceptance criteria
- Runs on Windows, macOS, Linux.
- All cells succeed in order without manual intervention beyond environment-specific paths.
- Sample data is small (< 100 documents) so seeding is fast.
- README links to the walkthrough from the quickstart.
Why
Some users won't read docs but will run a notebook. Captures a different cohort than the README quickstarts.
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
Create walkthrough.ipynb or a VS Code .dib at the repository root. Start by checking the existing Docker Compose and quickstart instructions, then run the walkthrough from a clean machine across the supported platforms. Done means the cells configure the local MCP profile, seed fewer than 100 documents, run in order in under five minutes, and the README quickstart links to it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker-compose, jupyter-notebook, vscode
- Domain
- developer-experience, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 68/100