What is Mcp Wikijs

mcp-wikijs is an MCP (Model Context Protocol) server designed for WikiJS, enabling AI models to interact seamlessly with wiki content.

Use cases

Use cases include integrating with chat applications, document search and retrieval, content management, and enabling AI models to generate or modify wiki content.

How to use

To use mcp-wikijs, you can start the server with a single npx command after building the project. Configure your WikiJS instance URL and API token in the MCP server configuration.

Key features

Key features include full implementation of the Model Context Protocol, built with TypeScript for type safety, easy startup with npx, and tools for searching, reading, creating, updating, and deleting wiki documents. It also supports Docker for development.

Where to use

mcp-wikijs can be used in various fields such as knowledge management, content creation, AI applications, and any domain that requires interaction with wiki-style documentation.

MCP WikiJS

An MCP (Model Context Protocol) server for WikiJS that allows AI models to interact with wiki content.

Features

• Full implementation of the Model Context Protocol server specification
• Built with TypeScript for type safety and modern JavaScript features
• Simple to use - can be started with a single npx command
• Provides AI models with access to WikiJS content through MCP tools:
  • Search documents
  • Read document content
  • Create new documents
  • Update existing documents
  • Delete documents
• Docker-ready for easy development setup

Installation

build

cd mcp-wikijs
npm run build

add mcp server

for claude

{
  "mcpServers": {
    "wikijs": {
      "command": "node",
      "args": [
        "path/to/mcp-wikijs/dist/index.js"
      ],
      "env": {
        "WIKIJS_URL": "https://example.com",
        "WIKIJS_TOKEN": "YOUR_API_TOKEN"
      }
    }
  }
}

Docker Development Environment

For development purposes, this project includes a Docker Compose setup that starts:

• A PostgreSQL database
• A WikiJS instance
• The MCP-WikiJS server with hot-reload

To start the development environment:

docker-compose up

For detailed instructions, see the Docker guide.

Available Tools

• search - Search for wiki pages by query
• read - Read a wiki page by ID or path
• create - Create a new wiki page
• update - Update an existing wiki page
• delete - Delete a wiki page by ID

Examples

See the examples directory for detailed usage examples, including:

• Integrating with chat applications
• Document search and retrieval
• Content creation and management

Configuration

WikiJS Configuration

• WIKIJS_URL: URL of your WikiJS instance
• WIKIJS_TOKEN: API token for authentication with WikiJS

MCP Server Configuration

• MCP_PORT: Port for the MCP server (default: 8080)
• MCP_HOST: Host for the MCP server (default: 0.0.0.0)
• LOG_LEVEL: Logging level (debug, info, warn, error)

Development

Standard Development

# Clone the repository
git clone https://github.com/im-neko/mcp-wikijs.git
cd mcp-wikijs

# Install dependencies
npm install

# Build
npm run build

# Debug
npx @modelcontextprotocol/inspector node dist/index.js 

Docker Development

See the Docker guide for instructions on setting up a complete development environment with Docker.

Project Documentation

• Architecture Document - Detailed design of the system
• Implementation Plan - Development phases and schedule
• Docker Guide - Development with Docker

Architecture

This project follows a modular architecture with clear separation of concerns:

• Configuration management: Environment variables and settings
• WikiJS client: Handles communication with WikiJS GraphQL API
• MCP server: Implements the Model Context Protocol
• Tools: Implements specific operations (search, read, update, etc.)

License

MIT