YM

yellowgg2/mcp-bookstack

开发工具

本页由 AI 翻译,技术细节请以原文为准。 查看原文

10 stars 4 forks 质量 57 趋势 18

A Model Context Protocol (MCP) server that provides tools for searching pages from BookStack. This server interacts with the BookStack API and provides structured data for pages with clean...

概览

A Model Context Protocol (MCP) server that provides tools for searching pages from BookStack. This server interacts with the BookStack API and provides structured data for pages with clean HTML-to-text conversion. - Search pages from BookStack with customizable queries - Get structured data including titles, URLs, and content - Configurable pagination (page number and count) - HTML-to-text conversion for clean content reading - Clean error handling and validation To install mcp-bookstack for Claude Desktop automatically via Smithery: Create a .env file with your BookStack API credentials or provide them in the MCP settings configuration file: 5. Add to your MCP settings configuration file (location depends on your system): The server provides a tool called search_pages that can be used to search pages from BookStack.

README

以下为原文 README 节选,完整内容请查看原文。

BookStack MCP Server

A Model Context Protocol (MCP) server that provides tools for searching pages from BookStack. This server interacts with the BookStack API and provides structured data for pages with clean HTML-to-text conversion.

Features

  • Search pages from BookStack with customizable queries
  • Get structured data including titles, URLs, and content
  • Configurable pagination (page number and count)
  • HTML-to-text conversion for clean content reading
  • Clean error handling and validation

Installation

Installing via Smithery

To install mcp-bookstack for Claude Desktop automatically via Smithery:

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

Installing Manually

  1. Clone the repository:
git clone https://github.com/yellowgg2/mcp-bookstack.git
cd mcp-bookstack
  1. Install dependencies:
npm install
  1. Configure your environment:

Create a .env file with your BookStack API credentials or provide them in the MCP settings configuration file:

BOOKSTACK_API_TOKEN=your_token
BOOKSTACK_API_URL=your_bookstack_url
BOOKSTACK_API_KEY=your_api_key
  1. Build the server:
npm run build
  1. Add to your MCP settings configuration file (location depends on your system):

For VSCode Claude extension:

{
  "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"
      }
    }
  }
}

Usage

The server provides a tool called search_pages that can be used to search pages from BookStack.

Tool: search_pages

Parameters:

  • query (string): Query to search for pages
    • Default: “” (empty string)
  • page (number): Page number to return
    • Range: 1-10
    • Default: 1
  • count (number): Number of pages to return
    • Range: 1-30
    • Default: 10

Example usage:

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

Sample output:

# Page Title

Page content in plain text format...

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

Integrating with Claude

To use this MCP server with Claude, you’ll need to:

  1. Have the Claude desktop app or VSCode Claude extension installed
  2. Configure the MCP server in your settings
  3. Use Claude’s natural language interface to interact with BookStack

Configuration

For the Claude desktop app, VSCode Claude extension, and Cursor, add the server configuration to:

// ~/Library/Application Support/Claude/claude_desktop_config.json (macOS)
// %APPDATA%\Claude\claude_desktop_config.json (Windows)
{
在 GitHub 查看完整 README

安装

npx -y @smithery/cli install @yellowgg2/mcp-bookstack --client claude
新手?先看 mcpskill.org 教程 →

配置

{ "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" } } } }