fork

Ricardo Cenci Fabris 206356b7a9 Update LICENSE hace 1 año
src 2d7894e74d feat: mcp initial commit hace 1 año
.gitignore 2d7894e74d feat: mcp initial commit hace 1 año
LICENSE 206356b7a9 Update LICENSE hace 1 año
Makefile 2d7894e74d feat: mcp initial commit hace 1 año
README.md 203e0f7477 fix: typo in the mcpServer configuration hace 1 año
codegen.yml 2d7894e74d feat: mcp initial commit hace 1 año
docker-compose.yml 8d392e11bd chore: removing unnecessary docker container hace 1 año
env.example 2d7894e74d feat: mcp initial commit hace 1 año
package-lock.json 2d7894e74d feat: mcp initial commit hace 1 año
package.json dd8abe8e1a feat: licensing under MIT hace 1 año
tsconfig.json 2d7894e74d feat: mcp initial commit hace 1 año

README.md

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

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

Development

  1. Clone the repository:

    git clone https://github.com/RicardoCenci/wikijs-mcp.git
    cd wikijs-mcp
    
    1. Install dependencies: bash npm install
  2. Copy the environment template and fill out its contents

    cp env.example .env
    
    1. Build the project If you have make installed: bash make build
  3. 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.