mcpField
W
Wikijs Mcp

Wikijs Mcp

本地服务
github.com/RicardoCenci记忆与知识661 周前更新
代码仓库

关于 Wikijs Mcp

Wikijs Mcp 将 AI 助手连接到 Wiki.js 实例，以搜索和获取 wiki 内容。它支持按 ID、路径和语言区域读取页面，也可列出全部页面，并可使用 stdio 或 streamable HTTP 传输。

主要功能

  1. 01按查询搜索页面
  2. 02按 ID 获取页面
  3. 03按路径和语言区域获取页面
  4. 04列出所有 wiki 页面
  5. 05支持 stdio 或 streamable HTTP

适用场景

  1. 01查找特定主题的 wiki 页面
  2. 02通过页面 ID 获取内容
  3. 03按路径获取本地化页面
  4. 04通过 streamable HTTP 连接

MCP 相关

该 MCP 服务向 AI 客户端提供 Wiki.js 搜索和页面获取工具，并支持 stdio 与 streamable HTTP 传输。

#documentation#wikijs#mcp-server

配置

本地服务的配置在各客户端中通用，复制后粘贴到客户端的 MCP 配置文件即可。

mcp.json · 通用配置
{
  "mcpServers": {
    "wikijs": {
      "command": "npx",
      "args": [
        "-y",
        "wikijs-mcp"
      ],
      "env": {
        "WIKIJS_URL": "<WIKIJS_URL>",
        "WIKIJS_API_KEY": "<WIKIJS_API_KEY>"
      }
    }
  }
}
启动命令npx -y wikijs-mcp
需要配置的环境变量
WIKIJS_URL
WIKIJS_API_KEY密钥

本地服务需要在你的电脑上安装运行环境（如 Node.js 18+）。各客户端的配置文件位置不同，请参考客户端文档。

安装包
npmwikijs-mcp

工具

4

收录的工具列表 · 更新于 2 周前

参数类型必填说明
localestring否搜索时可选的语言区域（例如："en"）
pathstring否用于限制搜索范围的可选路径
querystring是用于查找页面的搜索查询

详细介绍

WikiJS MCP 服务

一个 Model Context Protocol（MCP）服务，可与 WikiJS 集成，让 AI 助手能够从你的 WikiJS 知识库中搜索和检索内容。

概述

此 MCP 服务通过提供以下工具，让 AI 助手能够与 WikiJS 实例交互：

  • 根据查询字符串搜索页面
  • 根据 ID 检索页面
  • 根据路径和区域设置检索页面
  • 获取 Wiki 中的所有页面

Cursor 配置

Stdio
{
  "mcpServers": {
    "wikijs-mcp": {
      "command": "npx",
        "args": [
            "wikijs-mcp"
        ],
        "env": {
            "WIKIJS_URL": <your wikijs url>,
            "WIKIJS_API_KEY": <your wikijs api key>
        }
    }
  }
}
Streamable Http
主机

启动服务 TRANSPORT_METHOD=streamable-http TRANSPORT_OPTIONS_PORT=8080 npx wikijs-mcp（请参阅环境变量，了解所有可用变量）

IDE
{
  "mcpServers": {
    "wikijs-mcp": {
      "transport": "http-streamable",
      "name": "WikiJS MCP",
      "url": <your mcp host url with port>/mcp
    }
  }
}

获取 WikiJS API 密钥

  1. 以管理员身份登录你的 WikiJS 实例
  2. 前往 Administration > API Access
  3. 创建具有适当权限的新 API 密钥
  4. 将生成的密钥复制到你的 .env 文件

开发

  1. 克隆仓库：
git clone https://github.com/RicardoCenci/wikijs-mcp.git
cd wikijs-mcp
  1. 安装依赖项：
npm install
  1. 复制环境模板并填写其内容
cp env.example .env
  1. 构建项目 如果已安装 make：
make build
  1. 部署 WikiJS 实例以进行测试
docker compose up -d

使用

npx wikijs-mcp

环境变量

变量描述必填允许的值默认值
WIKIJS_URL你的 WikiJS 实例的 URL是--
WIKIJS_API_KEYWikiJS API 密钥是--
TRANSPORT_METHOD传输方式否stdio, streamable-httpstdio
TRANSPORT_OPTIONS_CORS_ORIGINCORS 来源（仅适用于 streamable-http）否-*
TRANSPORT_OPTIONS_CORS_HEADERSCORS 标头，以逗号分隔（仅适用于 streamable-http）否-Content-Type=mcp-session-id
TRANSPORT_OPTIONS_CORS_METHODSCORS 方法，以逗号分隔（仅适用于 streamable-http）否-GET,POST,OPTIONS
TRANSPORT_OPTIONS_SESSION_TIMEOUT_MS会话超时时间（仅适用于 streamable-http）否-60000

许可证

此项目根据 MIT 许可证授权。

评论

支持 Markdown

第一次接触 MCP？

从协议是什么，到在客户端里装上第一个服务，这几条回答覆盖了大多数入门问题。

一个开放协议，规定了 AI 应用如何以统一方式连接外部工具与数据源。客户端负责与模型对话，MCP 服务负责提供工具、资源和提示模板，两者通过标准消息通信，同一个服务可以被不同客户端复用。