registry/internal/api/handlers/v0/edit_test.go
Preeti Dewani bb84ea69e8
Publisher-managed "deleted" support (#893)
(Updated auto-generated PR description from @tadasant / Claude on Feb
22, 2026)

## Motivation and Context

Fixes #637

Server lifecycle management (deprecation and yanking) is a standard
requirement for package registries. Use cases like rebranding, security
vulnerabilities, and end-of-life servers demand the ability to mark
servers as deprecated or deleted, with optional messaging to guide
consumers toward alternatives.

## Changes

### New API endpoints

- **`PATCH /v0/servers/{serverName}/versions/{version}/status`** —
Update the lifecycle status of a single server version
- **`PATCH /v0/servers/{serverName}/status`** — Update the lifecycle
status of all versions of a server in a single transaction

Both endpoints accept:
```json
{
  "status": "active|deprecated|deleted",
  "statusMessage": "Optional message (max 500 chars) explaining the change"
}
```

### New CLI command

- **`mcp-publisher status <serverName> [version]`** — Update server
lifecycle status from the command line
  - `--status` (required): `active`, `deprecated`, or `deleted`
  - `--message`: Optional status message
- `--all-versions`: Apply to all versions of the server (replaces the
`<version>` argument)

### API response changes

`RegistryExtensions` now includes two new fields:
- `statusChangedAt` — Timestamp of the last status change
- `statusMessage` — Optional free-form message (e.g., deprecation
reason, migration guidance)

### List endpoint changes

- New `include_deleted` query parameter on `GET /v0/servers` — defaults
to `false`, hiding deleted servers from listings
- When `updated_since` is provided, `include_deleted` is automatically
set to `true` for incremental sync

### Database

- Migration `013_add_status_fields.sql`: Adds `status_changed_at` (NOT
NULL, initialized from `published_at`) and `status_message` columns to
the `servers` table

### Design decisions (from review discussion)

- **Dedicated status endpoints** rather than overloading the existing
edit endpoint
- **Bidirectional status transitions** — all transitions between
`active`, `deprecated`, and `deleted` are allowed
- **`statusMessage` as free-form text** — no structured `nextName` or
`alternativeUrl` fields (per maintainer feedback, to avoid complexity
around chaining, trust transfer, etc.)
- **Publish permission** grants status change access (not limited to
admin/edit)
- **Status message auto-cleared** when transitioning back to `active`
Good, now I have the full picture. Here's the addendum:

### Consumer-facing API changes

The new status fields live inside
`_meta["io.modelcontextprotocol.registry/official"]` on every
`ServerResponse`. This is the existing `RegistryExtensions` object — two
new fields are added alongside the existing ones:

**Before:**
```json
{
  "server": { "name": "com.example/my-server", "...": "..." },
  "_meta": {
    "io.modelcontextprotocol.registry/official": {
      "status": "active",
      "publishedAt": "2025-06-01T00:00:00Z",
      "updatedAt": "2025-06-15T00:00:00Z",
      "isLatest": true
    }
  }
}
```

**After:**
```json
{
  "server": { "name": "com.example/my-server", "...": "..." },
  "_meta": {
    "io.modelcontextprotocol.registry/official": {
      "status": "deprecated",
      "statusChangedAt": "2026-02-01T12:00:00Z",
      "statusMessage": "Deprecated in favor of com.example/my-server-v2",
      "publishedAt": "2025-06-01T00:00:00Z",
      "updatedAt": "2026-02-01T12:00:00Z",
      "isLatest": true
    }
  }
}
```

| New field | Type | Present when |
|-----------|------|-------------|
| `statusChangedAt` | `string` (RFC3339) | Always — initialized to
`publishedAt` for existing records |
| `statusMessage` | `string` (max 500 chars) | Only when set —
`null`/omitted for active servers (auto-cleared on transition to active)
|

These fields appear on **every endpoint that returns a
`ServerResponse`**: `GET /v0/servers`, `GET /v0/servers/{name}`, `GET
/v0/servers/{name}/versions/{version}`, and the new PATCH status
endpoints.

### List endpoint filtering

`GET /v0/servers` gains an `include_deleted` query parameter:

| Scenario | Behavior |
|----------|----------|
| No `include_deleted` param | Deleted servers hidden (default `false`)
|
| `include_deleted=true` | Deleted servers included in results |
| `updated_since` provided | `include_deleted` forced to `true` for
incremental sync |

## How Has This Been Tested?

- Unit tests for status handler (`status_test.go`) covering status
transitions, permission checks, validation errors, and the all-versions
endpoint
- Unit tests for the CLI command (`status_test.go`)
- Integration with existing server/edit handler tests
- Database layer tests for the new status update and query methods
- Tested locally with `make dev-compose`

## Types of changes

- [x] New feature (non-breaking change which adds functionality)

## Checklist

- [x] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [x] My code follows the repository's style guidelines
- [x] New and existing tests pass locally
- [x] I have added appropriate error handling
- [x] I have added or updated documentation as needed

## Open items from review

- [ ] `include_deleted` silent override: When `updated_since` is
provided and `include_deleted=false` is explicitly passed, should return
a 400 error rather than silently overriding
([thread](https://github.com/modelcontextprotocol/registry/pull/893#discussion_r2100879360))
— agreed upon but may not yet be implemented
2026-02-27 09:00:07 -08:00

552 lines
18 KiB
Go

package v0_test
import (
"bytes"
"context"
"crypto/ed25519"
"crypto/rand"
"encoding/hex"
"encoding/json"
"net/http"
"net/http/httptest"
"net/url"
"testing"
"github.com/danielgtaylor/huma/v2"
"github.com/danielgtaylor/huma/v2/adapters/humago"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
v0 "github.com/modelcontextprotocol/registry/internal/api/handlers/v0"
"github.com/modelcontextprotocol/registry/internal/auth"
"github.com/modelcontextprotocol/registry/internal/config"
"github.com/modelcontextprotocol/registry/internal/database"
"github.com/modelcontextprotocol/registry/internal/service"
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
"github.com/modelcontextprotocol/registry/pkg/model"
)
func TestEditServerEndpoint(t *testing.T) {
// Create test config
testSeed := make([]byte, ed25519.SeedSize)
_, err := rand.Read(testSeed)
require.NoError(t, err)
cfg := &config.Config{
JWTPrivateKey: hex.EncodeToString(testSeed),
EnableRegistryValidation: false,
}
// Create registry service and test data
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
// Create test servers for different scenarios
testServers := map[string]*apiv0.ServerJSON{
"editable": {
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Server that can be edited",
Version: "1.0.0",
Repository: &model.Repository{
URL: "https://github.com/testuser/editable-server",
Source: "github",
ID: "testuser/editable-server",
},
},
"other": {
Schema: model.CurrentSchemaURL,
Name: "io.github.otheruser/other-server",
Description: "Server owned by another user",
Version: "1.0.0",
Repository: &model.Repository{
URL: "https://github.com/otheruser/other-server",
Source: "github",
ID: "otheruser/other-server",
},
},
}
// Create the test servers
for _, server := range testServers {
_, err := registryService.CreateServer(context.Background(), server)
require.NoError(t, err)
}
// Create a server with build metadata for URL encoding test
buildMetadataServer := &apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/build-metadata-server",
Description: "Server with build metadata version",
Version: "1.0.0+20130313144700",
Repository: &model.Repository{
URL: "https://github.com/testuser/build-metadata-server",
Source: "github",
ID: "testuser/build-metadata-server",
},
}
_, err = registryService.CreateServer(context.Background(), buildMetadataServer)
require.NoError(t, err)
testCases := []struct {
name string
serverName string
version string
authClaims *auth.JWTClaims
authHeader string
requestBody apiv0.ServerJSON
expectedStatus int
expectedError string
checkResult func(*testing.T, *apiv0.ServerResponse)
}{
{
name: "successful edit with valid permissions",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Updated server description",
Version: "1.0.0",
Repository: &model.Repository{
URL: "https://github.com/testuser/editable-server",
Source: "github",
ID: "testuser/editable-server",
},
},
expectedStatus: http.StatusOK,
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
t.Helper()
assert.Equal(t, "Updated server description", resp.Server.Description)
assert.Equal(t, "io.github.testuser/editable-server", resp.Server.Name)
assert.Equal(t, "1.0.0", resp.Server.Version)
assert.NotNil(t, resp.Meta.Official)
},
},
{
name: "missing authorization header",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authHeader: "", // No auth header
requestBody: apiv0.ServerJSON{},
expectedStatus: http.StatusUnprocessableEntity,
expectedError: "required header parameter is missing",
},
{
name: "invalid authorization header format",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authHeader: "InvalidFormat token123",
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Test server",
Version: "1.0.0",
},
expectedStatus: http.StatusUnauthorized,
expectedError: "Invalid Authorization header format",
},
{
name: "invalid token",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authHeader: "Bearer invalid-token",
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Test server",
Version: "1.0.0",
},
expectedStatus: http.StatusUnauthorized,
expectedError: "Invalid or expired Registry JWT token",
},
{
name: "permission denied - no edit permissions",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionPublish, ResourcePattern: "io.github.testuser/*"}, // Only publish, not edit
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Updated test server",
Version: "1.0.0",
},
expectedStatus: http.StatusForbidden,
expectedError: "You do not have edit permissions",
},
{
name: "permission denied - wrong namespace",
serverName: "io.github.otheruser/other-server",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"}, // Wrong namespace
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.otheruser/other-server",
Description: "Updated test server",
Version: "1.0.0",
},
expectedStatus: http.StatusForbidden,
expectedError: "You do not have edit permissions",
},
{
name: "server not found",
serverName: "io.github.testuser/non-existent",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/non-existent",
Description: "Non-existent server",
Version: "1.0.0",
},
expectedStatus: http.StatusNotFound,
expectedError: "Server not found",
},
{
name: "attempt to rename server should fail",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/renamed-server", // Different name
Description: "Trying to rename server",
Version: "1.0.0",
},
expectedStatus: http.StatusBadRequest,
expectedError: "Cannot rename server",
},
{
name: "version in body must match URL parameter",
serverName: "io.github.testuser/editable-server",
version: "1.0.0",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/editable-server",
Description: "Version mismatch test",
Version: "2.0.0", // Different version from URL
},
expectedStatus: http.StatusBadRequest,
expectedError: "Version in request body must match URL path parameter",
},
{
name: "successful edit of version with build metadata (URL encoded)",
serverName: "io.github.testuser/build-metadata-server",
version: "1.0.0+20130313144700",
authClaims: &auth.JWTClaims{
AuthMethod: auth.MethodGitHubAT,
AuthMethodSubject: "testuser",
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "io.github.testuser/*"},
},
},
requestBody: apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "io.github.testuser/build-metadata-server",
Description: "Updated server with build metadata",
Version: "1.0.0+20130313144700",
Repository: &model.Repository{
URL: "https://github.com/testuser/build-metadata-server",
Source: "github",
ID: "testuser/build-metadata-server",
},
},
expectedStatus: http.StatusOK,
checkResult: func(t *testing.T, resp *apiv0.ServerResponse) {
t.Helper()
assert.Equal(t, "Updated server with build metadata", resp.Server.Description)
assert.Equal(t, "io.github.testuser/build-metadata-server", resp.Server.Name)
assert.Equal(t, "1.0.0+20130313144700", resp.Server.Version)
assert.NotNil(t, resp.Meta.Official)
},
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
// Create Huma API
mux := http.NewServeMux()
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
// Register edit endpoints
v0.RegisterEditEndpoints(api, "/v0", registryService, cfg)
// Create request body
requestBody, err := json.Marshal(tc.requestBody)
require.NoError(t, err)
// Create request URL with proper encoding
encodedServerName := url.PathEscape(tc.serverName)
encodedVersion := url.PathEscape(tc.version)
requestURL := "/v0/servers/" + encodedServerName + "/versions/" + encodedVersion
req := httptest.NewRequest(http.MethodPut, requestURL, bytes.NewReader(requestBody))
req.Header.Set("Content-Type", "application/json")
// Set authorization header
if tc.authHeader != "" {
req.Header.Set("Authorization", tc.authHeader)
} else if tc.authClaims != nil {
// Generate valid JWT token
jwtManager := auth.NewJWTManager(cfg)
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), *tc.authClaims)
require.NoError(t, err)
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
}
// Create response recorder and execute request
w := httptest.NewRecorder()
mux.ServeHTTP(w, req)
// Check response
if tc.expectedStatus != w.Code {
t.Logf("Response body: %s", w.Body.String())
}
assert.Equal(t, tc.expectedStatus, w.Code)
if tc.expectedError != "" {
assert.Contains(t, w.Body.String(), tc.expectedError)
}
if tc.expectedStatus == http.StatusOK && tc.checkResult != nil {
var response apiv0.ServerResponse
err := json.NewDecoder(w.Body).Decode(&response)
require.NoError(t, err)
tc.checkResult(t, &response)
}
})
}
}
func TestEditServerEndpointEdgeCases(t *testing.T) {
// Create test config
testSeed := make([]byte, ed25519.SeedSize)
_, err := rand.Read(testSeed)
require.NoError(t, err)
cfg := &config.Config{
JWTPrivateKey: hex.EncodeToString(testSeed),
EnableRegistryValidation: false,
}
// Create registry service
registryService := service.NewRegistryService(database.NewTestDB(t), cfg)
// Setup test servers with different characteristics
testServers := []struct {
name string
version string
}{
{"com.example/active-server", "1.0.0"},
{"com.example/multi-version-server", "1.0.0"},
{"com.example/multi-version-server", "2.0.0"},
}
for _, server := range testServers {
_, err := registryService.CreateServer(context.Background(), &apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: server.name,
Description: "Test server for editing",
Version: server.version,
})
require.NoError(t, err)
}
// Create API
mux := http.NewServeMux()
api := humago.New(mux, huma.DefaultConfig("Test API", "1.0.0"))
v0.RegisterEditEndpoints(api, "/v0", registryService, cfg)
t.Run("URL encoding edge cases", func(t *testing.T) {
// Create server with special characters
specialServerName := "io.dots.and-dashes/server_with_underscores"
_, err := registryService.CreateServer(context.Background(), &apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: specialServerName,
Description: "Server with special characters",
Version: "1.0.0",
})
require.NoError(t, err)
requestBody := apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: specialServerName,
Description: "Updated server with special chars",
Version: "1.0.0",
}
bodyBytes, err := json.Marshal(requestBody)
require.NoError(t, err)
encodedName := url.PathEscape(specialServerName)
requestURL := "/v0/servers/" + encodedName + "/versions/1.0.0"
req := httptest.NewRequest(http.MethodPut, requestURL, bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
// Generate admin token
jwtManager := auth.NewJWTManager(cfg)
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), auth.JWTClaims{
AuthMethod: auth.MethodNone,
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
},
})
require.NoError(t, err)
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
w := httptest.NewRecorder()
mux.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
var response apiv0.ServerResponse
err = json.NewDecoder(w.Body).Decode(&response)
require.NoError(t, err)
assert.Equal(t, specialServerName, response.Server.Name)
assert.Equal(t, "Updated server with special chars", response.Server.Description)
})
t.Run("version-specific editing", func(t *testing.T) {
// Test editing a specific version of a multi-version server
requestBody := apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "com.example/multi-version-server",
Description: "Updated v1.0.0 specifically",
Version: "1.0.0",
}
bodyBytes, err := json.Marshal(requestBody)
require.NoError(t, err)
encodedName := url.PathEscape("com.example/multi-version-server")
requestURL := "/v0/servers/" + encodedName + "/versions/1.0.0"
req := httptest.NewRequest(http.MethodPut, requestURL, bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
// Generate admin token
jwtManager := auth.NewJWTManager(cfg)
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), auth.JWTClaims{
AuthMethod: auth.MethodNone,
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
},
})
require.NoError(t, err)
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
w := httptest.NewRecorder()
mux.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
var response apiv0.ServerResponse
err = json.NewDecoder(w.Body).Decode(&response)
require.NoError(t, err)
assert.Equal(t, "Updated v1.0.0 specifically", response.Server.Description)
assert.Equal(t, "1.0.0", response.Server.Version)
// Verify the other version wasn't affected
otherVersion, err := registryService.GetServerByNameAndVersion(context.Background(), "com.example/multi-version-server", "2.0.0", false)
require.NoError(t, err)
assert.NotEqual(t, "Updated v1.0.0 specifically", otherVersion.Server.Description)
})
t.Run("edit preserves status metadata", func(t *testing.T) {
// Create a server and set it to deprecated using the service directly
deprecatedServer := &apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "com.example/deprecated-for-edit-test",
Description: "Server to test edit preserves status",
Version: "1.0.0",
}
_, err := registryService.CreateServer(context.Background(), deprecatedServer)
require.NoError(t, err)
// Set to deprecated status using UpdateServerStatus
statusMsg := "This server is deprecated"
_, err = registryService.UpdateServerStatus(context.Background(), deprecatedServer.Name, deprecatedServer.Version, &service.StatusChangeRequest{
NewStatus: model.StatusDeprecated,
StatusMessage: &statusMsg,
})
require.NoError(t, err)
// Now edit the server description
requestBody := apiv0.ServerJSON{
Schema: model.CurrentSchemaURL,
Name: "com.example/deprecated-for-edit-test",
Description: "Updated description but status should remain deprecated",
Version: "1.0.0",
}
bodyBytes, err := json.Marshal(requestBody)
require.NoError(t, err)
encodedName := url.PathEscape("com.example/deprecated-for-edit-test")
requestURL := "/v0/servers/" + encodedName + "/versions/1.0.0"
req := httptest.NewRequest(http.MethodPut, requestURL, bytes.NewReader(bodyBytes))
req.Header.Set("Content-Type", "application/json")
jwtManager := auth.NewJWTManager(cfg)
tokenResponse, err := jwtManager.GenerateTokenResponse(context.Background(), auth.JWTClaims{
AuthMethod: auth.MethodNone,
Permissions: []auth.Permission{
{Action: auth.PermissionActionEdit, ResourcePattern: "*"},
},
})
require.NoError(t, err)
req.Header.Set("Authorization", "Bearer "+tokenResponse.RegistryToken)
w := httptest.NewRecorder()
mux.ServeHTTP(w, req)
assert.Equal(t, http.StatusOK, w.Code)
var response apiv0.ServerResponse
err = json.NewDecoder(w.Body).Decode(&response)
require.NoError(t, err)
assert.Equal(t, "Updated description but status should remain deprecated", response.Server.Description)
// Status should still be deprecated
assert.Equal(t, model.StatusDeprecated, response.Meta.Official.Status)
// Status message should be preserved
assert.NotNil(t, response.Meta.Official.StatusMessage)
assert.Equal(t, "This server is deprecated", *response.Meta.Official.StatusMessage)
})
}