bookstack-mcp

Projects that follow the best practices below can voluntarily self-certify and show that they've achieved an Open Source Security Foundation (OpenSSF) best practices badge.

There is no set of practices that can guarantee that software will never have defects or vulnerabilities; even formal methods can fail if the specifications or assumptions are wrong. Nor is there any set of practices that can guarantee that a project will sustain a healthy and well-functioning development community. However, following best practices can help improve the results of projects. For example, some practices enable multi-person review before release, which can both help find otherwise hard-to-find technical vulnerabilities and help build trust and a desire for repeated interaction among developers from different companies. To earn a badge, all MUST and MUST NOT criteria must be met, all SHOULD criteria must be met OR be unmet with justification, and all SUGGESTED criteria must be met OR unmet (we want them considered at least). If you want to enter justification text as a generic comment, instead of being a rationale that the situation is acceptable, start the text block with '//' followed by a space. Feedback is welcome via the GitHub site as issues or pull requests There is also a mailing list for general discussion.

We gladly provide the information in several locales, however, if there is any conflict or inconsistency between the translations, the English version is the authoritative version.
If this is your project, please show your baseline badge status on your project page! The baseline badge status looks like this: Baseline badge level for project 12116 is baseline-3 Here is how to embed the baseline badge:
You can show your baseline badge status by embedding this in your markdown file:
[![OpenSSF Baseline](https://www.bestpractices.dev/projects/12116/baseline)](https://www.bestpractices.dev/projects/12116)
or by embedding this in your HTML:
<a href="https://www.bestpractices.dev/projects/12116"><img src="https://www.bestpractices.dev/projects/12116/baseline"></a>


These are the Baseline Level 1 criteria. These criteria are from baseline version v2025.10.10 with updated criteria text from version v2026.02.19. Criteria that are new in version v2026.02.19 are labeled "future" and will begin to be enforced starting 2026-06-01. Please provide answers to the "future" criteria before that date.

Baseline Series: Baseline Level 1 Baseline Level 2 Baseline Level 3

        

 Basics

  • General

    Note that other projects may use the same name.

    BookStack stores your team's knowledge — but AI assistants can't access it without an integration. BookStack MCP Server bridges that gap, connecting AI assistants (Claude Desktop, LibreChat, and any MCP-compatible client) directly to your BookStack instance so they can search, read, and manage your documentation through natural language.

    Please use SPDX license expression format; examples include "Apache-2.0", "BSD-2-Clause", "BSD-3-Clause", "GPL-2.0+", "LGPL-3.0+", "MIT", and "(BSD-2-Clause OR Ruby)". Do not include single quotes or double quotes.
    If there is more than one language, list them as comma-separated values (spaces optional) and sort them from most to least used. If there is a long list, please list at least the first three most common ones. If there is no language (e.g., this is a documentation-only or test-only project), use the single character "-". Please use a conventional capitalization for each language, e.g., "JavaScript".
    The Common Platform Enumeration (CPE) is a structured naming scheme for information technology systems, software, and packages. It is used in a number of systems and databases when reporting vulnerabilities.

 Controls 25/25 ●

  • Controls


    Enough for a badge!

    When a user attempts to read or modify a sensitive resource in the project's authoritative repository, the system MUST require the user to complete a multi-factor authentication process. [OSPS-AC-01.01]
    Enforce multi-factor authentication for the project's version control system, requiring collaborators to provide a second form of authentication when accessing sensitive data or modifying repository settings. Passkeys are acceptable for this control.

    GitHub requires 2FA as of March 2023.


    Enough for a badge!

    When a new collaborator is added, the version control system MUST require manual permission assignment, or restrict the collaborator permissions to the lowest available privileges by default. [OSPS-AC-02.01]
    Most public version control systems are configured in this manner. Ensure the project's version control system always assigns the lowest available permissions to collaborators by default when added, granting additional permissions only when necessary.

    GitHub is the version control platform. New collaborators added to the repository default to Read access (the lowest available privilege level) unless explicitly granted higher permissions. Write, Triage, Maintain, or Admin access must be assigned manually. This is GitHub's default behaviour and requires no additional configuration.


    Enough for a badge!

    When a direct commit is attempted on the project's primary branch, an enforcement mechanism MUST prevent the change from being applied. [OSPS-AC-03.01]
    If the VCS is centralized, set branch protection on the primary branch in the project's VCS. Alternatively, use a decentralized approach, like the Linux kernel's, where changes are first proposed in another repository, and merging changes into the primary repository requires a specific separate act.

    GitHub branch protection rules are configured on main to require pull requests before merging, blocking direct pushes. The rule "Do not allow bypassing the above settings" is enabled, preventing administrators from bypassing the restriction. All changes must go through a pull request.


    Enough for a badge!

    When an attempt is made to delete the project's primary branch, the version control system MUST treat this as a sensitive activity and require explicit confirmation of intent. [OSPS-AC-03.02]
    Set branch protection on the primary branch in the project's version control system to prevent deletion.

    GitHub prevents deletion of protected branches by default. The main branch has branch protection rules enabled, which blocks deletion. Attempting to delete main via the UI or API returns an error; explicit removal of the branch protection rule is required before deletion is possible.


    Enough for a badge!

    When a CI/CD pipeline operates on untrusted metadata, those parameters MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.01]
    CI/CD pipelines should sanitize (quote, escape or exit on expected values) all metadata inputs which correspond to untrusted sources. This includes data such as branch names, commit messages, tags, pull request titles, and author information.

    The CI/CD pipelines consume only structured, GitHub-controlled metadata — specifically github.event.pull_request.number (an integer assigned by GitHub) and the VERSION string extracted from packages/stdio/package.json via jq. No user-supplied free-text fields (PR titles, commit messages, branch names) are interpolated into shell commands. The PR number is used only to construct Docker image tag suffixes (e.g. pr-42-amd64), which are validated as existing registry tags before use. The version string from package.json is extracted with jq -r '.version' and used in docker buildx imagetools commands. Neither value is passed to eval or used in contexts where injection is possible.


    Enough for a badge!

    (Future criterion) When a CI/CD pipeline operates on untrusted code snapshots, it MUST prevent access to privileged CI/CD credentials and assets. [OSPS-BR-01.03]
    CI/CD pipelines should isolate untrusted code snapshots from privileged credentials and assets. In particular, projects should be careful to ensure that workflows which build or execute code prior to review by a collaborator do not have access to CI/CD credentials.

    Fork PRs are explicitly isolated from privileged credentials. The pre-merge-cd-check job (which pushes images to GHCR and uses GITHUB_TOKEN) is conditioned on github.event.pull_request.head.repo.full_name == github.repository, so it never runs for fork-originated PRs. The build-and-push job sets push: ${{ github.event_name != 'pull_request' }}, meaning no image is pushed during any PR build — registry credentials are not exercised on untrusted code. Fork PRs trigger only a credential-free build to validate the Dockerfile compiles, which GitHub Actions automatically handles by providing a read-only, scoped GITHUB_TOKEN with no push permissions to the upstream registry.


    Enough for a badge!

    When the project lists a URI as an official project channel, that URI MUST be exclusively delivered using encrypted channels. [OSPS-BR-03.01]
    Configure the project's websites and version control systems to use encrypted channels such as SSH or HTTPS for data transmission. Ensure all tools and domains referenced in project documentation can only be accessed via encrypted channels.

    Project URLs use HTTPS exclusively.


    Enough for a badge!

    When the project lists a URI as an official distribution channel, that channel MUST be protected from adversary-in-the-middle attacks using cryptographically authenticated channels. [OSPS-BR-03.02]
    Artifacts distributed by the project should be distributed through channels which ensure integrity and authenticity. Use of HTTPS for downloads, signed releases, or distribution through trusted package managers are all acceptable methods to protect against adversary-in-the-middle attacks.

    Distribution channels use HTTPS exclusively.


    Enough for a badge!

    The project MUST prevent the unintentional storage of unencrypted sensitive data, such as secrets and credentials, in the version control system. [OSPS-BR-07.01]
    Configure .gitignore or equivalent to exclude files that may contain sensitive information. Use pre-commit hooks and automated scanning tools to detect and prevent the inclusion of sensitive data in commits.

    The repository contains no credentials or secrets. All sensitive values (BOOKSTACK_BASE_URL, BOOKSTACK_TOKEN_ID, BOOKSTACK_TOKEN_SECRET, GITHUB_TOKEN) are supplied exclusively via environment variables at runtime or GitHub Actions secrets — never hardcoded in source. .gitignore excludes .env files. CI workflows reference secrets only through the ${{ secrets.* }} context, which GitHub masks in logs and never persists to the repository. CodeQL scanning runs on every PR and would flag any hardcoded credentials committed to the codebase.


    Enough for a badge!

    When the project has made a release, the project documentation MUST include user guides for all basic functionality. [OSPS-DO-01.01]
    Create user guides or documentation for all basic functionality of the project, explaining how to install, configure, and use the project's features. If there are any known dangerous or destructive actions available, include highly-visible warnings.

    https://github.com/paradoxbound/bookstack-mcp/blob/main/README.md
    The documentation contains basic details of all features and functionality


    Enough for a badge!

    When the project has made a release, the project documentation MUST include a guide for reporting defects. [OSPS-DO-02.01]
    It is recommended that projects use their VCS default issue tracker. If an external source is used, ensure that the project documentation and contributing guide clearly and visibly explain how to use the reporting system. It is recommended that project documentation also sets expectations for how defects will be triaged and resolved.

    Non-trivial SECURITY[.md] file found file in repository: https://github.com/paradoxbound/bookstack-mcp/blob/main/SECURITY.md.


    Enough for a badge!

    While active, the project MUST have one or more mechanisms for public discussions about proposed changes and usage obstacles. [OSPS-GV-02.01]
    Establish one or more mechanisms for public discussions within the project, such as mailing lists, instant messaging, or issue trackers, to facilitate open communication and feedback.

    GitHub supports public discussions on proposed changes (via pull requests) and usage obstacles (via issues).


    Enough for a badge!

    While active, the project documentation MUST include an explanation of the contribution process. [OSPS-GV-03.01]
    Create a CONTRIBUTING.md or CONTRIBUTING/ directory to outline the contribution process including the steps for submitting changes, and engaging with the project maintainers.

    Contribution process documented in repository.


    Enough for a badge!

    While active, the license for the source code MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.01]
    Add a LICENSE file to the project's repo with a license that is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Releasing to the public domain meets this control if there are no other encumbrances such as patents.

    The project is licensed under the MIT License (LICENSE file in the repository root). MIT is approved by both the Open Source Initiative (OSI) and qualifies under the Free Software Foundation (FSF) Free Software Definition.


    Enough for a badge!

    While active, the license for the released software assets MUST meet the OSI Open Source Definition or the FSF Free Software Definition. [OSPS-LE-02.02]
    If a different license is included with released software assets, ensure it is an approved license by the Open Source Initiative (OSI), or a free license as approved by the Free Software Foundation (FSF). Examples of such licenses include the MIT, BSD 2-clause, BSD 3-clause revised, Apache 2.0, Lesser GNU General Public License (LGPL), and the GNU General Public License (GPL). Note that the license for the released software assets may be different than the source code.

    Released software assets are published to GitHub Container Registry (GHCR) as Docker images. The source code they are built from is MIT-licensed. MIT is OSI-approved and FSF-qualified. The license file is included in the repository and applies to all released artifacts derived from the source.


    Enough for a badge!

    While active, the license for the source code MUST be maintained in the corresponding repository's LICENSE file, COPYING file, or LICENSE/ directory. [OSPS-LE-03.01]
    Include the project's source code license in the project's LICENSE file, COPYING file, or LICENSE/ directory to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    License file found in repository.


    Enough for a badge!

    While active, the license for the released software assets MUST be included in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets. [OSPS-LE-03.02]
    Include the project's released software assets license in the released source code, or in a LICENSE file, COPYING file, or LICENSE/ directory alongside the corresponding release assets to provide visibility and clarity on the licensing terms. The filename MAY have an extension. If the project has multiple repositories, ensure that each repository includes the license file.

    The MIT License is maintained in the LICENSE file at the repository root.
    https://github.com/paradoxbound/bookstack-mcp/blob/main/LICENSE


    Enough for a badge!

    While active, the project's source code repository MUST be publicly readable at a static URL. [OSPS-QA-01.01]
    Use a common VCS such as GitHub, GitLab, or Bitbucket. Ensure the repository is publicly readable. Avoid duplication or mirroring of repositories unless highly visible documentation clarifies the primary source. Avoid frequent changes to the repository that would impact the repository URL. Ensure the repository is public.

    Repository is publicly available on GitHub.


    Enough for a badge!

    The version control system MUST contain a publicly readable record of all changes made, who made the changes, and when the changes were made. [OSPS-QA-01.02]
    Use a common VCS such as GitHub, GitLab, or Bitbucket to maintain a publicly readable commit history. Avoid squashing or rewriting commits in a way that would obscure the author of any commits.

    Repository git metadata is publicly available on GitHub.


    Enough for a badge!

    When the package management system supports it, the source code repository MUST contain a dependency list that accounts for the direct language dependencies. [OSPS-QA-02.01]
    This may take the form of a package manager or language dependency file that enumerates all direct dependencies such as package.json, Gemfile, or go.mod.

    This is a Node.js/npm monorepo. Direct dependencies for each package are declared in packages/core/package.json and packages/stdio/package.json. The full transitive dependency tree is locked in package-lock.json at the repository root. npm enforces this structure natively.


    Enough for a badge!

    Projects with multiple repositories MUST document a list of codebases that are part of the project. [OSPS-QA-04.01]
    Document any additional subproject code repositories produced by the project and compiled into a release. This documentation should include the status and intent of the respective codebase.

    This project has a single repository at https://github.com/paradoxbound/bookstack-mcp. There are no additional codebases or repositories that form part of the project.


    Enough for a badge!

    While active, the version control system MUST NOT contain generated executable artifacts. [OSPS-QA-05.01]
    Remove generated executable artifacts in the project's version control system. It is recommended that any scenario where a generated executable artifact appears critical to a process such as testing, it should be instead be generated at build time or stored separately and fetched during a specific well-documented pipeline step.

    The dist/ directory (TypeScript compilation output) is listed in .gitignore and is never committed to the repository. All compiled JavaScript artifacts are produced at build time by CI and are not tracked in version control. Only TypeScript source files are committed.


    Enough for a badge!

    While active, the version control system MUST NOT contain unreviewable binary artifacts. [OSPS-QA-05.02]
    Do not add any unreviewable binary artifacts to the project's version control system. This includes executable application binaries, library files, and similar artifacts. It does not include assets such as graphical images, sound or music files, and similar content typically stored in a binary format.

    The repository contains no binary artifacts. All committed files are human-readable text: TypeScript source, JSON configuration, YAML workflow definitions, and Markdown documentation. Compiled JavaScript (dist/) and node_modules/ are excluded via .gitignore and never committed.


    Enough for a badge!

    While active, the project documentation MUST contain security contacts. [OSPS-VM-02.01]
    Create a security.md (or similarly-named) file that contains security contacts for the project.

    SECURITY.md at the repository root documents how to report security vulnerabilities privately via GitHub's Security Advisory feature, and provides the direct URL (https://github.com/paradoxbound/bookstack-mcp/security/advisories/new). It also specifies a 7-day acknowledgement commitment and a 30-day patch commitment.


    Enough for a badge!

    (Obsolete criterion) When a CI/CD pipeline uses a branch name in its functionality, that name value MUST be sanitized and validated prior to use in the pipeline. [OSPS-BR-01.02]

    Branch names are not used as inputs to shell commands or pipeline logic. The workflows trigger on push to main and pull_request events; the branch context is used only by GitHub Actions' own trigger evaluation, not interpolated into shell scripts or used to construct executable commands. No branch name sanitization is required because branch names are never passed to eval, run steps, or similar execution contexts.



This data is available under the Community Data License Agreement – Permissive, Version 2.0 (CDLA-Permissive-2.0). This means that a Data Recipient may share the Data, with or without modifications, so long as the Data Recipient makes available the text of this agreement with the shared Data. Please credit Jim Bailey and the OpenSSF Best Practices badge contributors.

Project badge entry owned by: Jim Bailey.
Entry created on 2026-03-08 10:20:21 UTC, last updated on 2026-03-10 14:13:23 UTC. Last achieved passing badge on 2026-03-10 14:13:23 UTC.