Skip to content

installation.md

Latest commit

 

History

History
118 lines (82 loc) · 3.16 KB

installation.md

File metadata and controls

118 lines (82 loc) · 3.16 KB
Raw

Installation

Install Safe Docx before adding it to an MCP client. This separates package review from execution and avoids downloading an unpinned package each time the server starts.

Install From npm

Install the published package globally:

npm install --global @usejunior/safe-docx

Confirm the executable is available:

safe-docx --help

The package publishes both safe-docx and safedocx; use safe-docx in new configurations.

Pin A Version

For controlled environments, inspect the available version and install it explicitly:

npm view @usejunior/safe-docx version
npm install --global @usejunior/safe-docx@<version>

An explicit version prevents a later release from being selected during installation. Record the chosen version in your environment configuration or deployment documentation.

Inspect Before Installing

Review the package metadata and tarball contents:

npm view @usejunior/safe-docx
npm pack @usejunior/safe-docx@<version> --dry-run

npm publishes an integrity digest with each package version and verifies downloaded tarballs during installation. In a project installation, commit package-lock.json and use npm ci to reproduce the resolved dependency tree. npm also supports registry-signature verification through npm audit signatures.

The canonical package is published on npm. Its manifest is packages/safe-docx/package.json, and the wrapper executable is packages/safe-docx/bin/safe-docx.js.

Install From Source

To review and build the repository yourself:

git clone https://github.com/UseJunior/safe-docx.git
cd safe-docx
npm ci
npm run build
node packages/safe-docx/bin/safe-docx.js --help

Check out a release tag or commit before running npm ci when reproducibility matters.

Configure An MCP Client

After a global npm install, locate the executable:

command -v safe-docx

On Windows, use where safe-docx. Configure desktop applications with the returned absolute path because they may not inherit the same PATH as an interactive terminal:

Setting Value
Command the absolute path returned by command -v safe-docx or where safe-docx
Arguments none
Transport stdio

Claude Code:

claude mcp add safe-docx -- /absolute/path/to/safe-docx

Antigravity CLI (~/.gemini/config/mcp_config.json):

{
  "mcpServers": {
    "safe-docx": {
      "command": "/absolute/path/to/safe-docx",
      "args": []
    }
  }
}

Restart agy after saving the configuration. Antigravity may ask you to approve the MCP server before first use.

JSON-based clients:

{
  "mcpServers": {
    "safe-docx": {
      "command": "/absolute/path/to/safe-docx",
      "args": []
    }
  }
}

Shell-based agents can usually invoke safe-docx directly when the global npm binary directory is already on PATH.

Update Or Remove

npm update --global @usejunior/safe-docx
npm uninstall --global @usejunior/safe-docx

Review release notes before updating a pinned or controlled installation.