Wikijs MCP Server

🚀 WikiJS MCP Server

Connect Claude to your Wiki.js documentation! This tool allows Claude to directly read and update your Wiki.js pages, providing it access to your team's knowledge base. It's ideal for keeping documentation current and quickly retrieving information.

🚀 Quick Start

Once installed, you can leverage Claude to perform various operations on your Wiki.js documentation.

✨ Features

• 🔍 Search: Look for specific topics within your wiki.
• 📖 Read: Access documentation pages.
• ✏️ Update: Incorporate new information into existing pages.
• 📝 Create: Generate new documentation.
• 🗂️ Organize: Rearrange pages as needed.
• 🗑️ Delete: Remove outdated pages.

📦 Installation

Prerequisites

Before you start, ensure you have the following installed:

• ✅ Git (Download here)
• ✅ Python 3.8 or newer (Download here)
• ✅ Claude Code (Get it here)
• ✅ Access to a Wiki.js site (with an API key - instructions on obtaining one are provided below)

Step 1: Download the Code

Open your terminal (Command Prompt on Windows, Terminal on Mac) and execute the following commands:

git clone https://github.com/your-username/wikijs-mcp.git
cd wikijs-mcp

💡 Usage Tip

If you encounter a "command not found" error, verify that Git is installed.

Step 2: Obtain Your Wiki.js API Key

1. Log in to your Wiki.js site as an administrator.
2. Navigate to the Administration section (usually in the top menu).
3. Click on API Access in the left sidebar.
4. If the API is disabled, enable it by clicking the toggle.
5. Click "+ New API Key".
6. Name it, for example, "Claude Integration".
7. Select the following permissions:
   • ✅ Read Pages
   • ✅ Write Pages
   • ✅ Manage Pages (if you want Claude to create/delete pages)
8. Click Create and copy the API key; you'll need it in the next step.

⚠️ Important Note

Store this key securely as you won't be able to view it again.

Step 3: Configure Your Connection

1. Create the configuration file:

cp .env.example .env

2. Open the .env file in a text editor (e.g., Notepad, TextEdit, VS Code).
3. Replace the example values with your actual information:

WIKIJS_URL=https://your-wiki-site.com
WIKIJS_API_KEY=paste-your-api-key-here

Example:

WIKIJS_URL=https://docs.mycompany.com
WIKIJS_API_KEY=ey1234567890abcdef...

Step 4: Install Python Dependencies

Run the following command to install the necessary dependencies:

pip install -e .

💡 Usage Tip

• If you get a "pip: command not found" error, try pip3 instead.
• On Mac, you may need to use python3 -m pip install -e ..

Step 5: Test the Connection

Execute the following command to ensure everything is working correctly:

python -m wikijs_mcp.server

You should see output similar to:

WikiJS MCP Server starting...
Connected to Wiki.js at https://your-wiki-site.com
Ready to accept connections!

Press Ctrl+C to stop the server.

💻 Usage Examples

Basic Usage

The best part is that Claude Code will automatically detect this MCP server! Just open Claude Code in the wikijs-mcp folder, and Claude will have access to your Wiki.js.

Once connected, you can issue commands like:

"Search my wiki for information about deployment procedures"
"Read the page at /docs/getting-started"
"Update the troubleshooting guide with a new solution for login issues"
"Create a new page at /docs/api/webhooks with webhook documentation"

📚 Documentation

Manual Configuration (Advanced)

If you're using a different MCP client or require custom settings, use the following configurations:

For Standard Installation

{
  "mcpServers": {
    "wikijs": {
      "command": "python",
      "args": ["-m", "wikijs_mcp.server"],
      "env": {
        "WIKIJS_URL": "https://your-wiki-site.com",
        "WIKIJS_API_KEY": "your-api-key"
      }
    }
  }
}

For Docker Users

{
  "mcpServers": {
    "wikijs": {
      "command": "docker",
      "args": ["compose", "run", "--rm", "-T", "wikijs-mcp-server", "python3", "-m", "wikijs_mcp.server"],
      "cwd": "/path/to/wikijs-mcp"
    }
  }
}

Common Issues & Solutions

"Connection refused" or "Cannot connect to Wiki.js"

• ✅ Ensure your WIKIJS_URL doesn't have a trailing slash.
• ✅ Confirm that your Wiki.js site is accessible from your computer.
• ✅ Verify that the API is enabled in the Wiki.js admin panel.

"Authentication failed" or "Invalid API key"

• ✅ Double-check that you copied the entire API key.
• ✅ Ensure there are no extra spaces before or after the key.
• ✅ Verify that the API key has the appropriate permissions.

"Module not found" errors

• ✅ Make sure you ran pip install -e . in the wikijs-mcp folder.
• ✅ Try using python3 instead of python.

Claude Code doesn't see the Wiki.js tools

• ✅ Ensure you're running Claude Code from the wikijs-mcp folder.
• ✅ Check that the .mcp.json file exists.
• ✅ Try restarting Claude Code.

Available Tools Reference

Here's a list of what Claude can do once connected:

🔧 Technical Details

For Developers

Running Tests

# Install dev dependencies
pip install -e ".[dev]"

# Run all tests
pytest

# Run with coverage
pytest --cov=wikijs_mcp

Code Quality

# Format code
black wikijs_mcp/ tests/

# Type checking
mypy wikijs_mcp/

📄 License

This project is licensed under the MIT License. You're free to use and modify it.

💬 Need Help?

• Check the Common Issues section above.
• Refer to the Wiki.js documentation.
• Open an issue on GitHub if you encounter difficulties.

Happy documenting! 🎉