Universal Documentation MCP Server

MCP文档知识

提供方 tcsenpai · 包名 @modelcontextprotocol/inspector

文档知识 stdio · 本地进程 OAuth 授权 社区 / 第三方 Claude
查看接入方式

一个高性能的MCP(模型上下文协议)服务器,将任何文档网站转换为AI可访问的知识库,支持GitBook、Vercel文档、Next.js站点等多种文档平台,具有即时启动、智能缓存和自动域名检测功能。

一句话选型结论

按资料字段整理

Universal Documentation MCP Server 属于文档知识类 MCP 服务器,stdio · 本地进程,OAuth 授权,可直接接入 Claude,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

分类文档知识 传输方式stdio · 本地进程 鉴权OAuth 授权 部署方式本地部署
GitHub 星标 19 仓库热度,无公开仓库时显示未标注
工具数 未标注 暴露给模型的工具数量
资源 / 提示词 0 / 0 资源与提示词模板数量
维护方 社区 / 第三方 核验等级 仅资料核对

工具与能力

文档知识
数量来自来源目录的标注,具体工具清单以官方文档为准
工具数量未标注暴露给模型可调用的工具个数
资源数量0可读取的资源条目
提示词数量0内置提示词模板数量

能力标签

支持客户端

适用场景

文档转换JavaScript本地部署知识库构建AI集成高性能服务器自动检测

安装与配置

stdio · 本地进程 OAuth 授权
客户端在本机拉起子进程,数据不出本机
npx @modelcontextprotocol/inspector node dist/index.js

这条命令只是入口,具体启动参数请按官方文档补齐,不要直接照搬到别的服务器。

  1. 1
    准备运行环境

    stdio 服务在本地起进程,需要先装好 Node.js,再按安装命令拉取依赖。

  2. 2
    安装服务

    复制上面的安装命令执行;命令里带占位符的位置,换成自己的密钥或路径。

  3. 3
    写入客户端配置

    在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,让新配置生效。

  4. 4
    验证是否可用

    连接成功后随便调一个只读工具,确认能返回结果,再接入正式流程。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
文档检索问答

在你的文档库里按问题找答案。

知识库读写

把新资料写进知识库,随用随取。

内容整理

把零散资料归纳成结构化笔记。

选择建议

选之前先看这几条
按条目字段给出的判断,不替你决定用不用

值得选的地方

  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。
  • 已适配 Claude,换客户端不用重新研究配置。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好OAuth 授权对应的凭据,并按最小权限配置。
  • 资料没标注工具数量,实际能力要装好后确认。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在文档知识场景里让模型直接调用外部能力的人。
  • 已经在用 Claude 的用户,接入路径最短。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

  • 完全不想在本地装环境的人。
  • 不方便管理密钥或第三方授权的人。
  • 需要厂商级 SLA 和技术支持的生产环境。

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Universal Documentation MCP Server当前 未标注 stdio · 本地进程 本地部署 有 2026-05-17
dify 未标注 stdio · 本地进程 本地部署 有 2026-04-11
open-webui 未标注 stdio · 本地进程 本地部署 有 2026-04-11
JeecgBoot 未标注 stdio · 本地进程 本地部署 有 2026-04-11
Cherry Studio 未标注 未标注 未标注 无 2026-05-17
mempalace 未标注 stdio · 本地进程 本地部署 有 2026-04-11

服务器档案

文档知识
字段来自项目仓库与公开索引,中文说明由本站标注
提供方tcsenpai上游标注的维护方 tcsenpai
分类文档知识本站按上游分类展示
连接方式stdio · 本地进程客户端在本机拉起子进程,数据不出本机
鉴权方式OAuth 授权远程服务建议用最小权限凭据
维护方社区 / 第三方核验等级 仅资料核对
包名 / 运行时@modelcontextprotocol/inspector · Node.js本地安装时用到的包标识与运行时
部署类型本地部署上游给出的部署形态
最近核验2026-05-17上游最后核验时间

详细介绍

10.4 KB
来自项目仓库与上游目录的原文,未做删改

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```bash

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**```bash
# 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)

  1. Install and Configurebash npm install echo "GITBOOK_URL=https://docs.yoursite.com" > .env

  2. Build with Auto-Detectionbash npm run build # Automatically detects and configures your domain

  3. Start Serverbash npm start # Instant startup with SQLite cache

  4. Test with MCP Inspectorbash npx @modelcontextprotocol/inspector node dist/index.js

📦 Installation Options

Option 1: Local Development```bash

git clone <repository>
cd mcpbook
npm install
npm run build
npm start


### Option 2: Global Installation```bash
npm install -g .
# Then use the binary name from package.json
your-mcp-server-name

Option 3: Claude Desktop Integration```json

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


**Config file locations:**
- **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json`
- **Windows**: `%APPDATA%\\Claude\\claude_desktop_config.json`

### Option 4: StreamableHTTP Transport```bash
npm run start:http  # StreamableHTTP on port 3001
node dist/index.js --streamable-http --port=3002  # Custom port

Option 5: REST API Server```bash

npm run start:api # HTTP server on port 3000
PORT=8080 npm run start:api # Custom port


## 🌐 Platform Compatibility

While originally designed for GitBook, this MCP server has **proven compatibility** with many documentation platforms:

### ✅ **Guaranteed to Work**
- **GitBook** (original target platform)
- **Custom GitBook instances**

### 🎯 **Successfully Tested**
- **Vercel-hosted docs** (`docs.vercel.com`, `aptos.dev`)
- **Next.js documentation sites**
- **Static site generators** with consistent navigation
- **Most HTML-based documentation platforms**

### 🔧 **How It Works**
The scraper intelligently:
- **Discovers navigation** through link crawling
- **Extracts content** from any HTML structure
- **Adapts to different layouts** automatically
- **Handles various authentication** and routing patterns

&gt; **💡 Pro Tip**: If a site has consistent navigation and accessible content, our scraper will likely work! The auto-detection feature adapts to different site structures automatically.

## ⚙️ Configuration

### Auto-Detection (Recommended)```env
GITBOOK_URL=https://docs.yoursite.com
AUTO_DETECT_DOMAIN=true
AUTO_DETECT_KEYWORDS=true

The server will automatically:
- Generate domain-specific tool names (stripe_docs_search, api_docs_get_page)
- Extract relevant keywords from content
- Create contextual descriptions for better AI integration

Manual Configuration```env

Target GitBook (required)

GITBOOK_URL=https://docs.yoursite.com

Custom branding (optional)

SERVER_NAME=my-api-docs
SERVER_DESCRIPTION=API documentation and guides
DOMAIN_KEYWORDS=api,rest,graphql,endpoints
TOOL_PREFIX=api_

Performance tuning

CACHE_TTL_HOURS=1
MAX_CONCURRENT_REQUESTS=5
SCRAPING_DELAY_MS=100


### Configuration Examples

**API Documentation:**```env
GITBOOK_URL=https://api-docs.yourservice.com
TOOL_PREFIX=api_
DOMAIN_KEYWORDS=api,rest,endpoints,authentication

→ Results in: api_search_content, api_get_page, etc.

Product Documentation:```env
GITBOOK_URL=https://help.yourproduct.com
TOOL_PREFIX=help_
DOMAIN_KEYWORDS=tutorial,guide,troubleshooting

→ Results in: `help_search_content`, `help_get_page`, etc.

## 🛠️ Available Tools

The server exposes 7 MCP tools with automatic prefixing:

### Core Tools

| Tool | Description | Parameters |
|------|-------------|------------|
| `{prefix}_search_content` | Advanced search with ranking | `query`: Search terms |
| `{prefix}_get_page` | Get specific page content | `path`: Page path (e.g., &quot;/api/auth&quot;) |
| `{prefix}_list_sections` | Get table of contents | None |
| `{prefix}_get_section_pages` | Get all pages in section | `section`: Section name |
| `{prefix}_refresh_content` | Force cache refresh | None |
| `{prefix}_get_code_blocks` | Extract code with syntax highlighting | `path`: Page path |
| `{prefix}_get_markdown` | Get formatted markdown | `path`: Page path |

### MCP Prompts
- `explain_section` - Generate comprehensive tutorials
- `summarize_page` - Create concise summaries
- `compare_sections` - Compare documentation sections
- `api_reference` - Format as API documentation
- `quick_start_guide` - Generate quick start guides

## 🌐 HTTP Interfaces

The server supports both MCP StreamableHTTP and traditional REST API:

**StreamableHTTP MCP Protocol:**```bash
# Health check
curl http://localhost:3001/health

# MCP requests (requires MCP client)
curl -X POST http://localhost:3001/mcp \
  -H &quot;Content-Type: application/json&quot; \
  -d &#x27;{&quot;jsonrpc&quot;: &quot;2.0&quot;, &quot;id&quot;: 1, &quot;method&quot;: &quot;tools/list&quot;}&#x27;

REST API (separate server):```bash

Search content

curl "http://localhost:3000/api/search?q=authentication"

Get specific page

curl "http://localhost:3000/api/page/api/authentication"

Get page as markdown

curl "http://localhost:3000/api/page/api/authentication/markdown"

Get code blocks

curl "http://localhost:3000/api/page/api/authentication/code"

List sections

curl "http://localhost:3000/api/sections"

Get section pages

curl "http://localhost:3000/api/sections/API/pages"

Server status

curl "http://localhost:3000/api/status"

Refresh cache

curl -X POST "http://localhost:3000/api/refresh"


## 🎯 Usage Examples

### Auto-Detection Results
- `docs.stripe.com` → `stripe_search_content`, `stripe_get_page`
- `docs.react.dev` → `react_search_content`, `react_get_page`
- `api.yourcompany.com` → `api_search_content`, `api_get_page`
- Generic sites → `docs_search_content`, `docs_get_page`

### MCP Tool Usage```bash
# Search for authentication docs
{&quot;tool&quot;: &quot;api_search_content&quot;, &quot;arguments&quot;: {&quot;query&quot;: &quot;oauth authentication&quot;}}

# Get specific page
{&quot;tool&quot;: &quot;api_get_page&quot;, &quot;arguments&quot;: {&quot;path&quot;: &quot;/auth/oauth&quot;}}

# Get code examples
{&quot;tool&quot;: &quot;api_get_code_blocks&quot;, &quot;arguments&quot;: {&quot;path&quot;: &quot;/sdk/quickstart&quot;}}

# Refresh content
{&quot;tool&quot;: &quot;api_refresh_content&quot;, &quot;arguments&quot;: {}}

🏗️ Architecture

  • SQLite Storage - Fast startup with FTS5 full-text search
  • Background Updates - Non-blocking change detection
  • Auto-Detection - Domain and keyword extraction
  • Parallel Scraping - Configurable concurrency
  • Smart Caching - Only updates changed content

Key Components

  • GitBookScraper - Web scraping and content extraction
  • SQLiteStore - High-performance storage with FTS5 search
  • DomainDetector - Automatic domain and keyword detection
  • GitBookMCPServer - MCP server with tool handlers
  • GitBookRestAPI - HTTP endpoints for web integration

🔧 Development```bash

Development mode with auto-reload

npm run dev

Build with auto-detection

npm run build

Run manual auto-detection

npm run auto-detect

Clean build (no auto-detection)

npm run build:clean

Test with MCP Inspector

npx @modelcontextprotocol/inspector node dist/index.js
```

🌍 Universal GitBook Support

Works with any public GitBook, including:

  • API Documentation - Stripe, Twilio, etc.
  • Framework Docs - React, Vue, Angular
  • Product Guides - Help centers and tutorials
  • Developer Resources - SDKs and references
  • Company Wikis - Internal documentation

⚡ Performance

  • Instant Startup: Sub-second initialization with SQLite cache
  • Background Updates: Non-blocking change detection
  • Smart Indexing: FTS5 full-text search with ranking
  • Efficient Storage: SQLite replaces slow JSON parsing
  • Memory Optimized: On-demand loading instead of full memory cache

🚧 Limitations

  • Public GitBooks Only - Requires publicly accessible sites
  • Static Content - Scrapes published HTML, not API-based
  • Manual Refresh - No real-time updates (use refresh tool)
  • Text-Focused - Extracts text content, not interactive elements

📄 License

MIT


Need help? Check the MCP documentation or open an issue.

常见问题

8 问
答案由本站依据条目字段整理,不引用上游原文
Universal Documentation MCP Server 怎么安装?

在客户端按下面的安装命令接入:npx @modelcontextprotocol/inspector node dist/index.js。对应的包名是 @modelcontextprotocol/inspector。装完在客户端配置里引用同一个包或端点。

Universal Documentation MCP Server 怎么在 Claude 里配置?

它的传输方式是stdio · 本地进程,在客户端的 MCP 配置里填好启动命令和参数,保存后完全退出客户端再打开,配置才会生效。

Universal Documentation MCP Server 收费吗?

本站不代收费用,也没有标注具体价格。是否收费取决于服务本身和背后的接口额度,正式使用前按官方说明确认。

Universal Documentation MCP Server 需要 API Key 吗?

资料标注需要OAuth 授权认证,使用前准备好对应凭据,并按最小权限配置。

Universal Documentation MCP Server 支持哪些客户端?

资料标注支持 Claude;其他客户端只要能配置 MCP Server,也能用同样的命令或地址接入。

Universal Documentation MCP Server 能提供哪些能力?

资料显示能力标签包括 文档转换、JavaScript、Claude。具体工具清单以官方文档为准。

Universal Documentation MCP Server 需要什么运行环境?

运行时为 Node.js;属于本地进程,需要在本机装好运行环境。

Universal Documentation MCP Server 是本地还是远程?

它是本地进程(stdio),由客户端在本机拉起。传输方式为stdio · 本地进程。

热门专题

按标签挑服务器
全部专题 →

服务器信息以作者仓库与官方文档为准;分类、传输方式与鉴权方式的中文说明为中文整理,最近核验 2026-05-17。