[DX] Add transport × auth × scenario decision table to README

オープン 初心者向け
  • 何か問題がありますか？
#52 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
76/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
azure, typescript
領域
authentication, documentation

調査の方向性

READMEから始めて、認証/設定のセクションを見つけます。stdio、ホスト型 HTTP/SSE、セルフホスト型 HTTP について、トランスポート、デフォルト認証、使用方法、クライアント例のマトリックスを、より詳しいセクションまたは例へのリンク付きで追加します。表が認証に関する説明の先頭にあり、サポートされている3つのトランスポートすべてをカバーしていれば完了です。

索引モデルが issue の本文から書いたものです。

説明

documentation dx release-readiness tier-1

Goal

A single table that answers which auth do I need? by lookup, not deduction.

What to ship

A table at the top of the auth/configuration section:

Transport Default auth When to use Client examples
stdio Connection-string profile or ALLOW_UNAUTHENTICATED_STDIO Local dev, single user VS Code, Claude Desktop, Copilot CLI
HTTP/SSE (hosted) Entra JWT (required) Production, multi-user Foundry, API Center, custom apps
HTTP (self-hosted) Entra JWT recommended; connection-string profiles for trusted networks Internal deployments Customer-operated

Acceptance criteria

  • Lives in the README at the top of any auth-related discussion.
  • Covers all three transports the server supports.
  • Each row links to a deeper section or example.
  • Re-validated whenever a new transport or auth mode is added.

Why

Auth behavior currently differs per transport but is documented in pieces. The reviewer (and customers) are doing the matrix math in their heads. Solve it once.

主要言語
TypeScript
スター
3
フォーク
4
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

microsoft/documentdb-mcp のほかの issue

microsoft/documentdb-mcp の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。