功能描述

BookStack Wiki & Documentation API integration. Manage your knowledge base programmatically: create, read, update, and delete books, chapters, pages, and shelves. Full-text search across all content. Use when you need to: (1) Create or edit wiki pages and documentation, (2) Organize content in books and chapters, (3) Search your knowledge base, (4) Automate documentation workflows, (5) Sync content between systems. Supports both HTML and Markdown content.

使用说明 (SKILL.md)

BookStack Skill

Name: BookStack
Author: xenofex7

BookStack is an open-source wiki and documentation platform. This skill lets you manage your entire knowledge base via API – perfect for automation and integration.

Features

📚 Books – create, edit, delete
📑 Chapters – organize content within books
📄 Pages – create/edit with HTML or Markdown
🔍 Full-text search – search across all content
📁 Shelves – organize books into collections

Quick Start

# List all books
python3 scripts/bookstack.py list_books

# Search the knowledge base
python3 scripts/bookstack.py search "Home Assistant"

# Get a page
python3 scripts/bookstack.py get_page 123

# Create a new page (Markdown)
python3 scripts/bookstack.py create_page --book-id 1 --name "My Page" --markdown "# Title\
\
Content here..."

All Commands

Books

python3 scripts/bookstack.py list_books                    # List all books
python3 scripts/bookstack.py get_book \x3Cid>                 # Book details
python3 scripts/bookstack.py create_book "Name" ["Desc"]   # New book
python3 scripts/bookstack.py update_book \x3Cid> [--name] [--description]
python3 scripts/bookstack.py delete_book \x3Cid>

Chapters

python3 scripts/bookstack.py list_chapters                 # List all chapters
python3 scripts/bookstack.py get_chapter \x3Cid>              # Chapter details
python3 scripts/bookstack.py create_chapter --book-id \x3Cid> --name "Name"
python3 scripts/bookstack.py update_chapter \x3Cid> [--name] [--description]
python3 scripts/bookstack.py delete_chapter \x3Cid>

Pages

python3 scripts/bookstack.py list_pages                    # List all pages
python3 scripts/bookstack.py get_page \x3Cid>                 # Page preview
python3 scripts/bookstack.py get_page \x3Cid> --content       # With HTML content
python3 scripts/bookstack.py get_page \x3Cid> --markdown      # As Markdown

# Create page (in book or chapter)
python3 scripts/bookstack.py create_page --book-id \x3Cid> --name "Name" --markdown "# Content"
python3 scripts/bookstack.py create_page --chapter-id \x3Cid> --name "Name" --html "\x3Cp>HTML\x3C/p>"

# Edit page
python3 scripts/bookstack.py update_page \x3Cid> [--name] [--content] [--markdown]
python3 scripts/bookstack.py delete_page \x3Cid>

Search

python3 scripts/bookstack.py search "query"                # Search everything
python3 scripts/bookstack.py search "query" --type page    # Pages only
python3 scripts/bookstack.py search "query" --type book    # Books only

Shelves

python3 scripts/bookstack.py list_shelves                  # List all shelves
python3 scripts/bookstack.py get_shelf \x3Cid>                # Shelf details
python3 scripts/bookstack.py create_shelf "Name" ["Desc"]  # New shelf

Configuration

Set the following environment variables:

export BOOKSTACK_URL="https://your-bookstack.example.com"
export BOOKSTACK_TOKEN_ID="your-token-id"
export BOOKSTACK_TOKEN_SECRET="your-token-secret"

Or configure via your gateway config file under skills.entries.bookstack.env.

Create an API Token

Log in to your BookStack instance
Go to Edit Profile → API Tokens
Click Create Token
Copy the Token ID and Secret

⚠️ The user needs a role with "Access System API" permission!

API Reference

Base URL: {BOOKSTACK_URL}/api
Auth Header: Authorization: Token {ID}:{SECRET}
Official Docs: https://demo.bookstackapp.com/api/docs

Author: xenofex7 | Version: 1.0.2

安全使用建议

This skill appears to do what it claims — manage BookStack content. Before installing: (1) verify the skill source/owner since homepage is unknown, (2) only provide BookStack tokens that have the minimal required permissions (rotate or revoke if you stop using the skill), (3) ensure BOOKSTACK_URL points to a trusted instance, and (4) if you run this from an autonomous agent, be aware that the script uses sys.exit() on errors which can terminate the invoking process. If you need higher assurance, review the full scripts/bookstack.py file included in the package line-by-line (it is small and self-contained).

功能分析

Type: OpenClaw Skill Name: bookstack Version: 1.0.3 The skill provides a straightforward API integration for BookStack, allowing CRUD operations on books, chapters, pages, and shelves. It correctly retrieves API credentials (BOOKSTACK_URL, BOOKSTACK_TOKEN_ID, BOOKSTACK_TOKEN_SECRET) from environment variables, which is necessary for its stated purpose. The `SKILL.md` file contains standard documentation and usage examples without any prompt injection attempts or instructions for the agent to perform unauthorized actions. The `scripts/bookstack.py` code is a clean Python script using `urllib.request` for API calls, and it does not contain any evidence of data exfiltration (beyond using the provided BookStack credentials for authentication), malicious execution, persistence mechanisms, or obfuscation. While the skill can create/update content with user-provided HTML/Markdown, this is its intended function as an API client, and any misuse would stem from a prompt injection against the agent, not from malicious intent within the skill itself.

能力评估

✓ Purpose & Capability

The name/description match the included Python script and SKILL.md. The skill requires only BOOKSTACK_URL, BOOKSTACK_TOKEN_ID, and BOOKSTACK_TOKEN_SECRET and the script uses those to call BookStack's API endpoints (books, chapters, pages, shelves, search). There are no unrelated dependencies or surprising capabilities.

ℹ Instruction Scope

SKILL.md instructs running the included CLI script with commands that map directly to BookStack API operations. The runtime code only reads the declared BOOKSTACK_* environment variables and performs HTTP requests to the configured BOOKSTACK_URL. Minor note: the script frequently calls sys.exit() on errors or missing env vars which will terminate the CLI/agent process when errors occur — this is expected for a CLI tool but worth knowing if the skill is invoked by an agent expecting finer-grained error handling.

✓ Install Mechanism

No install spec — the skill ships a Python script and SKILL.md. No remote downloads or package installs are requested, so nothing arbitrary is written to disk during installation beyond the existing skill files.

✓ Credentials

The three required env vars directly correspond to authenticating with BookStack's API. The number and type of credentials are proportionate. As a precaution, tokens grant API access so users should provide a token with minimal necessary permissions and only to a trusted BookStack instance.

✓ Persistence & Privilege

always is false and the skill does not request persistent system-wide permissions or modify other skills' configurations. It does not claim or require any elevated or platform-wide privilege.

版本历史

v1.0.3

Added required env vars to metadata for security scan compliance

v1.0.2

Docs translated to English, removed internal references, generic configuration examples

v1.0.1

Improved documentation: German descriptions, detailed command examples, setup guide

v1.0.0

Initial release: Full CRUD for books, chapters, pages, shelves + search

元数据

Slug bookstack

版本 1.0.3

许可证 —

累计安装 2

当前安装数 2

历史版本数 4

常见问题

BookStack 是什么？

BookStack Wiki & Documentation API integration. Manage your knowledge base programmatically: create, read, update, and delete books, chapters, pages, and shelves. Full-text search across all content. Use when you need to: (1) Create or edit wiki pages and documentation, (2) Organize content in books and chapters, (3) Search your knowledge base, (4) Automate documentation workflows, (5) Sync content between systems. Supports both HTML and Markdown content. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件，目前累计下载 2763 次。

如何安装 BookStack？

在 OpenClaw 或 Claude Code 对话框中运行命令「/install bookstack」即可一键安装，无需额外配置。

BookStack 是免费的吗？

是的，BookStack 完全免费（开源免费），可自由下载、安装和使用。

BookStack 支持哪些平台？

BookStack 跨平台运行，可在任意部署了 OpenClaw / Claude Code 的环境中使用（cross-platform）。

谁开发了 BookStack？

由 xenofex7（@xenofex7）开发并维护，当前版本 v1.0.3。

BookStack