MCP Bookstack

BookStack MCP服务器

一种模型上下文协议（MCP）服务器，提供从BookStack搜索页面的工具。该服务器与BookStack API交互，并为具有清晰HTML到文本转换的页面提供结构化数据。

特性

• 使用可自定义的查询从BookStack搜索页面
• 获取结构化数据，包括标题、URL和内容
• 可配置分页（页码和计数）
• HTML到文本的转换，用于干净的内容阅读
• 干净的错误处理和验证

安装

通过Smithery安装

通过以下方式自动安装Claude Desktop的mcp书架 史密瑟里:

npx -y @smithery/cli install @yellowgg2/mcp-bookstack --client claude

手动安装

1. 克隆存储库：

git clone https://github.com/yellowgg2/mcp-bookstack.git
cd mcp-bookstack

1. 安装依赖项：

npm install

1. 配置您的环境：

创建一个 .env 使用BookStack API凭证提交文件，或在MCP设置配置文件中提供这些凭证：

BOOKSTACK_API_TOKEN=your_token
BOOKSTACK_API_URL=your_bookstack_url
BOOKSTACK_API_KEY=your_api_key

1. 构建服务器：

npm run build

1. 添加到MCP设置配置文件中（位置取决于您的系统）：

对于VSCode Claude扩展：

{
  "mcpServers": {
    "bookstack": {
      "command": "node",
      "args": ["/path/to/mcp-bookstack/build/app.js"],
      "env": {
        "BOOKSTACK_API_URL": "your_bookstack_url",
        "BOOKSTACK_API_TOKEN": "your_token",
        "BOOKSTACK_API_KEY": "your_api_key"
      }
    }
  }
}

用法

服务器提供了一个名为 search_pages 可用于从BookStack中搜索页面。

工具：搜索页面

参数：

• query （string）：查询以搜索页面

- 默认值：“”（空字符串）

• page （number）：返回页码

- 范围：1-10 - 默认值：1

• count （number）：要返回的页数

- 范围：1-30 - 默认值：10

示例用法：

use_mcp_tool with:
server_name: "bookstack"
tool_name: "search_pages"
arguments: {
  "query": "knowledge base",
  "page": 1,
  "count": 5
}

样本输出：

# Page Title

Page content in plain text format...

Source: https://your-bookstack-url/page-url

与克劳德融合

要将此MCP服务器与Claude一起使用，您需要：

1. 安装Claude桌面应用程序或VSCode Claude扩展程序
2. 在您的设置中配置MCP服务器
3. 使用Claude的自然语言界面与BookStack交互

配置

对于Claude桌面应用程序、VSCode Claude扩展和Cursor，将服务器配置添加到：

// ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)
// %APPDATA%\Claude\claude_desktop_config.json (Windows)
{
  "mcpServers": {
    "bookstack": {
      "command": "node",
      "args": ["/path/to/mcp-bookstack/build/app.js"],
      "env": {
        "BOOKSTACK_API_URL": "your_bookstack_url",
        "BOOKSTACK_API_TOKEN": "your_token",
        "BOOKSTACK_API_KEY": "your_api_key"
      }
    }
  }
}

交互示例

配置后，您可以使用自然语言与Claude交互以搜索BookStack页面。示例：

• “在我们的BookStack知识库中搜索有关API使用的文档”
• “在我们的内部文档中查找有关部署的信息”
• “在BookStack中查找安全指南”

Claude将自动使用适当的参数来搜索您想要的页面。

页面响应结构

每个页面响应包括：

• 页面标题
• 页面的全部内容（从HTML转换为纯文本）
• 原始页面的源URL

HTML到文本的转换处理：

• HTML实体解码
• 换行符和段落格式
• 列出带有要点的项目
• 删除HTML标签
• 空白归一化

发展

服务器是使用以下方式构建的：

• TypeScript
• 模型上下文协议SDK
• 适用于API请求的Axios
• Zod用于数据验证
• 用于环境配置的dotenv

要修改服务器，请执行以下操作：

1. 对以下内容进行更改 src/app.ts
2. 重建：

npm run build

错误处理

该服务器包括强大的错误处理功能，用于：

• API连接失败
• 身份验证问题
• 参数值无效
• 数据分析错误

错误将返回相应的错误代码和描述性消息。

贡献

欢迎投稿！请随时提交拉取请求。

许可证

MIT许可证-您可以在自己的项目中自由使用。