> ## Documentation Index
> Fetch the complete documentation index at: https://docs.deploxy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start

> Deploy a sample "Hello World" MCP server in less than 5 minutes and learn the fundamentals of Deploxy.

<Steps>
  <Step title="Clone the Quick Start Repository">
    This repository contains a simple "hello world" MCP server.

    ```bash theme={null}
    git clone https://github.com/deploxy/quick-start.git
    cd quick-start
    ```
  </Step>

  <Step title="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.
       ```bash .npmrc theme={null}
       //registry.npmjs.org/:_authToken=${NPM_TOKEN}
       ```

    3. **Configure Deploxy:** Create a file named `.deploxy.json`. The easiest way is to use the [Project Creator](https://deploxy.com/dashboard/new) on your dashboard and copy the generated JSON.
       Configuration looks like this:
       ```json .deploxy.json theme={null}
       {
         "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"
         }
       }
       ```

    <Warning>
      You can get your Deploxy token from the [Tokens page](https://deploxy.com/account/settings/tokens).
    </Warning>
  </Step>

  <Step title="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.

    ```bash theme={null}
    npx @deploxy/cli deploy
    ```

    <Check>
      That's it! You can monitor the deployment on your [Deploxy Dashboard](https://deploxy.com/dashboard). Once complete, you can run your new MCP server from anywhere with `npx`.
    </Check>
  </Step>
</Steps>