BookStack MCP 服务器

通过模型上下文协议（MCP）将 BookStack 连接到 Claude 和其他 AI 助手。此服务器提供了对您的 BookStack 知识库的完全访问权限，包括 47 多种工具，涵盖了所有 API 端点。

✨ 您将获得

• 完整的 BookStack 集成 - 访问您所有的书籍、页面、章节和内容
• 47 多种 MCP 工具 - 对每个 BookStack 特性进行完整的 CRUD 操作
• 搜索与导出 - 查找内容并以多种格式导出
• 用户管理 - 处理用户、角色和权限
• 生产就绪 - 包括速率限制、验证、错误处理和日志记录

🚀 快速开始

# 全局安装
npm install -g bookstack-mcp-server

# 或直接运行
npx bookstack-mcp-server

添加到 Claude

# 对于 Claude Code
claude mcp add bookstack npx bookstack-mcp-server \
  --env BOOKSTACK_BASE_URL=https://your-bookstack.com/api \
  --env BOOKSTACK_API_TOKEN=token_id:token_secret

配置

设置这些环境变量：

export BOOKSTACK_BASE_URL="https://your-bookstack.com/api"
export BOOKSTACK_API_TOKEN="token_id:token_secret"

💡 令牌格式：将您的 BookStack 令牌 ID 和令牌密钥组合为 token_id:token_secret

💡 需要详细的设置？请参阅完整的 设置指南

🛠️ 可用工具

涵盖 13 类别的 47 多种工具：

• 📚 书籍 - 创建、读取、更新、删除和导出书籍
• 📄 页面 - 管理带有 HTML/Markdown 内容的页面
• 📑 章节 - 在书籍中组织页面
• 📚 架子 - 将书籍分组为集合
• 👥 用户与角色 - 完整的用户管理
• 🔍 搜索 - 跨所有内容的高级搜索
• 📎 附件与图片 - 文件管理
• 🔐 权限 - 内容访问控制
• 🗑️ 回收站 - 删除项恢复
• 📊 审计日志 - 活动跟踪
• ⚙️ 系统信息 - 实例健康和信息

📖 请参阅完整的 工具概述 获取详细文档

📚 文档

在 docs/ 文件夹中找到全面的指南：

• 设置指南 - 完整的安装和配置
• API 参考 - 所有端点及其示例
• 工具概述 - 每个工具的解释
• 资源指南 - 资源访问模式
• 示例与工作流 - 实际应用

⚡ 快速示例

列出所有书籍：

bookstack_books_list({ count: 10, sort: "updated_at" })

创建新页面：

bookstack_pages_create({
  name: "入门指南",
  book_id: 1,
  markdown: "# 欢迎\n您的内容在这里..."
})

搜索内容：

bookstack_search({ query: "API 文档", count: 20 })

🛠️ 开发

git clone <repository-url>
cd bookstack-mcp-server
npm install
npm run dev

🔧 请参阅 设置指南 获取开发、Docker 和生产部署的信息

📝 许可证

MIT 许可证 - 详情见 LICENSE 文件。

🌟 社区

本项目是 BookStack 生态系统的一部分！请查看 BookStack API 脚本 仓库中的其他基于 API 的工具和脚本。

🆘 支持

• 📚 文档：完整的指南在 docs/ 文件夹中
• 🐛 问题：GitHub 问题
• 💬 讨论：GitHub 讨论

---

为 BookStack 社区用心打造