BookStack

You have an MCP server that provides a full interface to the BookStack API, enabling your AI models to generate and edit wiki content through BookStack. It exposes content management, search, user and permission handling, media resources, and multi-format exports, all accessible to MCP clients.

How to use

Use this MCP server with an MCP client to manage books, chapters, pages, and shelves in BookStack, perform global searches, manage users and roles, handle attachments and images, and export content in multiple formats. You interact with the server by calling its tools from your client, enabling workflows like creating a new book, drafting a page with Markdown, organizing books into shelves, and exporting sections as HTML, PDF, plain text, or Markdown.

How to install

Prerequisites you need before installing: Node.js 18 or newer, a running BookStack instance, and a BookStack API token. You will install dependencies, configure environment variables, and build the server before starting it.

# Step 1: Install dependencies
npm install

# Step 2: Configure environment variables (adjust values to your setup)
export BOOKSTACK_BASE_URL="https://your-bookstack.example.com"
export BOOKSTACK_TOKEN_ID="your_token_id"
export BOOKSTACK_TOKEN="your_token_secret"

# Step 3: Build the project
npm run build

Start the server after building. You can run in development or use the compiled index directly.

# Start the MCP server in development (if applicable)
npm start

# Or run the compiled server directly from the build output
node build/index.js

Additional installation notes

Environment variables required by the server include the BookStack base URL and API credentials. These values are used by the server to authenticate with BookStack and route requests.

Security and maintenance

All operations require a valid BookStack API token. Permissions are managed through BookStack roles. Input validation uses a robust schema system to prevent invalid data from being processed. Handle tokens securely and rotate them as needed.

Development and contributing

If you plan to contribute, ensure your changes are tested and follow the project’s structure for TypeScript sources, utilities, and tools. Build and run locally to verify behavior before submitting changes.

Available tools

list_books

List all books in BookStack.

get_book

Retrieve details for a specific book.

create_book

Create a new book with metadata and tags.

update_book

Update an existing book's properties.

delete_book

Remove a book from BookStack.

export_book

Export a book in HTML, PDF, plain text, or Markdown.

list_chapters

List chapters within a book.

get_chapter

Get details of a chapter.

create_chapter

Create a new chapter within a book.

update_chapter

Update a chapter.

delete_chapter

Delete a chapter.

export_chapter

Export a chapter.

list_pages

List pages in a book or chapter.

get_page

Get content of a page.

create_page

Create a new page with HTML or Markdown content.

update_page

Update page content.

delete_page

Delete a page.

export_page

Export a page.

list_shelves

List content shelves.

get_shelf

Get details of a shelf.

create_shelf

Create a new shelf.

update_shelf

Update a shelf.

delete_shelf

Delete a shelf.

search_all

Search across all BookStack content.

list_users

List BookStack users.

get_user

Retrieve user details.

create_user

Create a new user.

update_user

Update user details.

delete_user

Delete a user.

list_roles

List roles in BookStack.

get_role

Get role details.

create_role

Create a new role.

update_role

Update a role.

delete_role

Delete a role.

list_attachments

List attachments.

get_attachment

Get attachment details.

delete_attachment

Delete an attachment.

list_images

List images.

get_image

Get image details.

update_image

Update an image.

delete_image

Delete an image.