PmWiki

You can connect an LLM to your PmWiki instance using the MCP (Model Context Protocol) server. This server exposes your wiki content and actions over a lightweight transport, enabling an AI to read pages, search content, and interact with your wiki in real time through SSE-based communication.

How to use

To use the MCP server, connect your MCP client to the SSE endpoint exposed by the server. The primary transport is Server-Sent Events (SSE), which establishes a bidirectional stream for messages between the LLM and your PmWiki instance.

How to install

Prerequisites you need before starting: Docker and Docker Compose installed on the host machine. A PmWiki wiki directory on the host that you want to expose to the MCP server.

Option A: Run using Docker Compose (Docker Hub image)

docker compose up -d

Option B: Build and run with Docker Compose locally

1. Edit the Docker Compose file to enable the local build (comment the existing image line and uncomment the build line)

docker compose up -d --build

Option C: Run a direct Docker container without Compose

docker run -d \
  --name pmwiki-mcp-server \
  -p 3000:3000 \
  -v /path/to/your/wiki.d:/wiki_data:ro \
  -e WIKI_DIR=/wiki_data \
  kcofoni/pmwiki-mcp:latest

Verify the server is running and accessible at the standard URL. You can also test the SSE endpoint directly.

Additional startup notes

After starting, you can verify by inspecting logs and ensuring the port is open. The server exposes its MCP SSE endpoint at the /sse path.

Available tools

search_wiki

Search text across all wiki pages with optional case sensitivity.

read_page

Read the complete content of a single wiki page.

list_pages

List all wiki pages, with optional filtering by group.