ToolBooks help

Guides for reading ToolBooks, publishing as an author, and connecting AI tools.

For readers

Add a ToolBook

Open a ToolBook from the catalog and add it to your library. Your library keeps the books you can read and connect to AI clients.

Read chapters

Open a ToolBook from your library, then choose a chapter. Authors and collaborators can preview draft content from the same pages.

Connect an AI client

Use the Setup link on a ToolBook you have added. It provides the MCP URL and client-specific instructions.

Sign-in problems

Sign-in links and one-time codes are delivered by email. Check spam, request a fresh code, and make sure you use the same email address.

For authors

Create and publish

Set up your author profile, create a ToolBook draft, add a 2:3 cover, chapters, skills, and resources, then publish it for admin review.

Draft safety

Edits stay in the draft until you promote or publish it. Reset draft discards unpublished changes and rebuilds the draft from the currently published version.

API tokens

Create a named token from Author Console → API Tokens. Store it as a CI secret, send it as a Bearer token, and never commit it to the repository.

Publish chapters from GitHub Actions or CI

For a full chapter replacement, clear the draft's chapters, upload every Markdown file, and only then promote the completed draft. If any upload fails, the final promote step does not run and readers keep the previous published version.

DELETE /toolbooks/{slug}/chapters to clear the draft chapter set while leaving its skills and resources alone.
POST each Markdown file to /toolbooks/{slug}/chapters/{chapterSlug} with Content-Type: text/markdown. The path accepts names such as 01-preface, 01-preface.md, and 01_preface.md.
The slug supplies the chapter number. Frontmatter name supplies the title, otherwise the first H1, then the number-less slug; frontmatter description supplies the optional summary.
Optionally POST /toolbooks/{slug}/versions/promote after every upload succeeds. The first release may use /toolbooks/{slug}/publish; a cover is required.

Chapter Markdown format

The path slug must begin with a positive chapter number. Both 01-preface.md and 01_preface.md are accepted and stored as canonical slug 01-preface; leading zeroes are preserved in the slug while the chapter number is 1.
YAML frontmatter is optional. name sets the chapter title and description sets the optional summary.
Without frontmatter name, the first # Title heading is used; without either, the number-less filename slug becomes a human-readable title. Without description, the summary remains empty.
Frontmatter is metadata and is removed from the stored chapter body. The remaining Markdown body must not be empty.

---
name: Preface
description: Why this ToolBook exists.
---
# Preface

Chapter content starts here.

# GitHub Actions step; chapter files are named like 01-preface.md
set -euo pipefail
auth=(-H "Authorization: Bearer $TOOLBOOK_API_TOKEN")
base="https://api.mytoolbook.ai/toolbooks/$TOOLBOOK_SLUG"

curl --fail-with-body -X DELETE "${auth[@]}" "$base/chapters"
for chapter in chapters/*.md; do
  filename="${chapter##*/}"
  chapter_slug="$filename"
  curl --fail-with-body -X POST "${auth[@]}" \
    -H 'Content-Type: text/markdown' --data-binary "@$chapter" \
    "$base/chapters/$chapter_slug"
done
# Remove this line when the pipeline should update only the draft.
curl --fail-with-body -X POST "${auth[@]}" "$base/versions/promote"

The API URL in this example is already configured for this ToolBooks deployment. Set TOOLBOOK_SLUG as a repository variable and TOOLBOOK_API_TOKEN as an encrypted Actions secret. The workflow needs only curl; no JSON generation or jq step is required.

Still need help?

Send a support request without signing in. You can include a screenshot.

Contact support →