Wikijs MCP

🚀 WikiJS MCP Server

A Model Context Protocol (MCP) server that integrates with WikiJS, enabling AI assistants to search and retrieve content from your WikiJS knowledge base.

🚀 Quick Start

This MCP server allows AI assistants to interact with WikiJS instances. With it, AI assistants can perform the following operations:

• Search for pages using a query string.
• Retrieve pages by their ID.
• Retrieve pages by path and locale.
• Obtain all pages from the wiki.

📦 Installation

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

1. Log in to your WikiJS instance as an administrator.
2. Navigate to Administration > API Access.
3. Create a new API key with appropriate permissions.
4. Copy the generated key to your .env file.

Development Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Copy the environment template and fill in its contents:

cp env.example .env

4. Build the project. If you have make installed:

make build

5. Deploy the WikiJS instance for testing:

docker composer up -d

💻 Usage Examples

Basic Usage

npx wikijs-mcp

📚 Documentation

Environment Variables

📄 License

This project is licensed under the MIT License.