microsoft / microsoft/documentdb-mcp

[DX] Pre-built profile templates

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

Drop-in starting points for the common deployment shapes.

What to ship

examples/profiles/ directory with annotated, paste-ready profiles:

  • local-dev.json — single-profile, connection-string, all tiers.
  • prod-readonly.json — Entra, allowedRoles: ["read"], scoped to one db.
  • support-agent.json — Entra, allowedRoles: ["read","write"], scoped to support data.
  • analytics-readonly.json — Entra, allowedRoles: ["read"], broad db access, deniedCollections: { *: ["audit_log","pii"] }.
  • locked-down.json — Entra, allowedRoles: ["read"], single db, single collection.

Each file has a header comment explaining what it permits and why.

Acceptance criteria

  • Every template passes --validate.
  • README's auth/profiles section links to examples/profiles/.
  • Templates demonstrate every field operators actually need (allowedRoles, allow/deny lists, readOnly if it survives PR #47).

Why

Solves the I don't know how to write allowedRoles problem. Operators learn by copying, not by reading docs.

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 README auth/profiles section and the existing profile validation path that supports --validate. Add the five annotated files under examples/profiles/, then verify every template passes --validate and that the README links to the directory. Check PR #47 before including readOnly, as the acceptance criteria make that field conditional.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.