WikiJS

Search and retrieve content from a WikiJS knowledge base.

GitHub

WikiJS MCP Server

A Model Context Protocol (MCP) server that provides integration with WikiJS, allowing AI assistants to search and retrieve content from your WikiJS knowledge base.

Overview

This MCP server enables AI assistants to interact with WikiJS instances by providing tools to:

  • Search for pages by query string
  • Retrieve pages by ID
  • Retrieve pages by path and locale
  • Get all pages from the wiki

Configuration for 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

Host Machine

Start the server TRANSPORT_METHOD=streamable-http TRANSPORT_OPTIONS_PORT=8080 npx wikijs-mcp (See Environment Variables for all available variables)

IDE

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

Getting a WikiJS API Key

  1. Log into your WikiJS instance as an administrator
  2. Go to Administration > API Access
  3. Create a new API key with appropriate permissions
  4. Copy the generated key to your .env file

Development

  1. Clone the repository:
git clone https://github.com/RicardoCenci/wikijs-mcp.git
cd wikijs-mcp
  1. Install dependencies:
npm install
  1. Copy the environment template and fill out its contents
cp env.example .env
  1. Build the project If you have make installed:
make build
  1. Deploy the WikiJS instance for testing
docker compose up -d

Usage

npx wikijs-mcp

Environment Variables

VariableDescriptionRequiredAllowed ValuesDefault
WIKIJS_URLURL of your WikiJS instanceYes--
WIKIJS_API_KEYWikiJS API keyYes--
TRANSPORT_METHODThe transport methodNostdio, streamable-httpstdio
TRANSPORT_OPTIONS_CORS_ORIGINCors Origin (only on streamable-http)No-*
TRANSPORT_OPTIONS_CORS_HEADERSCors Headers, comma separated (only on streamable-http)No-Content-Type=mcp-session-id
TRANSPORT_OPTIONS_CORS_METHODSCors Methods, comma separated (only on streamable-http)No-GET,POST,OPTIONS
TRANSPORT_OPTIONS_SESSION_TIMEOUT_MSSession timeout (only on streamable-http)No-60000

License

This project is licensed under the MIT License.

Máy chủ liên quan

NotebookLM Web Importer

Nhập trang web và video YouTube vào NotebookLM chỉ với một cú nhấp. Được tin dùng bởi hơn 200.000 người dùng.

Cài đặt tiện ích Chrome