Prerequisites

• Supported OS: macOS (tested), Linux (expected), Windows (expected)

• Node.js: 22.x or higher (LTS recommended)

• npm: Latest version

• GitBook API token:

Installation

Development

Debugging

VS Code MCP Integration (Development)

To use this MCP server in VS Code for development:

• Use node as the command when running locally. The first argument should be the path to the compiled JavaScript output (e.g., dist/index.js).

For production or published usage, use npx instead of node:

Testing

There are currently no unit or integration tests; running npm run test only checks that the TypeScript code compiles successfully.

Contributing

1. Fork the repository

2. Create a feature branch

3. Make your changes

4. Submit a pull request

A Model Context Protocol (MCP) server that provides access to GitBook's API for AI assistants and LLM applications.

Reference Documentation

• API

This section provides reference instructions for setting up the GitBook MCP server in popular AI clients. Use these configuration snippets to connect the MCP server to your preferred environment.

GitHub Copilot (VS Code)

Add the following to your VS Code MCP settings:

Claude Desktop

Add to your Claude Desktop configuration (~/Library/Application Support/Claude/claude_desktop_config.json on macOS):

JetBrains IDEs (GitHub Copilot plugin)

Add to your GitHub Copilot MCP settings for JetBrains IDEs (e.g., ~/.config/github-copilot/intellij/mcp.json):

JetBrains AI Assistant

Add to your JetBrains AI Assistant MCP configuration (see JetBrains documentation for the exact path):

• Replace your_organization_id_here and gb_api_your_token_here with your actual credentials.

• For more details, see the .

• To obtain your credentials, see the .

Common Issues

• Token Issues: Ensure token starts with gb_live_, is not expired, and has correct permissions.

• ID Resolution: Use list_organizations and list_spaces to find valid IDs.

• Configuration Issues: Verify environment variables and CLI arguments.

1.0.0 (2025-06-13)

• First public release

• Implements all documented tools and prompts

• Supports configuration via CLI, environment, and config files

• Includes error handling and troubleshooting reference

Environment Variables

• Environment variables can be set in .env.local, .env, or your system environment.

CLI Arguments

Example:

Configuration Files

The following files can be used to provide project-based configuration context:

• .github/copilot-instructions.md

• .cursorrules

• .cursor/rules/rules.md

Format Example:

Precedence

Configuration precedence (highest to lowest):

1. CLI Arguments

2. Configuration Files

3. Environment Variables

Default Parameter Behavior

When GITBOOK_ORGANIZATION_ID or GITBOOK_SPACE_ID are configured:

• Tools with optional ID parameters can omit them

• Configured defaults are used automatically

• Explicit parameters override defaults

Tools

Organization Discovery

List Organizations (list_organizations)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Lists all accessible GitBook organizations.

• Parameters: None

• Returns:

Space Management

List Spaces (list_spaces)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Lists spaces, optionally filtered by organization.

• Parameters:

  • organizationId

Get Space Details (get_space)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves detailed information about a specific space.

• Parameters:

  • spaceId

Get Space Content (get_space_content)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves the content structure and pages of a space.

• Parameters:

  • spaceId

Search Content (search_content)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Searches for content within a space using full-text search.

• Parameters:

  • query

Content Retrieval

Get Page Content (get_page_content)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves the content of a specific page.

• Parameters:

  • pageId

Get Page by Path (get_page_by_path)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves page content using the page path.

• Parameters:

  • pagePath

File Management

Get Space Files (get_space_files)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Lists all files in a space.

• Parameters:

  • spaceId

Get File Details (get_file)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves details of a specific file.

• Parameters:

  • fileId

Collection Management

List Collections (list_collections)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Lists all accessible collections.

• Parameters:

  • organizationId

Get Collection Details (get_collection)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Retrieves details of a specific collection.

• Parameters:

  • collectionId

Get Collection Spaces (get_collection_spaces)

• Behavior: 📖 Read-only, 🔄 Idempotent, 🌐 Open-world

• Description: Lists all spaces within a collection.

• Parameters:

  • collectionId

Prompts

Fetch Documentation (fetch_documentation)

• Description: Fetches and analyzes GitBook documentation content for specific topics.

• Parameters:

  • topic (required): The topic or subject to search for and analyze

Analyze Content Gaps (analyze_content_gaps)

• Description: Identifies gaps and missing content in documentation.

• Parameters:

  • spaceId (optional): The ID of the space to analyze (uses default if configured)

Content Audit (content_audit)

• Description: Performs quality audits of documentation content.

• Parameters:

  • spaceId (optional): The ID of the space to audit (uses default if configured)

Documentation Summary (documentation_summary)

• Description: Generates comprehensive summaries of GitBook spaces.

• Parameters:

  • spaceId (optional): The ID of the space to summarize (uses default if configured)

Content Optimization (content_optimization)

• Description: Optimizes content for SEO, readability, structure, or performance.

• Parameters:

  • spaceId (optional): The ID of the space to optimize (uses default if configured)