gitbook-mcp
gitbook-mcp is an MCP server for reading GitBook content and managing a change-request-based write workflow. There is no direct page-body editing API; content authoring is done via import.
Read Content
List organizations, spaces, pages, revisions, files, comments, and backlinks
Fetch page content as Markdown or structured Document JSON
Access historical revisions, reusable content blocks, and computed documents
Get PDF export URLs for spaces or change requests
Search
Full-text search across an entire organization or a single space
Write Content via Import
gitbook_import_content— import a public web page URL into a space or change request (AI-enhanced by default, asynchronous)gitbook_cancel_import_run— cancel an in-progress import
Change Request Workflow (Draft → Review → Publish)
Create, list, update, and merge (publish) change requests
View diffs, reviews, contributors, files, and links within a change request
Request reviewers, submit reviews, and manage the review lifecycle
Post, list, update, and reply to comments on change requests
Space Management
Create, duplicate, move, restore, and update spaces
Apply templates to spaces
Comments & Links
Post, list, update, and reply to comments at both space and change-request level
List all links, backlinks, and meta-links for pages and files
User & Org Info
Look up the authenticated user (
whoami), list organizations, get/update user profiles
Configuration & Safety
Enable only needed tool categories (e.g.,
core,change-requests,collections,sites) via environment variableRead-only mode (
GITBOOK_READONLY) and destructive-action gating (GITBOOK_ALLOW_DESTRUCTIVE) availablePages accessible as MCP resources at
gitbook://{spaceId}/{pageId}
Allows reading GitBook content (pages, spaces, search) and managing a change-request write workflow, including creating, importing content, commenting, and merging change requests.
Click on "Deploy Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@gitbook-mcp Show me the content of page 'getting-started' in space 'docs'"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
gitbook-mcp
A Model Context Protocol server for GitBook. It lets an MCP host (Claude Code, Claude Desktop, Cursor, …) read your GitBook content and drive a change-request write workflow, over stdio or streamable HTTP.
Built on the official @gitbook/api
client and @modelcontextprotocol/sdk 1.x.
Full API coverage: ~345 tools across 11 config-gated toolsets. The default (
core+change-requests) keeps the surface small; write and destructive tools are gated by read-only mode plus an opt-in.Resources: pages addressable as
gitbook://{spaceId}/{pageId}.Two transports: stdio (local) and streamable HTTP (multi-session, bearer-gated).
Resilient: request timeouts, bounded retries with full-jitter backoff, rate-limit handling.
Safe: read-only mode, env-only token, secret redaction, localhost-bound HTTP.
Status: published as
@hoyongjin/gitbook-mcp(v2.0.0), with the original 11 tools enabled by default. Covered by unit, MCP-protocol, and manifest-contract tests. The stdio transport suits local IDE/CLI use. The HTTP transport adds bearer auth, DNS-rebinding protection, a session cap with idle reaper, per-IP rate limiting, health/readiness probes, and Prometheus metrics for hosted use.
⚠️ What GitBook's API can and cannot write
GitBook's public API has no direct "edit this page body" endpoint
(createPage/updatePage exist only as the GitBook Assistant's internal tool
names, not as REST methods). Content authoring goes through:
Change requests: open a draft (
gitbook_create_change_request), review, thengitbook_merge_change_requestto publish.Content import:
gitbook_import_contentimports a web page URL into a space/change-request/page, AI-enhanced by default. This is the supported "write content" primitive. Imports are asynchronous, and GitBook exposes no status-poll endpoint.Git Sync: for fine-grained, paragraph-level authoring, connect the space to a Git repo and edit markdown there. (Out of scope for this server; it is the right path if you need precise prose edits.)
So the server exposes many reads and a single coarse, review-gated write path. It cannot rewrite a specific paragraph through the API.
Related MCP server: Notion MCP Server
Install
# From source (local use):
cd gitbook-mcp && npm install && npm run build
# → run with: node dist/index.js (or `npm start`)
# Or, once published:
npx @hoyongjin/gitbook-mcpThe package is scoped to
@hoyongjin/gitbook-mcp(the unscopedgitbook-mcpon npm belongs to a different project). Make sure your npm account owns the@hoyongjinscope before publishing.
Create a token at GitBook → Settings → Developer → Personal access tokens.
Configure in your MCP client
Claude Code
# Local build:
claude mcp add gitbook \
--env GITBOOK_TOKEN=gb_api_xxx \
-- node /absolute/path/to/gitbook-mcp/dist/index.js.mcp.json / Claude Desktop config
{
"mcpServers": {
"gitbook": {
"command": "node",
"args": ["/absolute/path/to/gitbook-mcp/dist/index.js"],
"env": { "GITBOOK_TOKEN": "gb_api_xxx" }
}
}
}(After publishing, replace command/args with
"command": "npx", "args": ["@hoyongjin/gitbook-mcp"].)
Run read-only (recommended unless you need writes) by adding "--read-only" to
args, or "GITBOOK_READONLY": "true" to env.
Configuration
All configuration is via environment variables (see .env.example).
The token is never taken from a CLI argument.
Variable | Default | Description |
| — | Required. Personal access token (account-wide privileges). |
|
| API base URL. |
|
| Hide all write/destructive tools when true. |
|
| Comma-separated toolsets to enable, or |
|
| Opt-in to register new destructive ops (deletes, unpublish, admin removals). The legacy |
|
|
|
|
| HTTP bind host. |
|
| HTTP port. |
| — | Bearer token required on the HTTP transport. |
|
| Concurrent-session cap; new initializes past it get 503 (1–100000). |
|
| Idle-session reaper TTL (1 000–86 400 000). |
|
| Absolute session lifetime; reaped regardless of activity. |
|
| Trust |
| — | Comma-separated hosts appended to the DNS-rebinding allow-list. Required for proxied/non-loopback access (e.g. |
| — | Comma-separated origins appended to the allow-list (e.g. |
|
| Rate-limit window per client IP. |
|
| Max |
|
|
|
|
| Per-request timeout (1 000–120 000). |
|
| Max retries on 429/5xx/transport errors (0–10). |
|
| Max concurrent outbound GitBook HTTP requests per instance (1–256). |
CLI flags: --stdio / --http (transport), --read-only, --toolsets <csv|all>,
--allow-destructive, --port <n>.
Tools
The server covers the full GitBook API (~345 tools), organized into toolsets
you enable with GITBOOK_TOOLSETS. By default only core + change-requests are
on (~89 tools), so tools/list stays small and tool selection stays accurate.
Set GITBOOK_TOOLSETS=all for everything, or list the ones you need
(e.g. GITBOOK_TOOLSETS=core,change-requests,sites).
Every tool is one API endpoint with its own input schema. Read tools are always
available, write tools need !readOnly, and new destructive tools (deletes, unpublish,
admin removals) also need GITBOOK_ALLOW_DESTRUCTIVE=true.
Toolset | Default | Scope |
| ✅ | Identity, orgs/spaces/pages reads, search, content + |
| ✅ | Full CR loop: create, list/diff, reviews, reviewers, comments, merge. |
| Collections + collection permissions. | |
| Sites, structure, customization, redirects, share links, permissions. | |
| Ask AI, agent settings, questions, glossary-adjacent AI. | |
| Analytics/insights, context connections, channels, site MCP servers. | |
| Integration install/configure/token + space integrations. | |
| OpenAPI specs, translations, glossary, custom fonts, storage. | |
| Git Sync: import/export, provider installations, repo/branch listing. | |
| URL→content resolution, subdomains, custom hostnames. | |
| Org members, teams, invites, SSO, permissions (highest privilege). |
The 11 original tools keep their exact names and live in core / change-requests,
so existing setups are unchanged. Per-tool parameters are delivered live via each tool's
MCP description + input schema.
Excluded carve-outs: 5 streaming (SSE) AI endpoints, 2 ephemeral PDF-URL generators, and a few trivial auth/heartbeat ops are not exposed as tools (the non-streaming AI equivalents are).
List tools (*_list_*, search) accept a body with limit/page and return
nextCursor when more results exist. Typical write flow:
create_change_request → import_content (target that CR) → review/diff → merge_change_request.
Resources
Pages are exposed as resources at gitbook://{spaceId}/{pageId} (rendered as
markdown). Enumeration is intentionally not provided; discover page ids via
gitbook_list_pages / gitbook_search, then read by URI.
Transports
stdio (default): one server per process; the token stays in-process. Best for local IDE/CLI integrations.
streamable HTTP (
--http): one MCP session permcp-session-id. Binds to127.0.0.1and enables DNS-rebinding protection (Host/Origin allow-lists). WhenGITBOOK_HTTP_AUTH_TOKENis set, every request needs a constant-time-compared bearer token. Binding to a non-loopback host without an auth token is refused (fail-closed). Sessions are capped and idle-reaped; the/mcpendpoint is per-IP rate-limited. Operational endpoints:GET /healthz/livez/readyz(unauthenticated probes) andGET /metrics(Prometheus; bearer-gated when an auth token is set). Behind a TLS-terminating reverse proxy, setGITBOOK_HTTP_TRUST_PROXY=trueandGITBOOK_HTTP_ALLOWED_HOSTS=<your-public-host>: DNS-rebinding protection matches the exactHostheader, so a proxied or non-loopback deployment (including the Docker image, which binds0.0.0.0) must add its public host(s) or every request is rejected with 403Invalid Host. ADockerfileis provided.
GITBOOK_TOKEN=… GITBOOK_HTTP_AUTH_TOKEN=… gitbook-mcp --http --port 3000
# → POST/GET/DELETE http://127.0.0.1:3000/mcp · GET /healthz · GET /metricsDevelopment
npm install
npm run typecheck # tsc on src + test
npm run lint # eslint
npm run format # prettier --write (format:check verifies)
npm test # vitest: unit + protocol + manifest-contract tests
npm run generate:manifest # regenerate src/tools/manifest.ts from @gitbook/api (CI checks drift)
npm run test:coverage # + v8 coverage with an 80% gate
npm run build # tsc → dist/ (+ chmod the bin)CI (.github/workflows/ci.yml) runs npm audit → typecheck → lint → format:check
→ build → coverage on Node 20 & 22, then asserts a clean git diff. CodeQL and
Dependabot run separately.
Architecture
src/
index.ts launcher: load config → pick transport → graceful shutdown
config.ts zod-validated env + CLI overrides (frozen Config)
logger.ts structured stderr logging + secret redaction + correlation
request-context.ts AsyncLocalStorage requestId/tool (log correlation)
metrics.ts in-process Prometheus registry (served at /metrics)
limiter.ts async concurrency semaphore (outbound rate control)
server.ts createServer(): McpServer factory (tools + resources)
resources.ts gitbook://{spaceId}/{pageId}
version.ts stable SERVER_NAME + runtime SERVER_VERSION (from package.json)
gitbook/
client.ts typed wrapper over @gitbook/api (cursor pagination → {items,nextCursor})
resilient-fetch.ts timeouts + retry/backoff + concurrency cap; injected as the client's fetch
import-url.ts URL guard for server-side-fetch ops (http(s) only, no credentials)
errors.ts HTTP/transport error classification → safe messages
tools/
manifest.ts GENERATED tool surface (one row per API op; source of truth)
toolsets.ts toolset keys + defaults
index.ts manifest-driven registration under toolset/read-only/destructive gates
factory.ts generic handler factory (every non-bespoke op)
bespoke.ts the 11 grandfathered tools (hand-written handlers)
shared.ts ToolContext + result/guard helpers + annotation presets
transports/
stdio.ts http.ts the two transports (http: sessions, rate limit, health, metrics)Notes / gotchas (pinned to @gitbook/api 0.183.0)
tsconfig uses
moduleResolution: "Bundler", notNodeNext.@gitbook/api0.183 ships a.d.tsthat re-exports with extensionless relative specifiers (export * from './client'); under NodeNext those don't resolve and the entire client surface (and theGitBookAPInamespace members) silently disappears. Bundler resolution accepts them, giving full typing with no facade. Internal imports use explicit.jsextensions so the emitted ESM runs on Node.Import runs live under the singular
client.orgnamespace, not the pluralclient.orgs(which holds list/search). They are different runtime objects.gitbook_get_pagemarkdown vs document:format=markdownreturns rendered markdown;format=documentreturns GitBook's structured Document JSON.Node ≥ 20 (global
fetch,AbortSignal.any).
License
Available Tools
89 toolsgitbook_apply_template_to_spaceApply a template to a space.C
Apply a template to a space.. (POST /spaces/{spaceId}/content/template)
Inputs: spaceId (required), body.
gitbook_cancel_import_runCancel an import runA
Cancel an import run. (POST /org/{organizationId}/imports/{importRunId}/cancel) Asynchronous — GitBook exposes no status endpoint, so treat the result as 'started, not confirmed' and verify in GitBook.
Inputs: organizationId (required), importRunId (required).
gitbook_comment_change_requestComment on a change requestB
Post a markdown comment on a change request (review feedback / notes).
Inputs: spaceId (required), changeRequestId (required), body (required), page.
gitbook_create_change_requestOpen a change requestA
Create a change request (draft branch) on a space. Returns its id to target with gitbook_import_content / gitbook_comment_change_request, then gitbook_merge_change_request to publish.
Inputs: spaceId (required), subject.
gitbook_create_spaceCreate a spaceB
Create a space. (POST /orgs/{organizationId}/spaces)
Inputs: organizationId (required), body.
gitbook_duplicate_spaceDuplicate a spaceC
Duplicate a space. (POST /spaces/{spaceId}/duplicate)
Inputs: spaceId (required).
gitbook_get_change_request_by_idGet a change request by its IDARead-onlyIdempotent
Get a change request by its ID. (GET /spaces/{spaceId}/change-requests/{changeRequestId})
Inputs: spaceId (required), changeRequestId (required).
gitbook_get_change_request_changesGet change request semantic changesBRead-onlyIdempotent
Get change request semantic changes. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/changes)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_get_change_request_pdfGet a URL of the content of a change request as PDFARead-onlyIdempotent
Get a URL of the content of a change request as PDF. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/pdf)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_get_change_request_review_by_idGet a change request review by its IDBRead-onlyIdempotent
Get a change request review by its ID. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/reviews/{reviewId})
Inputs: spaceId (required), changeRequestId (required), reviewId (required), body.
gitbook_get_comment_in_change_requestGet a change request commentBRead-onlyIdempotent
Get a change request comment. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId})
Inputs: spaceId (required), changeRequestId (required), commentId (required), body.
gitbook_get_comment_in_spaceGet a space commentARead-onlyIdempotent
Get a space comment. (GET /spaces/{spaceId}/comments/{commentId})
Inputs: spaceId (required), commentId (required), body.
gitbook_get_comment_reply_in_change_requestGet a change request comment replyBRead-onlyIdempotent
Get a change request comment reply. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId})
Inputs: spaceId (required), changeRequestId (required), commentId (required), commentReplyId (required), +1 more.
gitbook_get_comment_reply_in_spaceGet a space comment replyARead-onlyIdempotent
Get a space comment reply. (GET /spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId})
Inputs: spaceId (required), commentId (required), commentReplyId (required), body.
gitbook_get_computed_documentGet a space computed documentB
Get a space computed document. (POST /spaces/{spaceId}/content/computed/document)
Inputs: spaceId (required), body.
gitbook_get_computed_revisionGet a space computed revisionC
Get a space computed revision. (POST /spaces/{spaceId}/content/computed/revision)
Inputs: spaceId (required), body.
gitbook_get_contributors_by_change_request_idGet all contribors of a change requestBRead-onlyIdempotent
Get all contribors of a change request. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/contributors)
Inputs: spaceId (required), changeRequestId (required).
gitbook_get_current_revisionGet a space current revisionARead-onlyIdempotent
Get a space current revision. (GET /spaces/{spaceId}/content)
Inputs: spaceId (required), body.
gitbook_get_document_by_idGet a space document by its IDARead-onlyIdempotent
Get a space document by its ID. (GET /spaces/{spaceId}/documents/{documentId})
Inputs: spaceId (required), documentId (required), body.
gitbook_get_embed_by_url_in_spaceResolve a URL to an embed in a given spaceBRead-onlyIdempotent
Resolve a URL to an embed in a given space. (GET /spaces/{spaceId}/embed)
Inputs: spaceId (required), body.
gitbook_get_file_by_idGet a space file by its IDARead-onlyIdempotent
Get a space file by its ID. (GET /spaces/{spaceId}/content/files/{fileId})
Inputs: spaceId (required), fileId (required), body.
gitbook_get_file_in_change_request_by_idGet a change request file by its IDARead-onlyIdempotent
Get a change request file by its ID. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId})
Inputs: spaceId (required), changeRequestId (required), fileId (required), body.
gitbook_get_file_in_revision_by_idGet a space revision file by its IDBRead-onlyIdempotent
Get a space revision file by its ID. (GET /spaces/{spaceId}/revisions/{revisionId}/files/{fileId})
Inputs: spaceId (required), revisionId (required), fileId (required), body.
gitbook_get_organization_by_idGet an organization by its IDARead-onlyIdempotent
Get an organization by its ID. (GET /orgs/{organizationId})
Inputs: organizationId (required).
gitbook_get_pageGet a page's contentARead-onlyIdempotent
Read a page by id. format='markdown' (default) returns rendered markdown; format='document' returns GitBook's structured Document JSON.
Inputs: spaceId (required), pageId (required), format.
gitbook_get_page_by_pathGet a space page by its pathARead-onlyIdempotent
Get a space page by its path. (GET /spaces/{spaceId}/content/path/{pagePath})
Inputs: spaceId (required), pagePath (required), body.
gitbook_get_page_document_in_revision_by_idGet the document of a page in a revisionARead-onlyIdempotent
Get the document of a page in a revision. (GET /spaces/{spaceId}/revisions/{revisionId}/page/{pageId}/document)
Inputs: spaceId (required), revisionId (required), pageId (required), body.
gitbook_get_page_in_change_request_by_idGet a change request page by its IDBRead-onlyIdempotent
Get a change request page by its ID. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId})
Inputs: spaceId (required), changeRequestId (required), pageId (required), body.
gitbook_get_page_in_change_request_by_pathGet a change request page by its pathBRead-onlyIdempotent
Get a change request page by its path. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/path/{pagePath})
Inputs: spaceId (required), changeRequestId (required), pagePath (required), body.
gitbook_get_page_in_revision_by_idGet a space revision page by its IDARead-onlyIdempotent
Get a space revision page by its ID. (GET /spaces/{spaceId}/revisions/{revisionId}/page/{pageId})
Inputs: spaceId (required), revisionId (required), pageId (required), body.
gitbook_get_page_in_revision_by_pathGet a space revision page by its pathBRead-onlyIdempotent
Get a space revision page by its path. (GET /spaces/{spaceId}/revisions/{revisionId}/path/{pagePath})
Inputs: spaceId (required), revisionId (required), pagePath (required), body.
gitbook_get_requested_reviewers_by_change_request_idGet all change request reviewersARead-onlyIdempotent
Get all change request reviewers. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_get_reusable_content_by_idGet a space reusable content by its IDARead-onlyIdempotent
Get a space reusable content by its ID. (GET /spaces/{spaceId}/content/reusable-contents/{reusableContentId})
Inputs: spaceId (required), reusableContentId (required), body.
gitbook_get_reusable_content_document_in_revision_by_idGet the document of a reusable content in a revisionBRead-onlyIdempotent
Get the document of a reusable content in a revision. (GET /spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId}/document)
Inputs: spaceId (required), revisionId (required), reusableContentId (required), body.
gitbook_get_reusable_content_in_change_request_by_idGet a change request reusable content by its IDARead-onlyIdempotent
Get a change request reusable content by its ID. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/reusable-contents/{reusableContentId})
Inputs: spaceId (required), changeRequestId (required), reusableContentId (required), body.
gitbook_get_reusable_content_in_revision_by_idGet a space revision reusable content by its IDARead-onlyIdempotent
Get a space revision reusable content by its ID. (GET /spaces/{spaceId}/revisions/{revisionId}/reusable-contents/{reusableContentId})
Inputs: spaceId (required), revisionId (required), reusableContentId (required), body.
gitbook_get_reviews_by_change_request_idList all change request reviewsARead-onlyIdempotent
List all change request reviews. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/reviews)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_get_revision_by_idGet a space revisionCRead-onlyIdempotent
Get a space revision. (GET /spaces/{spaceId}/revisions/{revisionId})
Inputs: spaceId (required), revisionId (required), body.
gitbook_get_revision_of_change_request_by_idGet a change request the latest content revisionBRead-onlyIdempotent
Get a change request the latest content revision. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_get_revision_semantic_changesGet space revision semantic changesBRead-onlyIdempotent
Get space revision semantic changes. (GET /spaces/{spaceId}/revisions/{revisionId}/changes)
Inputs: spaceId (required), revisionId (required), body.
gitbook_get_spaceGet a spaceARead-onlyIdempotent
Fetch a single space by id (title, visibility, urls, default revision).
Inputs: spaceId (required).
gitbook_get_space_pdfGet a URL of the content of a space as PDFARead-onlyIdempotent
Get a URL of the content of a space as PDF. (GET /spaces/{spaceId}/pdf)
Inputs: spaceId (required), body.
gitbook_get_user_by_idGet a user by its IDBRead-onlyIdempotent
Get a user by its ID. (GET /users/{userId})
Inputs: userId (required).
gitbook_import_contentImport content into a change requestA
GitBook's content-write primitive: import a public web page (sourceUrl) into a space — scoped to a change request (and optionally a page), AI-enhanced by default. There is NO direct 'set page body' API; this is the supported write path. The import is asynchronous (returns a run id + status); review in GitBook, then gitbook_merge_change_request to publish.
Inputs: orgId (required), spaceId (required), sourceUrl (required), changeRequestId, +2 more.
gitbook_list_change_request_file_backlinksList all backlink locations of a change request fileBRead-onlyIdempotent
List all backlink locations of a change request file. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/files/{fileId}/backlinks)
Inputs: spaceId (required), changeRequestId (required), fileId (required), body.
gitbook_list_change_request_linksList all change request linksBRead-onlyIdempotent
List all change request links. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/links)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_list_change_request_page_backlinksList all backlink locations of a change request pageBRead-onlyIdempotent
List all backlink locations of a change request page. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/backlinks)
Inputs: spaceId (required), changeRequestId (required), pageId (required), body.
gitbook_list_change_request_page_meta_linksList all meta links of a change request pageARead-onlyIdempotent
List all meta links of a change request page. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/meta-links)
Inputs: spaceId (required), changeRequestId (required), pageId (required).
gitbook_list_change_requests_for_organizationList all change requests in an organizationBRead-onlyIdempotent
List all change requests in an organization. (GET /orgs/{organizationId}/change-requests)
Inputs: organizationId (required), body.
gitbook_list_change_requests_for_spaceList all change requestsBRead-onlyIdempotent
List all change requests. (GET /spaces/{spaceId}/change-requests)
Inputs: spaceId (required), body.
gitbook_list_commenters_in_change_requestList all users who commented in a CRARead-onlyIdempotent
List all users who commented in a CR. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/commenters)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_list_commenters_in_spaceList all users who commented in a spaceARead-onlyIdempotent
List all users who commented in a space. (GET /spaces/{spaceId}/commenters)
Inputs: spaceId (required), body.
gitbook_list_comment_replies_in_change_requestList all change request comment repliesARead-onlyIdempotent
List all change request comment replies. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies)
Inputs: spaceId (required), changeRequestId (required), commentId (required), body.
gitbook_list_comment_replies_in_spaceList all space comment repliesBRead-onlyIdempotent
List all space comment replies. (GET /spaces/{spaceId}/comments/{commentId}/replies)
Inputs: spaceId (required), commentId (required), body.
gitbook_list_comments_in_change_requestList all change request commentsARead-onlyIdempotent
List all change request comments. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/comments)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_list_comments_in_spaceList all space commentsARead-onlyIdempotent
List all space comments. (GET /spaces/{spaceId}/comments)
Inputs: spaceId (required), body.
gitbook_list_filesList all space filesARead-onlyIdempotent
List all space files. (GET /spaces/{spaceId}/content/files)
Inputs: spaceId (required), body.
gitbook_list_files_in_change_request_by_idList all change request filesARead-onlyIdempotent
List all change request files. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/files)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_list_files_in_revision_by_idList all space revision filesARead-onlyIdempotent
List all space revision files. (GET /spaces/{spaceId}/revisions/{revisionId}/files)
Inputs: spaceId (required), revisionId (required), body.
gitbook_list_orgsList organizationsARead-onlyIdempotent
List organizations the authenticated user can access. Use the returned id as orgId for other tools.
Inputs: limit, cursor.
gitbook_list_page_links_in_change_requestList all change request linksARead-onlyIdempotent
List all change request links. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/page/{pageId}/links)
Inputs: spaceId (required), changeRequestId (required), pageId (required), body.
gitbook_list_page_links_in_spaceList all space page linksARead-onlyIdempotent
List all space page links. (GET /spaces/{spaceId}/content/page/{pageId}/links)
Inputs: spaceId (required), pageId (required), body.
gitbook_list_pagesList pages in a spaceARead-onlyIdempotent
List the page tree of a space's current revision (page ids, titles, paths). Not paginated.
Inputs: spaceId (required).
gitbook_list_pages_in_change_requestList all change request pagesARead-onlyIdempotent
List all change request pages. (GET /spaces/{spaceId}/change-requests/{changeRequestId}/content/pages)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_list_pages_in_revision_by_idList all pages in a space revisionARead-onlyIdempotent
List all pages in a space revision. (GET /spaces/{spaceId}/revisions/{revisionId}/pages)
Inputs: spaceId (required), revisionId (required), body.
gitbook_list_revision_page_meta_linksList all meta links for a revision pageBRead-onlyIdempotent
List all meta links for a revision page. (GET /spaces/{spaceId}/revisions/{revisionId}/page/{pageId}/meta-links)
Inputs: spaceId (required), revisionId (required), pageId (required).
gitbook_list_space_file_backlinksList all space file backlink locationsBRead-onlyIdempotent
List all space file backlink locations. (GET /spaces/{spaceId}/content/files/{fileId}/backlinks)
Inputs: spaceId (required), fileId (required), body.
gitbook_list_space_linksGet all links in a space including their status and location where they appear.CRead-onlyIdempotent
Get all links in a space including their status and location where they appear.. (GET /spaces/{spaceId}/links)
Inputs: spaceId (required), body.
gitbook_list_space_page_backlinksList all space page backlink locationsARead-onlyIdempotent
List all space page backlink locations. (GET /spaces/{spaceId}/content/page/{pageId}/backlinks)
Inputs: spaceId (required), pageId (required), body.
gitbook_list_space_page_meta_linksList all meta links for a space pageARead-onlyIdempotent
List all meta links for a space page. (GET /spaces/{spaceId}/content/page/{pageId}/meta-links)
Inputs: spaceId (required), pageId (required).
gitbook_list_spacesList spaces in an organizationARead-onlyIdempotent
List the spaces inside an organization. Get orgId from gitbook_list_orgs.
Inputs: orgId (required), limit, cursor.
gitbook_merge_change_requestMerge (publish) a change requestADestructive
Publish a change request into the live space. THIS IS DESTRUCTIVE — it changes the live published docs. Only call after the change request has been reviewed.
Inputs: spaceId (required), changeRequestId (required).
gitbook_move_spaceMove a space to a new positionB
Move a space to a new position. (POST /spaces/{spaceId}/move)
Inputs: spaceId (required), body.
gitbook_post_comment_in_spaceCreate a space commentC
Create a space comment. (POST /spaces/{spaceId}/comments)
Inputs: spaceId (required), body.
gitbook_post_comment_reply_in_change_requestCreate a change request comment replyB
Create a change request comment reply. (POST /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies)
Inputs: spaceId (required), changeRequestId (required), commentId (required), body.
gitbook_post_comment_reply_in_spaceCreate a space comment replyB
Create a space comment reply. (POST /spaces/{spaceId}/comments/{commentId}/replies)
Inputs: spaceId (required), commentId (required), body.
gitbook_request_reviewers_for_change_requestRequest change request reviewersC
Request change request reviewers. (POST /spaces/{spaceId}/change-requests/{changeRequestId}/requested-reviewers)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_restore_spaceRestore a deleted spaceB
Restore a deleted space. (POST /spaces/{spaceId}/restore)
Inputs: spaceId (required).
gitbook_searchSearch contentARead-onlyIdempotent
Full-text search. Provide orgId to search an organization, or spaceId to search a single space (exactly one is required).
Inputs: query (required), orgId, spaceId, limit, +1 more.
gitbook_submit_change_request_reviewSubmit a change request reviewC
Submit a change request review. (POST /spaces/{spaceId}/change-requests/{changeRequestId}/reviews)
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_update_change_requestPull primary content into the change requestA
Pull primary content into the change request. (POST /spaces/{spaceId}/change-requests/{changeRequestId}/update)
Inputs: spaceId (required), changeRequestId (required).
gitbook_update_change_request_by_idUpdate a change requestB
Update a change request. (PATCH /spaces/{spaceId}/change-requests/{changeRequestId})
Inputs: spaceId (required), changeRequestId (required), body.
gitbook_update_comment_in_change_requestUpdate a change request commentB
Update a change request comment. (PUT /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId})
Inputs: spaceId (required), changeRequestId (required), commentId (required), body.
gitbook_update_comment_in_spaceUpdate a space commentB
Update a space comment. (PUT /spaces/{spaceId}/comments/{commentId})
Inputs: spaceId (required), commentId (required), body.
gitbook_update_comment_reply_in_change_requestUpdate a change request comment replyC
Update a change request comment reply. (PUT /spaces/{spaceId}/change-requests/{changeRequestId}/comments/{commentId}/replies/{commentReplyId})
Inputs: spaceId (required), changeRequestId (required), commentId (required), commentReplyId (required), +1 more.
gitbook_update_comment_reply_in_spaceUpdate a space comment replyB
Update a space comment reply. (PUT /spaces/{spaceId}/comments/{commentId}/replies/{commentReplyId})
Inputs: spaceId (required), commentId (required), commentReplyId (required), body.
gitbook_update_space_by_idUpdate a spaceC
Update a space. (PATCH /spaces/{spaceId})
Inputs: spaceId (required), body.
gitbook_update_user_by_idUpdate a user by its IDB
Update a user by its ID. (PATCH /users/{userId})
Inputs: userId (required), body.
gitbook_whoamiGet authenticated userARead-onlyIdempotent
Return the GitBook user the configured token authenticates as (id, name, email).
Inputs: no named parameters.
Tool Schema Changelog
Recent tool additions, removals, and schema changes observed during successful MCP inspections.
Loading tool schema changelog…
TDQS
Scored across 89 tools
Many tools have similar names (e.g., list_*_backlinks for different scopes), but descriptions help differentiate. However, with 89 tools, the sheer volume makes it hard for an agent to quickly select the right one, especially without clear categorization.
All tools adhere to a strict 'gitbook_verb_noun' pattern, with consistent use of prepositions like 'in', 'by', 'for'. No mixing of conventions, making the naming predictable across the entire set.
89 tools is excessive for a documentation tool. Many tools handle granular sub-resources (e.g., backlinks, meta-links in specific contexts) that could be consolidated. This makes the surface feel bloated and hard to navigate.
Covers most read and manage operations for spaces, change requests, comments, and files. However, direct content creation/editing is limited to an asynchronous import tool; no create/update page or document body tools exist, leaving a notable gap.
Maintenance
Related MCP Connectors
A Model Context Protocol server for Wix AI tools
Model Context Protocol server for Studex tools, notifications, and profile integrations
Model Context Protocol server for the Apideck Unified API. Connect any MCP-compatible agent framework to 100+ accounting systems, HRIS platforms, file storage providers, and more through one integration. More information https://www.apideck.com/mcp-server
A comprehensive Model Context Protocol (MCP) server that enables AI assistants to interact with yo…
Related MCP Servers
- AlicenseBqualityBmaintenanceA Model Context Protocol server for Git repository interaction and automation. This server provides tools to read, search, and manipulate Git repositories via Large Language Models.1497,509 PyPI92,139MIT
- AlicenseNot gradedqualityDmaintenanceA Model Context Protocol server that provides a standardized interface for AI models to access, query, and modify content in Notion workspaces.4MIT
- FlicenseNot gradedqualityNot gradedmaintenanceModel Context Protocol server that enables interaction with GitHub repositories, issues, pull requests, and search functionality through natural language.1-
- -licenseCqualityNot gradedmaintenanceA Model Context Protocol server with GitHub API integration that enables interaction with repositories, issues, pull requests, and file management through a standardized interface.1-