New:Introducing Socket Scanning for VS Code Marketplace Extensions.Learn more →
Get Started

bookstack-mcp

Package Overview
Dependencies
Maintainers
1
Versions
18
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

bookstack-mcp

MCP server for BookStack wiki — search, read, create, and manage documentation via AI assistants

Source
npmnpm
Version
4.0.0
Version published
Weekly downloads
153
-86.36%
Maintainers
1
Weekly downloads
 
Created
Source

BookStack MCP Server

npm version npm downloads CI Node.js MCP License: MIT

bookstack-mcp

A Model Context Protocol (MCP) server that gives AI assistants full access to your BookStack documentation — search, read, create, and manage content.

npx bookstack-mcp

Features

  • 20 read-only tools + 18 write tools for complete BookStack API coverage
  • Books, chapters, pages, shelves, attachments, and comments — full CRUD
  • Recycle bin support — restore or permanently delete soft-deleted content
  • Type-safe input validation with Zod (auto-coerces string/number params for broad client compatibility)
  • Embedded URLs and content previews in all responses
  • Markdown export fallback for HTML-authored pages, so AI clients always get usable content
  • Token-efficient responses: compact JSON, no redundant fields, no N+1 fetches — ~30–55% smaller payloads than 3.x
  • Write operations disabled by default for safety
  • Works with Claude Desktop, Claude Code, LibreChat, and any MCP-compatible client
  • Stdio and Streamable HTTP transports

Quick Start

Install from npm

npx bookstack-mcp

Or clone and build

git clone https://github.com/ttpears/bookstack-mcp.git
cd bookstack-mcp
npm install && npm run build
npm start

Environment Variables

BOOKSTACK_BASE_URL=https://your-bookstack.com   # Required
BOOKSTACK_TOKEN_ID=your-token-id                # Required
BOOKSTACK_TOKEN_SECRET=your-token-secret        # Required
BOOKSTACK_ENABLE_WRITE=false                    # Optional, default false
BOOKSTACK_INSECURE_SKIP_TLS_VERIFY=false        # Optional, default false

Security warning: BOOKSTACK_INSECURE_SKIP_TLS_VERIFY=true disables TLS certificate verification for outgoing requests to BookStack. Use only for self-signed certs on a trusted LAN — connections become vulnerable to MITM attacks. The server logs a WARNING line at startup whenever this is enabled.

Client Configuration

Claude Desktop

The easiest install is the prebuilt MCPB bundle attached to each GitHub release:

  • Download bookstack-mcp-<version>.mcpb from the latest release.
  • Open Claude Desktop → Settings → Extensions and drag the .mcpb file in (or click Install Extension).
  • Fill in BookStack URL, API Token ID, and API Token Secret. Tokens are stored in your OS keychain. Leave Enable Write Operations as false for read-only access; set to true to enable create/update/delete tools.

Manual install (JSON config)

If you'd rather edit the config file directly:

{
  "mcpServers": {
    "bookstack": {
      "command": "npx",
      "args": ["-y", "bookstack-mcp"],
      "env": {
        "BOOKSTACK_BASE_URL": "https://your-bookstack.com",
        "BOOKSTACK_TOKEN_ID": "your-token-id",
        "BOOKSTACK_TOKEN_SECRET": "your-token-secret"
      }
    }
  }
}

LibreChat (stdio, single-user)

Add to your librechat.yaml:

mcpServers:
  bookstack:
    command: npx
    args:
      - -y
      - bookstack-mcp
    env:
      BOOKSTACK_BASE_URL: "https://your-bookstack.com"
      BOOKSTACK_TOKEN_ID: "your-token-id"
      BOOKSTACK_TOKEN_SECRET: "your-token-secret"

Run the server as a long-lived HTTP service and point LibreChat at the URL. This is the right setup for multi-user or containerized deployments.

Start the server in HTTP mode:

MCP_TRANSPORT=http \
MCP_HTTP_PORT=8080 \
BOOKSTACK_BASE_URL=https://your-bookstack.com \
BOOKSTACK_TOKEN_ID=your-token-id \
BOOKSTACK_TOKEN_SECRET=your-token-secret \
npx bookstack-mcp

Then configure LibreChat:

mcpServers:
  bookstack:
    type: streamable-http
    url: http://bookstack-mcp:8080/mcp

3.0.0 breaking change: the deprecated HTTP+SSE transport (GET /sse + POST /messages) has been removed. Streamable HTTP at /mcp already speaks SSE for streaming responses, and is the only HTTP transport in current MCP clients. If you're on an older client that needs the legacy endpoints, pin to bookstack-mcp@2.x.

HTTP transport environment variables

VariableDefaultDescription
MCP_TRANSPORTstdioSet to http to enable the HTTP server
MCP_HTTP_PORT8080Port to listen on
MCP_HTTP_HOST127.0.0.1Bind address. Loopback by default for safety
MCP_HTTP_ALLOWED_HOSTS(loopback only)Comma-separated allowlist of Host header hostnames for DNS rebinding protection. Required when binding to a non-loopback address
MCP_HTTP_PATH/mcpStreamable HTTP endpoint

When binding to 0.0.0.0 (e.g. inside a container reachable from other services), set MCP_HTTP_ALLOWED_HOSTS to the hostnames LibreChat will use to reach this server, e.g. MCP_HTTP_ALLOWED_HOSTS=bookstack-mcp,bookstack-mcp.internal.

Restart LibreChat after config changes.

Claude Code (CLI)

The recommended path is the ttpears/claude-plugins marketplace, which ships this repo's plugin manifest (.claude-plugin/plugin.json):

/plugin marketplace add ttpears/claude-plugins
/plugin install bookstack-mcp@ttpears-plugins

Then set the BOOKSTACK_* environment variables in your shell so the plugin's MCP server can authenticate:

export BOOKSTACK_BASE_URL=https://your-bookstack.com
export BOOKSTACK_TOKEN_ID=your-token-id
export BOOKSTACK_TOKEN_SECRET=your-token-secret

Manual install (alternative)

If you'd rather not use the marketplace, register the server directly with claude mcp add. Repeat --env for each variable, put all flags before the server name, and use -- to mark the start of the command Claude Code will spawn:

claude mcp add bookstack \
  --transport stdio \
  --scope user \
  --env BOOKSTACK_BASE_URL=https://your-bookstack.com \
  --env BOOKSTACK_TOKEN_ID=your-token-id \
  --env BOOKSTACK_TOKEN_SECRET=your-token-secret \
  -- npx -y bookstack-mcp

Scope picks where the entry is written:

ScopeWhere it livesShared via gitUse it when
local (default)~/.claude.json, scoped to the current projectNoTrying it out in one repo
user~/.claude.json, available in every projectNoYou want bookstack everywhere
project.mcp.json at the repo rootYesThe whole team should get it

The resulting config entry looks like this (in .mcp.json for project scope, or ~/.claude.json otherwise):

{
  "mcpServers": {
    "bookstack": {
      "type": "stdio",
      "command": "npx",
      "args": ["-y", "bookstack-mcp"],
      "env": {
        "BOOKSTACK_BASE_URL": "https://your-bookstack.com",
        "BOOKSTACK_TOKEN_ID": "your-token-id",
        "BOOKSTACK_TOKEN_SECRET": "your-token-secret"
      }
    }
  }
}

Tip for committed .mcp.json: Claude Code expands ${VAR} and ${VAR:-default} references in .mcp.json from the surrounding shell. Use that to keep secrets out of git: set "BOOKSTACK_TOKEN_SECRET": "${BOOKSTACK_TOKEN_SECRET}" in the file and have each developer export the variable in their shell.

MCP Resources

Books and pages are also exposed as MCP resources, so clients that browse resources (Claude Desktop, MCP Inspector, etc.) can @-mention them directly:

URI templateDescription
bookstack://book/{id}A book, returned as JSON metadata
bookstack://page/{id}A page, returned as markdown plus a JSON metadata blob

Both templates support id autocompletion: as you type, the server searches BookStack and returns matching IDs so you don't have to remember numeric IDs by hand.

4.0.0 breaking changes: tool responses were trimmed for token efficiency. Removed fields: direct_link, *_friendly date strings, content_info, contextual_info, change_summary, pagination_hint, location, summary/tags_summary/book_count on shelves, and the buggy page_url on attachments. Use url, the ISO date fields, and download_url instead. The get_capabilities tool was removed — clients should use tools/list (built into MCP). Responses are now compact JSON (no pretty-printing) and get_recent_changes no longer issues per-result fetches.

Available Tools

Read Operations (always available)

ToolDescription
search_contentSearch across all content with filtering
search_pagesSearch pages with optional book filtering
get_books / get_bookList or get details of books
get_pages / get_pageList or get full page content
get_chapters / get_chapterList or get chapter details
get_shelves / get_shelfList or get shelf details
get_attachments / get_attachmentList or get attachment details
get_comments / get_commentList or get page comments (BookStack v25.11+)
find_usersLook up BookStack users by name, email, or slug to resolve numeric user IDs for search filters
get_recycle_binList items in the recycle bin
export_pageExport page as HTML, PDF, Markdown, plaintext, or ZIP
export_bookExport entire book
export_chapterExport chapter
get_recent_changesRecently updated content

Write Operations (requires BOOKSTACK_ENABLE_WRITE=true)

ToolDescription
create_book / delete_bookCreate or delete a book
create_chapter / delete_chapterCreate or delete a chapter
create_pageCreate a new page (HTML or Markdown)
update_pageUpdate content, rename, or move to a different book/chapter
delete_pageDelete a page (recoverable from recycle bin)
create_shelf / update_shelf / delete_shelfManage shelves
create_attachment / update_attachment / delete_attachmentManage attachments
create_comment / update_comment / delete_commentManage page comments (v25.11+)
restore_deleted / permanently_deleteRestore or permanently destroy items in the recycle bin

BookStack API Setup

  • Log into BookStack as an admin
  • Go to Settings > Users > Edit your user
  • Ensure the user has Access System API permission
  • In the API Tokens section, create a new token
  • Copy the Token ID and Token Secret

Security

  • Write operations are disabled by default
  • Use HTTPS for production instances
  • Store API tokens securely (never commit to git)
  • Consider a dedicated BookStack user with limited permissions

Development

npm run dev          # Hot reload with tsx
npm run type-check   # Type checking only
npm run build        # Production build

License

MIT

Keywords

mcp

FAQs

Package last updated on 23 May 2026

Related posts