Skip to main content
PUT
/
servers
/
{namespace}
/
{server}
/
deployments
JavaScript
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.deployments.deploy('server', {
  namespace: 'namespace',
  payload: 'payload',
});

console.log(response.deploymentId);
{
  "deploymentId": "123e4567-e89b-12d3-a456-426614174000",
  "status": "WORKING",
  "mcpUrl": "https://server.smithery.ai/namespace/name",
  "warnings": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Smithery API key as Bearer token

Path Parameters

​
namespace
string
required
​
server
string
required

Body

multipart/form-data
​
payload
string
required

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

​
module
file

JavaScript module file (for hosted deployments)

​
sourcemap
file

Source map file (for hosted deployments)

​
bundle
file

MCPB bundle file (for stdio deployments)

Response

Deployment accepted

​
deploymentId
string<uuid>
required

Unique identifier for this deployment.

Example:

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

​
status
string
required

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

Example:

"WORKING"

​
mcpUrl
string<uri>
required

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

Example:

"https://server.smithery.ai/namespace/name"

​
warnings
string[]

Non-fatal warnings encountered during deployment submission.