README Documentation
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
{
"mcpServers": {
"wikijs-mcp": {
"command": "npx",
"args": [
"wikijs-mcp"
],
"env": {
"WIKIJS_URL": <your wikijs url>,
"WIKIJS_API_KEY": <your wikijs api key>
}
}
}
}
Getting a WikiJS API Key
- Log into your WikiJS instance as an administrator
- Go to Administration > API Access
- Create a new API key with appropriate permissions
- Copy the generated key to your
.env
file
Development
- Clone the repository:
git clone https://github.com/RicardoCenci/wikijs-mcp.git
cd wikijs-mcp
- Install dependencies:
npm install
- Copy the environment template and fill out its contents
cp env.example .env
- Build the project
If you have
make
installed:
make build
- Deploy the WikiJS instance for testing
docker composer up -d
Usage
npx wikijs-mcp
Environment Variables
Variable | Description | Required | Default |
---|---|---|---|
WIKIJS_URL | URL of your WikiJS instance | Yes | - |
WIKIJS_API_KEY | WikiJS API key | Yes | - |
License
This project is licensed under the MIT License.
Quick Actions
Key Features
Model Context Protocol
Secure Communication
Real-time Updates
Open Source