docs(mcp-server): add English README for npm package page#192
Merged
Conversation
mcp-server/ パッケージ (npm publish 対象) に英語 README を追加。 npmjs.com/package/github-webhook-mcp の "No README found" 状態を解消し、 npm 利用者向けに proxy の使い方・OAuth フロー・公開ツール・env 仕様を mcp-server/server/index.js の実装に基づいて記述。姉妹プロジェクト github-rag-mcp v0.7.1 と同じ章立てを踏襲し、本リポジトリ固有の WebSocket リアルタイム channel 通知と pending event 管理ツール群を反映。 Refs #191
Deploying with
|
| Status | Name | Latest Commit | Updated (UTC) |
|---|---|---|---|
| ✅ Deployment successful! View logs |
github-webhook-mcp | 8c14775 | Apr 19 2026, 03:42 PM |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #191
概要
npm 公開 proxy パッケージ
mcp-server/に英語 README を追加し、npmjs.com/package/github-webhook-mcp の "No README found" 状態を解消する。
内容
mcp-server/README.md(新規, 英語のみ) を追加What this proxy does / Requirements / Install / Client configuration /
Configuration / Tools exposed / Authentication flow / Troubleshooting /
Links / License
https://github-webhook.smgjp.com(preview インスタンス注記付き)WEBHOOK_WORKER_URL,WEBHOOK_CHANNELget_pending_status/list_pending_events/get_event/get_webhook_events/mark_processed(推奨ポーリングフロー含む)claude/channel)と起動方法 (
--dangerously-load-development-channels)~/.github-webhook-mcp/mcp-server/server/index.jsの実装を読み、推測ではなく実仕様に基づいて記述検証
npm test(node --check) passnpm pack --dry-runで README.md が tarball に含まれることを確認