MMCPMarkets
RW

ricardocenci/wikijs-mcp

Developer tools
6 stars 7 forks Quality 63 Trend 14MIT
Repository Install

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

A Model Context Protocol (MCP) server that provides integration with WikiJS, allowing AI assistants to search and retrieve content from your WikiJS knowledge base. 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 Start the server TRANSPORT_METHOD=streamable-http TRANSPORT_OPTIONS_PORT=8080 npx wikijs-mcp (See Environment Variables for all available variables) 1. Log into your WikiJS instance as an administrator 2. Go to > 3. Create a new API key with appropriate permissions 4. Copy the generated key to your .env file 3. Copy the environment template and fill out its contents 4. Build the project If you have make installed: 5. Deploy the WikiJS instance for testing This project is licensed under the MIT License.

README

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": ,
            "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": /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

Variable Description Required Allowed Values Default
WIKIJS_URL URL of your WikiJS instance Yes - -
WIKIJS_API_KEY WikiJS API key Yes - -
TRANSPORT_METHOD The transport method No stdio, streamable-http stdio
TRANSPORT_OPTIONS_CORS_ORIGIN Cors Origin (only on streamable-http) No - *
TRANSPORT_OPTIONS_CORS_HEADERS Cors Headers, comma separated (only on streamable-http) No - Content-Type=mcp-session-id
TRANSPORT_OPTIONS_CORS_METHODS Cors Methods, comma separated (only on streamable-http) No - GET,POST,OPTIONS
TRANSPORT_OPTIONS_SESSION_TIMEOUT_MS Session timeout (only on streamable-http) No - 60000

License

This project is licensed under the MIT License.

View the full README on GitHub

Install

npx wikijs-mcp
New to MCP? Start with the mcpskill.org guide →

Configuration

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