Skip to content

Contributor Guide

User documentation intentionally focuses on installing and using the MCP server. Development material is grouped here.

Sections

  • Development for local setup and package structure.
  • Testing for unit, integration, Docker, npm package, and parity checks.
  • Architecture for the bridge runtime design.
  • Release for repository settings and publish workflows.
  • Contributing for project workflow.

Required Local Check

npm run check

Run the full check before committing. Docker parity is heavier and can be run with:

npm run docker:build
npm run bridge:compare -- cloakbrowser-mcp:dev --report bridge-parity-report.json

Metadata and production dependency checks can be run directly with:

npm run server:validate
npm run audit:prod