Package Exports

github-wiki-mcp-server
github-wiki-mcp-server/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (github-wiki-mcp-server) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

GitHub Wiki MCP Server

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からグローバルにインストール
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

APIエンドポイント

MCP Context API

POST /mcp

リクエスト例:

{
  "query": "検索したい内容"
}

レスポンス例:

{
  "contexts": [
    {
      "content": "# ページタイトル\n\nこのページの内容...",
      "source": "ページ名.md"
    }
  ]
}

ヘルスチェック

GET /health

Cursorとの連携方法

このサーバーを起動
Cursorの設定でMCPサーバーとしてhttp://localhost:3333/mcpを指定

Cursorの設定例（JSON）

{
  "contextSources": {
    "externalServers": [
      {
        "name": "GitHub Wiki",
        "url": "http://localhost:3333/mcp",
        "enabled": true,
        "priority": 1
      }
    ]
  }
}

npmパッケージとして公開する方法

package.jsonの情報を更新
npmにログイン
```
npm login
```
パッケージを公開
```
npm publish
```

ライセンス

MIT