AI导哈

GitHub Wiki MCP服务器

将本地克隆的GitHub Wiki作为符合Model Context Protocol的服务器，提供与Cursor编辑器集成的API端点以获取上下文信息。

  • by Procrustes5
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 procrustes5/github-wiki-mcp-server

使用说明

GitHub Wiki MCP服务器

GitHub Wiki本地克隆模型上下文协议是作为对应服务器提供的服务。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上下文API

POST /mcp

请求示例：

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

响应示例：

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

健康检查

GET /health

Cursor的合作方法

  1. 启动此服务器
  2. Cursor在工作空间的边缘MCP作为服务器http://localhost:3333/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

许可证

麻省理工学院

相关 MCP