Make repo public + tag v1.0.0 to unblock plugin distribution

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

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

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
35/100
issue の種類
機能追加
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
node.js, typescript

調査の方向性

package.json と README のインストール用スニペットから始め、次に記載されている履歴とシークレットスキャンのチェックを実行します。新しいマシンで npx を使ってパッケージを検証し、v1.0.0 を作成する前にリリースチェックリストを確認します。完了の条件は、リポジトリが公開され、タグに動作する dist 出力が含まれ、外部からのインストールが成功することです。

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

説明

enhancement

Make repo public + tag v1.0.0 to unblock plugin distribution

Why

Azure/documentdb-agent-kit ships plugin configs for Claude / Codex / Cursor / Gemini / Copilot / VS Code that point at an npm package (documentdb-mcp-server) that was unpublished on 2025-04-17. Every plugin install is broken today.

The fastest unblock is to publish this MCP server's source as a public repo and have the plugins fetch via npx github:microsoft/documentdb-mcp#v1.0.0. A polished npm package (v2) ships later — see #TBD.

Pre-flight hygiene (do before flipping visibility)

The repo currently passes secret-scanning with push protection enabled, but a public flip will trigger Snyk and other external scanners. Run through these once:

  • Git history sweep for credentials in past commits:
    git log -p --all | rg -i 'password|token|connection|secret|api[_-]?key' | head -200
    
    If anything legitimate-looking turns up, rewrite history (git filter-repo) before going public.
  • gh secret-scanning alerts list -R microsoft/documentdb-mcp — confirm zero open alerts.
  • README install snippets all reference github:microsoft/documentdb-mcp consistently (the VS Code / Cursor install badges already do; double-check the manual-install and Docker sections).
  • package.json audit:
    • name, version, description, license, repository, homepage are correct
    • bin field points at the right entry script (so npx knows what to run)
    • files field whitelists everything npx needs (compiled output + manifests)
    • prepare or prepack script builds TS so npx can compile on first install
  • Compiled-output strategy decision: ship dist/ in the GitHub repo, OR rely on a prepare script. npx github:... does run prepare, but it adds 30–60s to cold start. Recommend: commit dist/ to the v1.0.0 tag specifically, even if it's .gitignored on main, so the public spec installs fast.
  • LICENSE present (MIT or whatever Microsoft OSPO requires).
  • SECURITY.md present per Microsoft OSPO requirements for public repos.
  • CODE_OF_CONDUCT.md + SUPPORT.md per Microsoft OSPO.
  • OSPO clearance: confirm the repo has been through Microsoft Open Source Programs Office release review.

Flip + tag

  • Set visibility → Public (Settings → Danger Zone)
  • Verify external npx -y github:microsoft/documentdb-mcp works from a fresh machine with no GitHub auth
  • Create release tag v1.0.0 on the commit that has the validated dist/
  • Update README to reference the tag explicitly in install snippets

Post-flip validation

  • Trigger a Snyk re-scan and confirm no new High/Critical findings
  • Confirm secret-scanning, Dependabot, and CodeQL are all enabled on the now-public repo
  • Hand off to Azure/documentdb-agent-kit#TBD to swap the plugin configs

Done when

  • Repo is public
  • v1.0.0 tag exists with a working dist/
  • Fresh npx -y github:microsoft/documentdb-mcp#v1.0.0 succeeds on a machine outside the Microsoft network
  • Agent-kit unblock issue is unblocked
主要言語
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 を短くまとめたダイジェスト。