Update Server

Update metadata and configuration of an existing MCP server

PUT /servers/:name

Update Server

cURL

curl --request PUT \
  --url https://api.example.com/servers/:name \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "description": "<string>",
  "license": "<string>",
  "repository": {
    "type": "<string>",
    "url": "<string>"
  },
  "pricing": {
    "currency": "<string>",
    "amount": 123
  },
  "metadata": {
    "tags": [
      {}
    ],
    "homepage": "<string>"
  }
}
'

200 Success

{
  "success": true,
  "data": {
    "name": "weather-mcp",
    "version": "1.3.0",
    "updated_at": "2025-12-09T10:30:00Z",
    "changes": ["version", "description", "metadata"],
    "rescanRequired": false,
    "message": "Server updated successfully"
  },
  "meta": {
    "timestamp": "2025-12-09T10:30:00Z",
    "version": "v1",
    "requestId": "req_xyz789"
  }
}

Endpoint

PUT https://api.superbox.ai/api/v1/servers/:name

Authentication

Required

This endpoint requires authentication. You must be the server owner.

Path Parameters

name · string · required

Unique server identifier to update Example: weather-mcp, database-query-mcp

Request Body

All fields are optional. Only include fields you want to update.

version · string

New semantic version number Format: MAJOR.MINOR.PATCH Rules: - Must be greater than current version - Follow semantic versioning Example: 1.2.0 → 1.3.0

description · string

Updated description Length: 20-500 characters

license · string

Updated software license Examples: MIT, Apache-2.0, GPL-3.0

repository · object

Updated repository information

Show properties

type · string

Repository type

url · string

New repository URL (must be public)

Changing repository URL will trigger a new security scan

pricing · object

Updated pricing configuration

Show properties

currency · string

Currency code

amount · number

New price amount

Pricing changes take effect immediately for new users

metadata · object

Optional metadata updates

Show properties

tags · array

Updated topic tags

homepage · string

Updated homepage URL

Response

success · boolean

Indicates if update was successful

data · object

Updated server information

Show properties

name · string

Server identifier

version · string

Updated version

updated_at · string

ISO 8601 timestamp of update

changes · array

List of fields that were updated

rescanRequired · boolean

Whether a new security scan was triggered

Examples

cURL
# Update version and description
curl -X PUT "https://api.superbox.ai/api/v1/servers/weather-mcp" \
  -H "Authorization: Bearer $SUPERBOX_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "version": "1.3.0",
    "description": "Enhanced weather server with 10-day forecasts"
  }'

# Update pricing

curl -X PUT "https://api.superbox.ai/api/v1/servers/weather-mcp" \
 -H "Authorization: Bearer $SUPERBOX_API_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
"pricing": {
"currency": "USD",
"amount": 4.99
}
}'

# Update multiple fields

curl -X PUT "https://api.superbox.ai/api/v1/servers/weather-mcp" \
 -H "Authorization: Bearer $SUPERBOX_API_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{
"version": "2.0.0",
"description": "Major update with new features",
"metadata": {
"tags": ["weather", "forecast", "climate"],
"homepage": "https://weather-mcp.dev"
}
}'

Response Examples

200 Success

{
  "success": true,
  "data": {
    "name": "weather-mcp",
    "version": "1.3.0",
    "updated_at": "2025-12-09T10:30:00Z",
    "changes": ["version", "description", "metadata"],
    "rescanRequired": false,
    "message": "Server updated successfully"
  },
  "meta": {
    "timestamp": "2025-12-09T10:30:00Z",
    "version": "v1",
    "requestId": "req_xyz789"
  }
}

Update Scenarios

Version Bump

When to bump versions:

• Patch (1.0.0 → 1.0.1): Bug fixes, minor changes
• Minor (1.0.0 → 1.1.0): New features, backward compatible
• Major (1.0.0 → 2.0.0): Breaking changes

// Patch version
await fetch(url, {
  method: 'PUT',
  headers,
  body: JSON.stringify({ version: '1.0.1' })
});

Pricing Changes

Common scenarios:

• Making a paid server free
• Adding premium pricing
• Adjusting based on features

// Make server free
await fetch(url, {
  method: 'PUT',
  headers,
  body: JSON.stringify({
    pricing: { currency: 'USD', amount: 0 }
  })
});

Existing users keep their current pricing

Description Updates

Best practices:

• Keep it clear and concise
• Highlight new features
• Update for major versions

requests.put(url, headers=headers, json={
    'description': 'Now with 10-day forecasts and weather alerts!'
})

Repository Migration

When migrating repositories:

• Set up repository redirects
• Update documentation
• Notify users
• Triggers new security scan

await fetch(url, {
  method: 'PUT',
  headers,
  body: JSON.stringify({
    repository: {
      type: 'git',
      url: 'https://github.com/new-org/weather-mcp'
    }
  })
});

Repository changes trigger a new security scan

Field-Specific Rules

Version

Rules: - Must follow semver format - Must be greater than current version - Cannot downgrade Valid: - 1.0.0 → 1.0.1 - 1.0.0 → 1.1.0 - 1.9.9 → 2.0.0 Invalid: - 1.1.0 → 1.0.0 (downgrade) - 1.0.0 → 1.0 (invalid format)

Description

Rules: - 20-500 characters - No profanity or spam - Describe functionality clearly Good: "Get real-time weather data, 10-day forecasts, and severe weather alerts for any location" Too short: "Weather tool" (invalid)

Pricing

Rules: - Amount: 0 to 999.99 - Currency: Valid ISO 4217 code - Can change anytime Effects: - Immediate for new users - Existing users unaffected - Display updated on server page

Repository

Rules: - Must be publicly accessible - Must be valid Git URL - Triggers new security scan Side effects: - Server temporarily unavailable during scan - Deployment may be rejected if scan fails - Takes 1-2 minutes

Best Practices

Semantic Versioning

Follow semver strictly to communicate changes clearly to users

Document Changes

Update your README and changelog when making updates

Test Before Update

Test changes in your repository before updating the server

Notify Users

For breaking changes, notify users through your communication channels

Gradual Pricing

If adding pricing, consider a gradual introduction

Backup First

Keep backups of working versions before major updates

Update Strategies

Rolling Updates

Update incrementally for minimal disruption:

// Week 1: Update description
await updateServer({ description: 'New features coming!' });

// Week 2: Bump version after testing
await updateServer({ version: '1.1.0' });

// Week 3: Adjust pricing if needed
await updateServer({
  pricing: { currency: 'USD', amount: 4.99 }
});

Major Release

For major updates, bundle all changes:

await updateServer({
  version: '2.0.0',
  description: 'Complete rewrite with new features',
  repository: {
    type: 'git',
    url: 'https://github.com/user/server-v2'
  },
  metadata: {
    tags: ['weather', 'v2', 'enhanced']
  }
});

Repository changes trigger security rescanning

Emergency Fixes

For urgent bug fixes:

// Quick patch
await updateServer({
  version: '1.0.1',
  description: 'Critical bug fix for API rate limiting'
});

Patch versions can be deployed quickly

Monitoring Updates

Track update status:

JavaScript
async function monitorUpdate(serverName) {
  const response = await fetch(
    `https://api.superbox.ai/api/v1/servers/${serverName}`,
    {
      headers: {
        'Authorization': `Bearer ${process.env.SUPERBOX_API_TOKEN}`
      }
    }
  );
  
  const { data } = await response.json();
  
  console.log(`Current version: ${data.version}`);
  console.log(`Last updated: ${data.updated_at}`);
  
  if (data.security_report?.metadata.scan_date) {
    console.log(`Last scanned: ${data.security_report.metadata.scan_date}`);
  }
}

Common Errors

Version Conflict

Error: New version must be greater than current version Solution: Check current version first, then increment appropriately javascript const current = await getCurrentVersion('weather-mcp'); const [major, minor, patch] = current.split('.').map(Number); const newVersion = `${major}.$ {minor}.${patch + 1}`;

Unauthorized

Error: You don’t have permission to update this server Solution: Ensure you’re the server owner and using the correct token

Invalid Repository

Error: Unable to access new repository URL Solution: Verify the repository is public and URL is correct

Related Endpoints

Get Server

View current server details

Create Server

Deploy a new server

Delete Server

Remove a server

Keep your servers up-to-date with regular version bumps and improvements!