GitHub WikiのローカルクローンをModel Context Protocol対応サーバーとして提供するサービスです。Cursorエディタと連携して使用することを想定しています。
- ローカルにクローンされたGitHub Wikiからコンテキスト情報を取得
- MCPプロトコルに準拠したAPIエンドポイントの提供
- クエリに基づいた関連Wiki情報の検索
- Node.js 14以上
- ローカルにクローンされたGitHub Wikiリポジトリ
# リポジトリをクローン
git clone https://github.com/yourusername/github-wiki-mcp-server.git
cd github-wiki-mcp-server
# 依存関係をインストール
npm install
# npmからグローバルにインストール
npm install -g github-wiki-mcp-server
config/default.js
ファイルを編集して、GitHubのWikiパスなどを設定します。
module.exports = {
server: {
port: process.env.PORT || 3333
},
wiki: {
path: process.env.WIKI_PATH || './wiki' // ここを実際のWikiパスに変更
},
debug: process.env.DEBUG === 'true' || false
}
npm run dev
npm start
# 基本的な起動
github-wiki-mcp
# ポート番号とWikiパスを指定して起動
github-wiki-mcp --port 4444 --wiki /path/to/your/wiki
# 環境変数を使用してポートとWikiパスを指定
PORT=4444 WIKI_PATH=/path/to/your/wiki github-wiki-mcp
POST /mcp
リクエスト例:
{
"query": "検索したい内容"
}
レスポンス例:
{
"contexts": [
{
"content": "# ページタイトル\n\nこのページの内容...",
"source": "ページ名.md"
}
]
}
GET /health
- このサーバーを起動
- Cursorの設定でMCPサーバーとして
http://localhost:3333/mcp
を指定
{
"contextSources": {
"externalServers": [
{
"name": "GitHub Wiki",
"url": "http://localhost:3333/mcp",
"enabled": true,
"priority": 1
}
]
}
}
-
package.jsonの情報を更新
-
npmにログイン
npm login
-
パッケージを公開
npm publish
MIT