Install
Requirements
Section titled “Requirements”- Node.js 18 or newer.
- npm.
- An authorized SmartMoving External API key for real API reads.
- An MCP-compatible client if you want agent-native tools.
Install from source
Section titled “Install from source”git clone https://github.com/MattyMailers/smartmoving-mcp.gitcd smartmoving-mcp/mcp-servernpm installnpm run buildnpm testRun the MCP server manually only for diagnostics:
export SMARTMOVING_API_KEY="replace-with-your-key"export SMARTMOVING_ALLOW_WRITES="false"npm startIn normal use, your MCP client launches dist/index.js over stdio.
Future npm install
Section titled “Future npm install”After maintainers publish the package:
npm install -g smartmoving-mcp-serversmartmoving init --yes --profile default --api-key-env SMARTMOVING_API_KEYsmartmoving doctor --jsonThe package is expected to expose both binaries:
smartmoving-mcp-serversmartmovingFor one-off CLI runs:
SMARTMOVING_API_KEY="replace-with-your-key" \ npx -y --package smartmoving-mcp-server smartmoving schema --jsonFor one-off MCP server launches:
npx -y smartmoving-mcp-serverEnvironment variables
Section titled “Environment variables”| Variable | Required | Purpose |
|---|---|---|
SMARTMOVING_API_KEY | Yes | Authorized SmartMoving External API key. |
SMARTMOVING_BASE_URL | No | API base URL override. Defaults to https://api-public.smartmoving.com/v1. |
SMARTMOVING_CONFIG_PATH | No | CLI config path override for isolated profiles/tests. |
SMARTMOVING_ALLOW_WRITES | No | Enables POST/PUT/PATCH tools and commands when set to true. Defaults to read-only. |
SMARTMOVING_ALLOW_DESTRUCTIVE | No | Enables DELETE-style operations only when writes are also enabled. |
Secret handling
Section titled “Secret handling”- Put API keys in private MCP client env blocks, shell profiles, password managers, or ignored
.envfiles. - Commit only placeholders such as
replace-with-your-key. - Rotate a key immediately if it appears in GitHub, a PR comment, logs, screenshots, or chat.