tcsenpai/mcpbook

开发工具

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

19 stars 7 forks 质量 67 趋势 22MIT

Repository Install

一个MCP(模式上下文协议)服务器,为AI助手曝光文档站点内容. 这个服务器刮出并索引了GitBook和其他网站文档,使其可以搜索和.

概览

一个高性能的MCP(Model Context Protocol)服务器,可转换为AI可访问的知识库. 最初是为GitBook而建,但与功能即时起动,智能缓存,自动域检测. - SQLite以子秒服务器初始化存储 - - FTS5 以模糊的匹配和排名进行全文搜索 - - 自动检测域名,关键词,和品牌 - - - 以语法高亮代码块格式化的保温器 - - 非屏蔽变化检测和缓存更新 - - 与 GitBook, Vercel Docs, Next.

概述（AI 翻译）

一个高性能的MCP(模式上下文协议)服务器,将任何文件网站转换为AI可访问的知识库. 最初是为GitBook而建,但与Vercel docs,Next.js站点,Docusaurus和许多其他文档平台合作. 功能即时起动,智能缓存,自动域检测.

# # 关键特性

QQ 即时启动** - SQLite 存储,并使用子秒服务器初始化
QQ 高级搜索** - FTS5 全文搜索,并进行模糊的匹配和排名
智能自动检测** - 自动检测域名、关键词和品牌
Markdown Perfect** - 用语法高亮代码块格式化的预览
QQ背景更新** - 非屏蔽变化检测和缓存刷新
通用支持** - 与 GitBook, Vercel docs, Next.js 网站和许多其他文档平台合作
双接口** - MCP工具和REST API端点
生产准备** - 限制费率、处理出错和坚固的缓存

# # # 快速启动 # # # # # # QQ Quick start

QQ建议:利用互动创建者获得最佳经验! **

Web UI管理盘

网络用户界面提供:

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

README

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

Universal Documentation MCP Server

A high-performance MCP (Model Context Protocol) server that transforms any documentation website into an AI-accessible knowledge base. Originally built for GitBook but works with Vercel docs, Next.js sites, Docusaurus, and many other documentation platforms. Features instant startup, intelligent caching, and automatic domain detection.

✨ Key Features

⚡ Instant Startup - SQLite storage with sub-second server initialization
🔍 Advanced Search - FTS5 full-text search with fuzzy matching and ranking
🧠 Smart Auto-Detection - Automatically detects domain, keywords, and branding
📝 Markdown Perfect - Preserves formatting with syntax-highlighted code blocks
🔄 Background Updates - Non-blocking change detection and cache refresh
🌐 Universal Support - Works with GitBook, Vercel docs, Next.js sites, and many other documentation platforms
📡 Dual Interface - Both MCP tools and REST API endpoints
🚀 Production Ready - Rate limiting, error handling, and robust caching

🚀 Quick Start

💡 Recommended: Use the interactive creator for the best experience!

🎨 Web UI Management Dashboard

# Clone this repo (once)
git clone https://github.com/tcsenpai/mcpbook/
cd mcpbook

# Build the UI
npm run ui:build

# Start the web interface
npm run ui

The Web UI provides:

🚀 Visual Server Creation - Step-by-step wizard with live URL validation
📊 Server Management - Start/stop/delete servers with real-time status
📋 Claude Desktop Integration - One-click copy config or add via CLI
🖥️ Live Terminal - Real-time feedback and command execution
⚠️ Safety Features - Confirmation dialogs and cancel functionality

⭐ One-Command Setup

# Clone this repo (once)
git clone https://github.com/tcsenpai/mcpbook/
cd mcpbook

# Create MCP server for any documentation site instantly
npm exec create-gitbook-mcp

That’s it! 🎉 The interactive wizard will:

✨ Guide you through setup with smart defaults
🔍 Auto-detect domain/keywords from your documentation site
📦 Install in organized directories (~/.config/mcpbooks/servers/[name])
🌍 Optionally install globally (accessible as your-server-name command)
🤖 Auto-configure Claude Desktop (optional)
🚀 Pre-cache everything for instant server startup

🛠️ Manual Setup (Advanced Users)

Install and Configure

npm install
echo "GITBOOK_URL=https://docs.yoursite.com" > .env

Build with Auto-Detection

在 GitHub 查看完整 README

安装

npx @modelcontextprotocol/inspector node dist/index.js

新手？先看 mcpskill.org 教程 →

配置

{
  "mcpServers": {
    "gitbook": {
      "command": "node",
      "args": ["/absolute/path/to/dist/index.js"],
      "env": {
        "GITBOOK_URL": "https://docs.yoursite.com"
      }
    }
  }
}