BookStack

Provides tools to search BookStack pages and return structured, plain-text content via MCP.

typescript

9

GitHub Stars

typescript

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "yellowgg2-mcp-bookstack": {
      "command": "node",
      "args": [
        "/path/to/mcp-bookstack/build/app.js"
      ],
      "env": {
        "BOOKSTACK_API_KEY": "your_api_key",
        "BOOKSTACK_API_URL": "your_bookstack_url",
        "BOOKSTACK_API_TOKEN": "your_token"
      }
    }
  }
}

You can run a BookStack MCP Server to search BookStack pages and obtain structured, plain-text results that are easy to read and integrate into your workflows. This server connects to BookStack, converts HTML content to clean text, and returns titles, URLs, and page content in a consistent format.

How to use

You use an MCP client to interact with the BookStack MCP Server. The server exposes a tool named search_pages that lets you search for BookStack pages by a query and control which results you receive. Provide a query string to describe what you’re looking for, and specify pagination options to tailor the results to your needs. The output includes the page title, the page content converted to plain text, and the source URL.

How to install

Prerequisites you need before installing: Node.js and npm installed on your system.

Install the MCP server via Smithery to have Claude Desktop automatically manage the server.

npx -y @smithery/cli install @yellowgg2/mcp-bookstack --client claude

Manual installation steps

Clone the project repository.

git clone https://github.com/yellowgg2/mcp-bookstack.git
cd mcp-bookstack

Install dependencies.

npm install

Configure environment variables for BookStack access.

Create a .env file with your BookStack credentials.

BOOKSTACK_API_TOKEN=your_token
BOOKSTACK_API_URL=your_bookstack_url
BOOKSTACK_API_KEY=your_api_key

Start the server from your local build

Build the server and prepare it to run.

npm run build

Run the server using the MCP command configuration shown in the settings you apply to your MCP client.

Available tools

search_pages

Search BookStack pages with a query and pagination; returns page titles, URLs, and plain-text content.