Skip to content

About

English documentation for mcprack and its companion projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

mcprack Documentation

mcprack Documentation Packaging: deb

English documentation for mcprack — a catalog and client-configuration portal for MCP (Model Context Protocol) servers — and for the projects around it: the client sync tools, the Ansible collection and the MCP servers that ship a mcprack companion package.

Contents

  • Getting Started — what mcprack is, quickstart, installation and upgrading
  • Core Concepts — architecture, relay and tokens, access control, credentials, audit
  • How-To Guides — registering servers, granting access, connecting Claude Code and other clients, OAuth, verifying a configuration, key rotation, monitoring
  • Security — authentication, two-factor authentication, fresh re-authentication, command and URL policies, the audit mirror, an internet-exposure checklist
  • Client Tools — mcprack-client, mcprack-sync-claude, -cursor, -vscode
  • Automation — the vitexsoftware.mcprack Ansible collection
  • MCP Servers with a Companion — AbraFlexi, Datovka, filesystem, Graylog, GroupOffice, LibreNMS, Mastodon, Semaphore, Subreg, Wazuh, WebDriver
  • Reference — configuration, CLI, REST API, client formats, troubleshooting
  • Development — packaging an MCP server with a companion, contributing

Building Locally

Prerequisites

sudo apt install python3-sphinx python3-shibuya-sphinx-theme

Or with pip:

pip install -r requirements.txt

Build HTML

make html
# Output: build/html/index.html

Other formats: make epub, make latex, make text.

Debian Package

The documentation is also distributed as a Debian package (mcprack-doc) that installs the built HTML to /usr/share/doc/mcprack-doc/html/.

dpkg-buildpackage -b --no-sign
sudo apt install ./mcprack-doc_*.deb
# Browse at http://localhost/mcprack-doc/  (requires Apache or Nginx)

Apache configuration is enabled automatically on install; an Nginx snippet is installed to /usr/share/doc/mcprack-doc/mcprack-doc.nginx.

Documentation Standards

See AGENTS.md. Key rules: English only; active voice; second person; reStructuredText; always name the language of a code block; only document released, implemented behaviour.

Related Projects

Project Description
mcprack The web application, REST API and CLI
mcprack-client Shared library of the sync tools
mcprack-sync-claude Claude Desktop / Claude Code sync
mcprack-sync-cursor Cursor sync
mcprack-sync-vscode VS Code / Copilot sync
mcprack-ansible-collection Ansible collection
mcp-server-abraflexi, -datovka, -filesystem, -graylog, -groupoffice, -librenms, -mastodon, -semaphore, -subreg, -wazuh, -webdriver MCP servers with a mcprack companion package

About

English documentation for mcprack and its companion projects

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages