目的
mcp-server/ (npm 公開 proxy パッケージ) に 英語 README.md を追加し、npm パッケージページ (npmjs.com/package/github-webhook-mcp) に表示される説明を整備する。
背景
mcp-server/package.json は npm に publish 済み (v0.10.5 が npm latest)
- mcp-server ディレクトリに README.md が存在しないため、npm パッケージページは "No README found" 状態
- CD workflow は GitHub release 作成 → 自動 npm publish の構成。next release (v0.10.6) で README が同梱されれば npm 側に反映される
- 兄弟プロジェクト github-rag-mcp で同じ対応が完了済 (v0.7.1 で README 追加、npm 反映確認済) → 同じ方針で進める
前提
- npm パッケージページに表示される README は
mcp-server/README.md (npm publish 時の package root)。リポジトリ root の README ではない
- npm は多言語 README を表示しない仕様 (single README.md のみ)。英語のみ で作成
- 利用者は npm install / npx 経由でこの proxy を起動し、Cloudflare Worker (本体) 経由で GitHub webhook の状態にアクセスするワークフロー
制約
- 英語のみ (ja 版は作成しない)
- npm 利用者向けの観点で書く (Worker 本体ではなく、npm から取得する proxy の使い方を中心に)
- 含めるべき内容:
- 何のパッケージか (1-2 文)
- install / 起動方法 (
npx github-webhook-mcp / Claude Desktop 設定例)
- 接続先 Worker の指定方法 (env 変数 / config) —
mcp-server/server/index.js を読んで実際の env 仕様を確認
- OAuth フロー (実装で使われていれば)
- 公開ツール一覧 (実装から拾う)
- リポジトリ本体へのリンク (アーキテクチャ詳細・ライセンス等)
- npm の files 配列調整は通常不要 (npm はルート README.md を自動取り込み)
- Markdown は GitHub Flavored Markdown 準拠
対象ファイル
| ファイル |
変更内容 |
mcp-server/README.md (新規) |
npm パッケージページ用の英語 README |
関連
目的
mcp-server/(npm 公開 proxy パッケージ) に 英語 README.md を追加し、npm パッケージページ (npmjs.com/package/github-webhook-mcp) に表示される説明を整備する。背景
mcp-server/package.jsonは npm に publish 済み (v0.10.5 が npm latest)前提
mcp-server/README.md(npm publish 時の package root)。リポジトリ root の README ではない制約
npx github-webhook-mcp/ Claude Desktop 設定例)mcp-server/server/index.jsを読んで実際の env 仕様を確認対象ファイル
mcp-server/README.md(新規)関連