WikiJS集成服务

一个提供与WikiJS集成的MCP服务器,允许AI助手搜索和检索WikiJS知识库中的内容。

  • by RicardoCenci
  • TypeScript
  • 本地部署
  • 6 星标
  • 更新于
在 GitHub 查看 RicardoCenci/wikijs-mcp

使用说明

WikiJS MCP 服务器

一个模型上下文协议(MCP)服务器,提供与WikiJS的集成,允许AI助手从您的WikiJS知识库中搜索和检索内容。

概述

此MCP服务器通过提供以下工具使AI助手能够与WikiJS实例交互:

  • 按查询字符串搜索页面
  • 按ID检索页面
  • 按路径和区域设置检索页面
  • 从wiki获取所有页面

光标配置

标准输入输出

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

可流式传输Http

主机

启动服务器 TRANSPORT_METHOD=streamable-http TRANSPORT_OPTIONS_PORT=8080 npx wikijs-mcp (参见 环境变量 对于所有可用变量)

集成开发环境

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

获取WikiJS API密钥

  1. 以管理员身份登录您的WikiJS实例
  2. 首选 行政 > API访问
  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_KEY WikiJS API密钥 是 - -
TRANSPORT_METHOD 传输方法 否 stdio,可流式传输http stdio
TRANSPORT_OPTIONS_CORS_ORIGIN Cors Origin(仅适用于可流式传输的http) 否 - *
TRANSPORT_OPTIONS_CORS_HEADERS Cors标头,逗号分隔(仅适用于可流式传输的http) 否 - 内容类型=mcp会话id
TRANSPORT_OPTIONS_CORS_METHODS Cors方法,逗号分隔(仅适用于可流式传输的http) 否 - GET、POST、OPTIONS
TRANSPORT_OPTIONS_SESSION_TIMEOUT_MS 会话超时(仅在可流式传输的http上) 否 - 60000

许可证

该项目根据MIT许可证获得许可。