- Home
- MCP servers
- BookStack
BookStack
- typescript
3
GitHub Stars
typescript
Language
6 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": {
"ttpears-bookstack-mcp": {
"command": "node",
"args": [
"/path/to/bookstack-mcp/dist/index.js"
],
"env": {
"BOOKSTACK_BASE_URL": "https://your-bookstack.com",
"BOOKSTACK_TOKEN_ID": "your-token-id",
"BOOKSTACK_ENABLE_WRITE": "false",
"BOOKSTACK_TOKEN_SECRET": "your-token-secret"
}
}
}
}You deploy a BookStack MCP Server to give AI assistants secure, read-only access to your BookStack documentation and data, while enabling write operations only when you explicitly allow them. This server integrates with clients that support the MCP protocol, exposing BookStack capabilities through a robust, type-safe interface and clickable links to your BookStack pages for easy navigation.
How to use
You interact with the server through an MCP client by selecting the available read and write operations that the server exposes. Start from the read-only set to explore content such as books, pages, chapters, shelves, and attachments. If you enable writes, you can create or update content while keeping security controls in place. Each response includes direct links to BookStack pages, readable previews, and contextual information to help you understand where the content lives within BookStack.
How to install
Prerequisites include Node.js 18 or newer and access to a BookStack instance with API permissions and a valid API token.
Step by step you can follow these commands to set up the MCP server locally and run it.
Configuration and usage details
The server supports local usage via a standard stdio transport and can be integrated with clients like Claude Desktop or LibreChat. You configure the server’s BookStack connection by supplying the base URL and API credentials, and you can toggle write capabilities with a simple flag.
Security considerations
Write operations are disabled by default to protect your BookStack data. Enable writes only if you trust the AI with your content. Always use HTTPS for production BookStack instances and store API tokens securely, rotating them regularly.
Development and project structure
Develop locally with hot reload, perform type checks, and build for production. The project organizes the MCP server logic, a BookStack API wrapper, and tooling in a clear file structure.
Troubleshooting
Common issues include connectivity problems with the BookStack API, misconfigured environment variables, or tools not appearing after configuration changes. Check logs for error messages and ensure your BookStack API user has the correct permissions.
Available tools
get_capabilities
Show current server capabilities and supported operations
search_content
Perform advanced content searches with filters and pagination
search_pages
Search specifically for pages with book filtering
get_books
List books with filtering and sorting options
get_book
Get detailed information about a specific book
get_pages
List pages with previews and context
get_page
Get full content of a specific page
get_chapters
List chapters with filtering
get_chapter
Get details of a specific chapter
get_shelves
List book shelves (collections)
get_shelf
Get shelf details with all books
get_attachments
List attachments with filtering
get_attachment
Get attachment details
export_page
Export pages in various formats
export_book
Export entire books
export_chapter
Export chapters
get_recent_changes
Get recently updated content
create_page
Create new pages (write operation)
update_page
Update existing pages (write operation)
create_shelf
Create new shelves (write operation)
update_shelf
Update existing shelves (write operation)
delete_shelf
Delete shelves (write operation)
create_attachment
Create link attachments (write operation)
update_attachment
Update attachments (write operation)
delete_attachment
Delete attachments (write operation)