Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| BOOKSTACK_BASE_URL | Yes | The base URL of your BookStack API (e.g., https://your-bookstack.com/api) | |
| BOOKSTACK_API_TOKEN | Yes | Your BookStack API token in the format token_id:token_secret |
Capabilities
Features and capabilities supported by this server
| Capability | Details |
|---|---|
| tools | {} |
| logging | {} |
| resources | {} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| bookstack_books_list | List all books visible to the authenticated user with pagination and filtering options. Books are the top-level containers in BookStack hierarchy. |
| bookstack_books_create | Create a new book with name, description, tags, and template settings |
| bookstack_books_read | Get details of a specific book including its complete content hierarchy (chapters and pages) |
| bookstack_books_update | Update a book's details including name, description, tags, and template settings |
| bookstack_books_delete | Delete a book (moves to recycle bin where it can be restored) |
| bookstack_books_export | Export a book in various formats (HTML, PDF, plain text, or Markdown) |
| bookstack_pages_list | List all pages visible to the authenticated user with pagination and filtering options |
| bookstack_pages_create | Create a new page with content in HTML or Markdown format |
| bookstack_pages_read | Get details of a specific page including its full content in HTML and Markdown formats |
| bookstack_pages_update | Update a page's details and content, including moving between books/chapters |
| bookstack_pages_delete | Delete a page (moves to recycle bin where it can be restored) |
| bookstack_pages_export | Export a page in various formats (HTML, PDF, plain text, or Markdown) |
| bookstack_chapters_list | List all chapters visible to the authenticated user with pagination and filtering options. Chapters are organizational containers within books. |
| bookstack_chapters_create | Create a new chapter within a book with name, description, tags, and priority settings |
| bookstack_chapters_read | Get details of a specific chapter including all its pages and complete structure |
| bookstack_chapters_update | Update a chapter's details including name, description, tags, and priority |
| bookstack_chapters_delete | Delete a chapter and all its pages (moves to recycle bin where it can be restored) |
| bookstack_chapters_export | Export a chapter and all its pages in various formats (HTML, PDF, plain text, or Markdown) |
| bookstack_shelves_list | List all bookshelves visible to the authenticated user with pagination and filtering options. Shelves organize books into collections. |
| bookstack_shelves_create | Create a new bookshelf with name, description, and tags |
| bookstack_shelves_read | Get details of a specific bookshelf including all its books and their structure |
| bookstack_shelves_update | Update a bookshelf's details including name, description, tags, and book collection |
| bookstack_shelves_delete | Delete a bookshelf (books are not deleted, only removed from the shelf) |
| bookstack_users_list | List all users in the system with pagination and filtering options |
| bookstack_users_create | Create a new user account with email, name, and role assignments |
| bookstack_users_read | Get details of a specific user including their roles and permissions |
| bookstack_users_update | Update a user's details including name, email, password, and role assignments |
| bookstack_users_delete | Delete a user account with option to migrate content ownership to another user |
| bookstack_roles_list | List all roles in the system with pagination and filtering options |
| bookstack_roles_create | Create a new role with display name, description, and permission settings |
| bookstack_roles_read | Get details of a specific role including all its permissions and settings |
| bookstack_roles_update | Update a role's details including name, description, and permission settings |
| bookstack_roles_delete | Delete a role with option to migrate users to another role |
| bookstack_attachments_list | List all attachments visible to the authenticated user with pagination and filtering options |
| bookstack_attachments_create | Create a new attachment by uploading a file or linking to an external URL |
| bookstack_attachments_read | Get details of a specific attachment including download URL and metadata |
| bookstack_attachments_update | Update an attachment's details such as name or replace the file content |
| bookstack_attachments_delete | Delete an attachment permanently (this action cannot be undone) |
| bookstack_images_list | List all images in the gallery with pagination and filtering options |
| bookstack_images_create | Create a new image by uploading an image file to the gallery |
| bookstack_images_read | Get details of a specific image including URLs and metadata |
| bookstack_images_update | Update an image's details such as name or replace the image content |
| bookstack_images_delete | Delete an image permanently from the gallery (this action cannot be undone) |
| bookstack_search | Search across all content types in BookStack using advanced search syntax |
| bookstack_recycle_bin_list | List all deleted items in the recycle bin with pagination options |
| bookstack_recycle_bin_restore | Restore a deleted item from the recycle bin back to its original location |
| bookstack_recycle_bin_delete_permanently | Permanently delete an item from the recycle bin (this action cannot be undone) |
| bookstack_permissions_read | Get permission settings for specific content (books, chapters, pages, or shelves) |
| bookstack_permissions_update | Update permission settings for specific content to control user and role access |
| bookstack_audit_log_list | List audit log entries to track system activities and user actions |
| bookstack_system_info | Get comprehensive system information about the BookStack instance |
| bookstack_server_info | Get comprehensive server information including capabilities, tools, resources, and usage guidance for LLM interaction |
| bookstack_tool_categories | Get detailed information about tool categories and their specific use cases |
| bookstack_usage_examples | Get step-by-step workflow examples for common BookStack operations |
| bookstack_error_guides | Get comprehensive error handling information and troubleshooting guides |
| bookstack_help | Interactive help system providing contextual guidance for LLM tool usage |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| Books | All books in the BookStack instance with complete metadata and hierarchical structure |
| Book | Specific book with full content hierarchy including all chapters and pages |
| Pages | All pages in the BookStack instance |
| Page | Specific page with full content |
| Chapters | All chapters in the BookStack instance |
| Chapter | Specific chapter with pages |
| Shelves | All bookshelves in the BookStack instance |
| Shelf | Specific bookshelf with books |
| Users | All users in the BookStack instance |
| User | Specific user with roles |
| Search | Search results for a specific query |