¶ Wiki.js MCP Server
¶ Table of Contents
- What is an MCP Server?
- What can the Wiki.js MCP Server do?
- Requirements
- Installation
- Available Tools
- Usage Examples
- Workflow: Plugin Development → Wiki Documentation
- Troubleshooting
- Technical Details
- Best Practices
¶ What is an MCP Server?
The Model Context Protocol (MCP) is an open protocol that enables AI assistants like Claude to interact with external tools and services. An MCP server provides a collection of "tools" (functions) that Claude can call during a conversation.
Benefits of MCP:
- 🔌 Extensible - Add new capabilities to Claude without changing code
- 🔒 Secure - Full control over permissions and access
- 🚀 Automation - Handle recurring tasks directly from Claude
- 🎯 Context-aware - Claude can access your tools while you develop
¶ Example Workflow
Without MCP Server:
- You develop a plugin in Claude Code
- You manually write the README.md
- You log into Wiki.js
- You manually copy/paste documentation
- You format everything by hand
With MCP Server:
- You develop a plugin in Claude Code
- You say: "Create a comprehensive wiki page for this"
- ✅ Claude automatically creates the wiki page with structure, code examples, and documentation
¶ What can the Wiki.js MCP Server do?
This MCP server enables Claude to interact directly with your Wiki.js instance:
¶ Features
- ✅ Create Pages - New wiki pages with markdown or HTML content
- ✅ Update Pages - Edit existing pages (content, title, description, tags)
- ✅ Get Pages - Retrieve pages by ID or path
- ✅ List Pages - List all pages with optional locale filtering
- ✅ Search Pages - Full-text search across all wiki content
- ✅ Delete Pages - Remove pages from the wiki
- ✅ Move Pages - Reorganize content by changing paths
¶ Typical Use Cases
1. Automatic Documentation After Plugin Development
You: "I just finished developing the Ticket Merge Plugin.
Create comprehensive technical documentation in Wiki.js."
Claude: *Analyzes the code, architecture, and API*
*Automatically creates a structured wiki page with:*
- Technical overview
- Architecture diagrams
- API documentation
- Code examples
- Troubleshooting guide
2. Knowledge Management During Development
You: "Search Wiki.js for all osTicket plugin documentations
and show me the naming conventions."
Claude: *Searches in Wiki.js*
*Extracts relevant information*
*Applies it to your current code*
3. Content Reorganization
You: "All pages under /legacy/ should be moved to /archive/."
Claude: *Lists all /legacy/ pages*
*Systematically moves them to /archive/*
*Updates internal links*
¶ Requirements
- Node.js 18+ installed
- Wiki.js instance (v2.x or v3.x)
- Wiki.js API Token with page management permissions
¶ Installation
¶ Step 1: Clone Repository
# Create MCP server directory
mkdir -p ~/.claude/mcp-servers/wikijs
# Clone repository
git clone https://github.com/markus-michalski/wikijs-mcp-server.git ~/.claude/mcp-servers/wikijs
¶ Step 2: Install Dependencies
cd ~/.claude/mcp-servers/wikijs
npm install
¶ Step 3: Configure Environment Variables
cd ~/.claude/mcp-servers/wikijs
cp .env.example .env
Edit ~/.claude/mcp-servers/wikijs/.env:
WIKIJS_API_URL=https://your-wiki-instance.com/graphql
WIKIJS_API_TOKEN=your-api-token-here
Important: The server automatically loads the .env file when started.
¶ Step 4: Create Wiki.js API Token
- Login to Wiki.js Admin Panel
- Navigate to Administration → API Access
- Click Generate New Key
- Name:
Claude Code MCP Server - Select permissions:
- ✅
read:pages- Read pages - ✅
write:pages- Create and update pages - ✅
manage:pages- Delete and move pages
- ✅
- Click Generate
- Copy the token to
~/.claude/mcp-servers/wikijs/.env
¶ Step 5: Claude Code Configuration
Edit ~/.claude.json and add the wikijs server to the global mcpServers section:
{
"mcpServers": {
"wikijs": {
"type": "stdio",
"command": "node",
"args": [
"/home/YOUR_USERNAME/.claude/mcp-servers/wikijs/index.js"
],
"env": {}
}
}
}
Note: Replace /home/YOUR_USERNAME/ with your actual home directory path.
¶ Step 6: Restart Claude Code
# Exit Claude Code
/exit
# Restart Claude Code
claude
Verify the connection:
/mcp
You should see "wikijs" with status "✓ connected".
¶ Available Tools
¶ ✨ create_page - Create Page
Creates a new page in Wiki.js.
Parameters:
path(required) - Page path (e.g., "osticket/plugin-name")title(required) - Page titlecontent(required) - Page content (Markdown or HTML)description(required) - Short page descriptionlocale(optional) - Language (default: "en")editor(optional) - Editor type: "markdown", "code", "ckeditor" (default: "markdown")isPublished(optional) - Publish immediately (default: true)isPrivate(optional) - Private page with restricted access (default: false)tags(optional) - Array of tags (default: [])
Example:
{
"path": "osticket/ticket-merge-plugin",
"title": "Ticket Merge Plugin - Technical Documentation",
"content": "# Technical Documentation\\n\\n...",
"description": "Detailed technical documentation for the Ticket Merge Plugin",
"locale": "en",
"editor": "markdown",
"isPublished": true,
"isPrivate": false,
"tags": ["osticket", "plugin", "development"]
}
¶ 🔄 update_page - Update Page
Updates an existing page.
Parameters:
id(required) - Page IDcontent(optional) - New contenttitle(optional) - New titledescription(optional) - New descriptionisPublished(optional) - Publication statustags(optional) - New tags array
Example:
{
"id": 8,
"content": "# Updated Content\\n\\nNew information...",
"tags": ["osticket", "plugin", "updated"]
}
¶ 📖 get_page - Get Page
Retrieves a page by ID or path.
Parameters:
id(optional) - Page IDpath(optional) - Page path (required if no ID)locale(optional) - Language (required when using path)
Examples:
// By ID
{ "id": 5 }
// By path
{ "path": "osticket/plugin-name", "locale": "en" }
⚠️ Important Note on Tags:
The get_page tool does not return tags. This is a limitation of the Wiki.js GraphQL API - the tags field is only supported by pages.list(), not by pages.single() or pages.singleByPath().
Workaround: If you need tags for a specific page, use list_pages instead and filter the results by ID or path.
¶ 📋 list_pages - List Pages
Lists all pages with optional filtering. This tool also returns tags!
Parameters:
locale(optional) - Filter by languagelimit(optional) - Maximum results (default: 100)
Example:
{
"locale": "en",
"limit": 50
}
¶ 🔍 search_pages - Search Pages
Searches pages by query string.
Parameters:
query(required) - Search querylocale(optional) - Filter by language
Example:
{
"query": "osTicket plugin",
"locale": "en"
}
¶ 🗑️ delete_page - Delete Page
Deletes a page (irreversible!).
Parameters:
id(required) - Page ID to delete
Example:
{ "id": 123 }
¶ 📦 move_page - Move Page
Moves a page to a new path.
Parameters:
id(required) - Page IDdestinationPath(required) - New pathdestinationLocale(optional) - Target language (default: "en")
Example:
{
"id": 8,
"destinationPath": "projects/osticket/ticket-merge",
"destinationLocale": "en"
}
¶ Usage Examples
¶ Example 1: Create Plugin Documentation After Development
After finishing a plugin, automatically create comprehensive Wiki.js documentation:
You in Claude Code:
"I just finished developing the Ticket Merge Plugin.
Create a comprehensive technical wiki page"
Claude:
1. Analyzes the code in src/
2. Reads the README.md
3. Extracts API endpoints, classes, methods
4. Generates structured Markdown documentation
5. Automatically creates wiki page with:
- Architecture overview
- Component structure
- API documentation
- Code examples
- Troubleshooting tips
¶ Example 2: Update Page with New Information
You: "Add a section about performance optimization to the
Ticket Merge Plugin page"
Claude:
1. Retrieves current page via get_page
2. Analyzes existing content
3. Generates new section
4. Updates page via update_page
¶ Example 3: Search and Reorganize
You: "Find all osTicket pages and move them under projects/osticket/"
Claude:
1. Searches via search_pages for "osTicket"
2. Lists found pages
3. Moves each page via move_page to new path
4. Provides summary
¶ Workflow: Plugin Development → Wiki Documentation
Typical Workflow:
- Develop Plugin - Write code, create short README.md (user-focused)
- Claude Code creates detailed wiki page - Automatically via MCP
- Wiki page contains:
- Technical architecture details
- Code flow diagrams
- API documentation
- Advanced troubleshooting
- Developer notes
- README.md stays concise - 100-200 lines, user-first
- Wiki.js has deep technical docs - 500+ lines, developer-first
Benefits:
- ✅ No duplicate work
- ✅ Separation of concerns (user docs vs. tech docs)
- ✅ Automated documentation generation
- ✅ Consistent structure
¶ Troubleshooting
¶ "Missing required environment variables"
Problem: .env file not found or incomplete
Solution:
- Ensure
.envexists at~/.claude/mcp-servers/wikijs/.env - Verify
WIKIJS_API_URLandWIKIJS_API_TOKENare set - Check
.env.examplefor correct format
¶ "GraphQL Error: Forbidden"
Problem: API token lacks required permissions
Solution:
- Go to Wiki.js Admin Panel → API Access
- Edit your API key
- Ensure these permissions are enabled:
- ✅
read:pages - ✅
write:pages - ✅
manage:pages
- ✅
- Regenerate token if needed
¶ "HTTP error! status: 404"
Problem: Wrong API URL
Solution:
- Verify
WIKIJS_API_URLin~/.claude/mcp-servers/wikijs/.env - Must end with
/graphql - Example:
https://your-wiki.com/graphql
¶ Server not appearing in Claude Code / Status "failed"
Problem: MCP configuration not loaded or server startup failed
Solution:
- Check
~/.claude.jsonsyntax (must be valid JSON) - Verify file path to
index.jsis correct - Ensure
.envfile exists - Run
/mcpin Claude Code to see server status - Restart Claude Code completely (
/exitthen restart)
¶ Technical Details
¶ Project Structure
wikijs-mcp-server/
├── index.js # MCP server entry point
├── package.json # Dependencies
├── .env # Configuration (not in Git)
├── .env.example # Configuration template
├── src/
│ ├── client.js # Wiki.js GraphQL client
│ └── tools/
│ ├── create-page.js
│ ├── update-page.js
│ ├── get-page.js
│ ├── list-pages.js
│ ├── search-pages.js
│ ├── delete-page.js
│ └── move-page.js
└── README.md
¶ Technologies Used
- @modelcontextprotocol/sdk - MCP Server SDK
- node-fetch - HTTP client for GraphQL API
- dotenv - Environment variable loading
¶ Best Practices
¶ 1. Consistent Path Structure
Use a clear hierarchy for wiki paths:
projects/osticket/plugins/ticket-merge
projects/oxid/modules/payment-gateway
tutorials/symfony/testing
¶ 2. Meaningful Tags
Use tags for better searchability:
tags: ["osticket", "plugin", "api", "development"]
¶ 3. Write Descriptions
Good descriptions help with search:
description: "Technical documentation for osTicket Ticket Merge Plugin with API reference"
¶ License
MIT License - See LICENSE file for details
¶ Author
Markus Michalski
- Website: markus-michalski.net
- Wiki: faq.markus-michalski.net
- GitHub: @markus-michalski