Publish a server

Submit a release via multipart form. Supports hosted (JS module upload), external (URL), and stdio (MCPB bundle) release types.

PUT /servers/{qualifiedName}/releases

JavaScript

JavaScript

import fs from 'fs';
import Smithery from '@smithery/api';

const client = new Smithery({
  apiKey: process.env['SMITHERY_API_KEY'], // This is the default and can be omitted
});

const response = await client.servers.releases.deploy('qualifiedName', { payload: 'payload' });

console.log(response.deploymentId);

202

{
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "WORKING",
  "mcpUrl": "https://slug.run.tools",
  "warnings": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Smithery API key as Bearer token

Path Parameters

qualifiedName · string · required

The server's qualified name (e.g. 'namespace/server' or 'namespace' for namespace-only servers). Use %2F to encode the slash.

Body

multipart/form-data

payload · string · required

JSON-encoded release payload. See DeployPayload schema for structure.

module · file

JavaScript module file (for hosted releases)

sourcemap · file

Source map file (for hosted releases)

bundle · file

MCPB bundle file (for stdio releases)

Response

202

application/json

Release accepted

deploymentId · string<uuid> · required

Unique identifier for this release.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Example:

"123e4567-e89b-12d3-a456-426614174000"

status · string · required

Initial status. Will be WORKING while the release is in progress.

Example:

"WORKING"

mcpUrl · string<uri> · required

The MCP endpoint URL for connecting to this server once published.

Example:

"https://slug.run.tools"

warnings · string[]

Non-fatal warnings encountered during submission.