BookStack MCP Server
Provides tools for searching pages within a BookStack instance, retrieving structured data such as titles, URLs, and content with clean HTML-to-text conversion.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@BookStack MCP Server search for the company onboarding guide"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
BookStack MCP Server
A Model Context Protocol (MCP) server that provides tools for searching pages from BookStack. This server interacts with the BookStack API and provides structured data for pages with clean HTML-to-text conversion.
Features
Search pages from BookStack with customizable queries
Get structured data including titles, URLs, and content
Configurable pagination (page number and count)
HTML-to-text conversion for clean content reading
Clean error handling and validation
Related MCP server: BookStack MCP Server
Installation
Installing via Smithery
To install mcp-bookstack for Claude Desktop automatically via Smithery:
npx -y @smithery/cli install @yellowgg2/mcp-bookstack --client claudeInstalling Manually
Clone the repository:
git clone https://github.com/yellowgg2/mcp-bookstack.git
cd mcp-bookstackInstall dependencies:
npm installConfigure your environment:
Create a .env file with your BookStack API credentials or provide them in the MCP settings configuration file:
BOOKSTACK_API_TOKEN=your_token
BOOKSTACK_API_URL=your_bookstack_url
BOOKSTACK_API_KEY=your_api_keyBuild the server:
npm run buildAdd to your MCP settings configuration file (location depends on your system):
For VSCode Claude extension:
{
"mcpServers": {
"bookstack": {
"command": "node",
"args": ["/path/to/mcp-bookstack/build/app.js"],
"env": {
"BOOKSTACK_API_URL": "your_bookstack_url",
"BOOKSTACK_API_TOKEN": "your_token",
"BOOKSTACK_API_KEY": "your_api_key"
}
}
}
}Usage
The server provides a tool called search_pages that can be used to search pages from BookStack.
Tool: search_pages
Parameters:
query(string): Query to search for pagesDefault: "" (empty string)
page(number): Page number to returnRange: 1-10
Default: 1
count(number): Number of pages to returnRange: 1-30
Default: 10
Example usage:
use_mcp_tool with:
server_name: "bookstack"
tool_name: "search_pages"
arguments: {
"query": "knowledge base",
"page": 1,
"count": 5
}Sample output:
# Page Title
Page content in plain text format...
Source: https://your-bookstack-url/page-urlIntegrating with Claude
To use this MCP server with Claude, you'll need to:
Have the Claude desktop app or VSCode Claude extension installed
Configure the MCP server in your settings
Use Claude's natural language interface to interact with BookStack
Configuration
For the Claude desktop app, VSCode Claude extension, and Cursor, add the server configuration to:
// ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)
// %APPDATA%\Claude\claude_desktop_config.json (Windows)
{
"mcpServers": {
"bookstack": {
"command": "node",
"args": ["/path/to/mcp-bookstack/build/app.js"],
"env": {
"BOOKSTACK_API_URL": "your_bookstack_url",
"BOOKSTACK_API_TOKEN": "your_token",
"BOOKSTACK_API_KEY": "your_api_key"
}
}
}
}Example Interactions
Once configured, you can interact with Claude using natural language to search BookStack pages. Examples:
"Search for documentation about API usage in our BookStack knowledge base"
"Find information about deployment in our internal docs"
"Look up security guidelines in BookStack"
Claude will automatically use the appropriate parameters to search for the pages you want.
Page Response Structure
Each page response includes:
Title of the page
Full content of the page (converted from HTML to plain text)
Source URL to the original page
The HTML-to-text conversion handles:
HTML entity decoding
Line breaks and paragraph formatting
List items with bullet points
Removal of HTML tags
Whitespace normalization
Development
The server is built using:
TypeScript
Model Context Protocol SDK
Axios for API requests
Zod for data validation
dotenv for environment configuration
To modify the server:
Make changes to
src/app.tsRebuild:
npm run buildError Handling
The server includes robust error handling for:
API connection failures
Authentication issues
Invalid parameter values
Data parsing errors
Errors are returned with appropriate error codes and descriptive messages.
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
MIT License - feel free to use this in your own projects.
Available Tools
1 toolsearch_pagesC
Search pages from Bookstack
Inputs: page, count, query.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 1 tool
With only one tool, there is no ambiguity between tools.
The single tool 'search_pages' follows a clear verb_noun pattern.
A BookStack server with only a search tool is severely under-scoped; typical usage requires CRUD operations on books, chapters, and pages.
The tool set lacks any creation, retrieval, update, or deletion capabilities, making it incomplete for the domain.
Maintenance
Related MCP Connectors
Find, write, publish and check pages and API references in your DeveloperHub docs from an AI client
Web search and page reading for AI agents, including JSON APIs, RSS feeds and YouTube.
Knowledge base MCP for AI agents on iknow.dev. Search, read, and maintain via OAuth.
Search your knowledge bases from any AI assistant using hybrid RAG.
Related MCP Servers
- AlicenseBqualityAmaintenanceEnables interaction with BookStack knowledge management systems through the BookStack API. Supports searching, reading, creating, and updating documentation content with secure authentication and dual transport modes for flexible deployment.17303 npm56MIT
- AlicenseBqualityDmaintenanceEnables AI models to interact with BookStack wiki instances through a comprehensive API interface. Supports content management (books, chapters, pages), user administration, search functionality, and content export in multiple formats.4110 npmMIT
- FlicenseNot gradedqualityDmaintenanceEnables AI assistants to manage BookStack documentation through natural language, supporting content browsing, search, and CRUD operations for books, chapters, and pages.-
- AlicenseBqualityBmaintenanceConnects BookStack knowledge bases to Claude through 47+ tools covering complete CRUD operations for books, pages, chapters, shelves, users, search, attachments, and permissions. Enables full management of BookStack content and configuration through natural language.56475 npm105MIT