Skip to main content
1

Clone the Quick Start Repository

This repository contains a simple “hello world” MCP server.
git clone https://github.com/deploxy/quick-start.git
cd quick-start
2

Configure Your Project

Next, you’ll configure the project with your details.
  1. Set Package Name: Open package.json and change the name to something unique that you can publish on NPM, like @your-npm-username/my-first-deploxy-server.
  2. Configure NPM Auth: Create a file named .npmrc in the project root. It’s a critical security practice to use an environment variable for your token.
    .npmrc
    //registry.npmjs.org/:_authToken=${NPM_TOKEN}
  3. Configure Deploxy: Create a file named .deploxy.json. The easiest way is to use the Project Creator on your dashboard and copy the generated JSON. Configuration looks like this:
    .deploxy.json
    {
  "authToken": "YOUR_DEPLOXY_AUTH_TOKEN",
  "defaultDeployRegion": "us-east-1",
  "stdioArgsIndex": "--args",
  "packageType": "js",
  "nodejsRuntime": "nodejs22x",
  "memorySizeMB": 256,
  "injectedEnv": {
    "DATABASE_URL": "YOU_CAN_HANDLE_ANY_SECRET",
    "ANY_API_KEY": "IN_YOUR_STDIO_MCP_SERVER"
  }
}
You can get your Deploxy token from the Tokens page.
3

Deploy with Deploxy

Now, run the deploy command. This single command will securely upload your server, build it, deploy it globally, and publish the lightweight proxy package to NPM.
npx @deploxy/cli deploy
That’s it! You can monitor the deployment on your Deploxy Dashboard. Once complete, you can run your new MCP server from anywhere with npx.