Shipcheck

Provides a deterministic readiness report for npm packages by auditing configuration, previewing pack contents, and explaining failures.

typescript

0

GitHub Stars

typescript

Language

4 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "mcp-tool-shop-mcp-shipcheck": {
      "command": "node",
      "args": [
        "/path/to/mcp-shipcheck/build/index.js"
      ]
    }
  }
}

Shipcheck MCP Server helps you validate npm packages’ publish readiness by producing deterministic reports. It analyzes package setup, exports, and file presence, previews the exact files that would be packed, and explains any failures with concrete fixes, all without modifying your source.

How to use

You connect to this MCP server from your MCP client to run audits, preview the tarball contents, and receive actionable guidance for fixing issues before release. Use it to reduce release anxiety by turning readiness checks into a clear, machine-checked artifact.

How to install

Prerequisites you need on your machine:

Node.js (v14+ is commonly compatible; check your project requirements)
npm (comes with Node.js installations)

Install dependencies and build the server locally. Run these commands in your terminal:

npm install
npm run build

Configuration for MCP clients

Configure your MCP client to connect to Shipcheck using a local stdio server. The server runs as a Node process and expects to be started with the specified command.

{
  "mcpServers": {
    "shipcheck": {
      "command": "node",
      "args": ["/path/to/mcp-shipcheck/build/index.js"]
    }
  }
}

Notes on usage and behavior

All tools are read-only, so they never modify your package files. You can call Shipcheck from an MCP client repeatedly to monitor readiness as you iterate on your package configuration.

Security and help

Keep your local paths and environment secure. If you use MCP in automation, prefer running in isolated environments or CI-like sandboxes to avoid unintended side effects.

Available tools

shipcheck.audit

Analyzes package.json, tsconfig.json, exports, and file existence to compute a readiness score and detailed findings.

shipcheck.packPreview

Runs a preview of what files would be included in the release tarball, with file metadata.

shipcheck.explainFailure

Provides human-friendly explanations for error codes and suggests concrete fixes.