[DX] Provide paste-ready mcp.json / claude_desktop_config.json snippets per client

オープン
#53 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

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

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
52/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
静か
技術スタック
typescript

調査の方向性

要求された clients/ のディレクトリ構成から始め、関連する quickstart README リンクを確認します。4つのクライアント固有の設定ファイルを用意し、ネストされた文字列化 CONNECTION_PROFILES のエンコーディングと、クライアント固有のアノテーション形式を確認します。各スニペットを実際のクライアントでエンドツーエンドに検証し、ユーザーが接続文字列を置き換え、再起動後に接続できることを確認します。

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

説明

documentation dx release-readiness tier-1

Goal

Eliminate JSON-escape gymnastics for first-time users.

What to ship

A clients/ directory at the repo root with subdirectories per client:

  • clients/vscode/mcp.json (stdio + connection string)
  • clients/vscode/mcp.entra.json (HTTP + Entra)
  • clients/copilot-cli/config.json
  • clients/claude-desktop/claude_desktop_config.json

Each file is:

  • A literal, paste-ready config snippet (no placeholder text the user has to manually substitute beyond a clearly-marked connection string).
  • Annotated with // comments (or a sibling README) explaining each field.
  • Tested end-to-end against the actual client.

Acceptance criteria

  • A first-run user can copy one file, replace the connection string, restart their client, and have a working setup.
  • Snippets handle the double-encoding correctly (CONNECTION_PROFILES is stringified JSON inside outer JSON).
  • README links to clients/<your-client> from the relevant quickstart.

Why

The single most error-prone step today is hand-escaping the config JSON. Pre-baking it removes the entire class of error.

主要言語
TypeScript
スター
3
フォーク
4
PR マージ指標
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 を短くまとめたダイジェスト。