Gitbook MCP

MCP开发工具

提供方 hume-ai

开发工具 stdio · 本地进程 Token 社区 / 第三方
查看接入方式

GitBook Model Context Provider (MCP) Server是一个基于Python的服务,用于在代码库和GitBook文档之间建立桥梁,提供实时代码上下文和洞察,以增强技术文档。

一句话选型结论

按资料字段整理

Gitbook MCP 属于开发工具类 MCP 服务器,stdio · 本地进程,Token,有可直接执行的安装命令。接入前先确认权限范围;涉及写入、删除或付款的操作,建议先在测试环境验证。

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

工具与能力

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

能力标签

适用场景

代码索引Python本地部署文档解析API端点GitBook集成实时更新

安装与配置

stdio · 本地进程 Token
客户端在本机拉起子进程,数据不出本机
pip install flask flask-cors requests markdown beautifulsoup4

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

  1. 1
    准备运行环境

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

  2. 2
    安装服务

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

  3. 3
    写入客户端配置

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

  4. 4
    验证是否可用

    连接成功后客户端会列出约 5 个工具,随便调一个只读工具确认能返回结果。

典型使用场景

3 类
按分类与标签整理的常见用法,具体以官方文档为准
代码与仓库操作

在对话里直接查代码、提 issue、走 PR,省掉来回切工具。

本地命令与脚本

把构建、测试、格式化这类重复命令交给模型执行。

接口联调与测试

让模型调你的接口、跑一遍用例,快速定位问题。

选择建议

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

值得选的地方

  • 资料标注 5 个工具,职责相对集中,接入后不容易误操作。
  • 有现成的安装命令,不用自己找入口,照着跑就能起服务。

先想清楚的地方

  • stdio 方式要求本地装好运行时(如 Node.js),换机器要重新装一遍。
  • 使用前要准备好Token对应的凭据,并按最小权限配置。
  • 版本更新与行为细节以官方仓库为准。

更适合

  • 需要在开发工具场景里让模型直接调用外部能力的人。
  • 想先快速试一下、能接受在本地或自有环境跑服务的人。

不太适合

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

同类对比

6 个同类
同分类里挑最接近的几条,字段以各自详情页为准
MCP 服务器工具数传输方式部署方式安装命令最后核验
Gitbook MCP当前 5 stdio · 本地进程 本地部署 有 2026-05-17
Git 838e2ec1 12 stdio · 本地进程 本地部署 有 2026-05-17
Markitdown MCP 2c653a5f 1 stdio · 本地进程 本地部署 有 2026-05-17
JavaGuide 未标注 stdio · 本地进程 本地部署 有 2026-04-11
awesome-claude-skills 未标注 stdio · 本地进程 本地部署 有 2026-04-26
Context7 831acf40 未标注 stdio · 本地进程 本地部署 有 2026-05-17

服务器档案

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

详细介绍

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

GitBook模型上下文提供程序(MCP)服务器

这个基于Python的MCP服务器在您的代码库和GitBook文档之间架起了一座桥梁,提供实时上下文和代码见解,以增强您的技术文档。

特性

  • 编码索引:自动索引Python代码库,提取函数、类、模块、文档字符串和关系
  • 文档解析:分析您的markdown文档文件以查找代码引用
  • API终点:提供RESTful端点用于搜索和检索代码上下文
  • GitBook集成:通过API将代码信息同步到GitBook
  • 实时更新:定期重新索引代码库以保持信息的最新性
  • 关系跟踪:映射代码实体之间的依赖关系
  • Webhook 支持:为交互式文档处理GitBook webhooks

安装

  1. 克隆此存储库或将MCP服务器代码保存到您的项目中
  2. 安装所需的依赖项:```bash
    pip install flask flask-cors requests markdown beautifulsoup4

## 用法

### 基本用法

通过将MCP服务器指向您的代码库来启动它:```bash
python gitbook_mcp.py --code-path /path/to/your/codebase

包括文件

要为文档文件建立索引,请执行以下操作:```bash
python gitbook_mcp.py --code-path /path/to/your/codebase --docs-path /path/to/your/docs


### 完整架构```bash
python gitbook_mcp.py \
--code-path /path/to/your/codebase \
--docs-path /path/to/your/docs \
--port 5000 \
--gitbook-space your-gitbook-space-id \
--gitbook-token your-gitbook-api-token

API终点

健康检查```

GET /health


返回服务器状态和版本信息。

### 搜索代码和文档```
GET /search?q=query&type=entity_type

搜索与查询匹配的代码实体和文档。

参数:

  • q:搜索查询(必填)
  • type:按实体类型筛选(可选)-“函数”、“类”或“模块”

获取实体详细信息```

GET /entity/{entity_name}


获取有关特定代码实体及其关系的详细信息。

### 同步到GitBook```
POST /sync

手动触发代码信息到GitBook的同步。

GitBook 网关```

POST /webhook


GitBook webhooks接收事件的端点。

## 与GitBook集成

### 在GitBook中设置

1. 转到您的GitBook空间设置
1. 导航到“集成”>“自定义集成”
1. 使用以下设置添加新集成:
- 名称:代码上下文提供程序
- 网钩 URL : `http://your-server:5000/webhook`
- 事件:选择页面更新和评论
1. 在GitBook设置中生成API令牌
1. 使用GitBook空间ID和令牌启动MCP服务器

### 在文档中使用

设置后,您可以:

1. GitBook文档中的参考代码实体
1. 插入具有自动更新功能的实时代码片段
1. 添加打开源文件的“代码视图”链接
1. 启用带有代码建议的上下文注释

## 高级配置

创建配置文件 `mcp_config.json`:```json
{
"code_path": "/path/to/your/codebase",
"docs_path": "/path/to/your/docs",
"port": 5000,
"index_interval": 300,
"exclude_patterns": ["__pycache__", "*.pyc", ".*", "venv", "env"],
"gitbook": {
"space_id": "your-gitbook-space-id",
"api_token": "your-gitbook-api-token",
"sync_modules": true,
"sync_classes": true,
"sync_functions": true
}
}

然后使用以下命令启动服务器:bash python gitbook_mcp.py --config mcp_config.json

贡献

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

许可证

此项目根据MIT许可证获得许可-有关详细信息,请参阅许可证文件。

常见问题

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

在客户端按下面的安装命令接入:pip install flask flask-cors requests markdown beautifulsoup4。装完在客户端配置里引用同一个包或端点。

Gitbook MCP 怎么在客户端里配置?

它的传输方式未标注,在客户端 MCP 配置里按官方文档填写启动命令和参数,保存后重启客户端生效。

Gitbook MCP 收费吗?

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

Gitbook MCP 需要 API Key 吗?

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

Gitbook MCP 能提供哪些能力?

资料显示约 5 个工具;能力标签包括 代码索引、实时更新、Python。具体工具清单以官方文档为准。

Gitbook MCP 需要什么运行环境?

属于本地进程,需要在本机装好运行环境。

Gitbook MCP 是本地还是远程?

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

热门专题

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

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