GitHub Wiki MCP Server

GitHub Wiki MCP 服务

这项服务将 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 配合使用

1. 启动此服务
2. 在 Cursor 设置中，将 http://localhost:3333/mcp 指定为 MCP 服务

Cursor 配置示例（JSON）

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

发布为 npm 包

1. 更新 package.json 中的信息

2. 登录 npm

   npm login
   

3. 发布包

   npm publish
   

许可证

MIT