registry/internal/validators/validators.go
Tadas Antanavicius b58836c48e
feat: Add LocalTransport/RemoteTransport with URL template variables (#570)
Co-authored with Claude Code, but I've closely reviewed/modified/vetted
all changes; ready for final review.

## Summary

This PR adds LocalTransport and RemoteTransport separation with URL
template variable support for remote servers, enabling e.g. multi-tenant
deployments with configurable endpoints.

**Key additions:**
- LocalTransport (for Packages) and RemoteTransport (for Remotes)
- URL template variables for remote transports (e.g., `{tenant_id}` in
URLs)
- Pattern validation ensuring URLs are URL-like while allowing templates
- Full test coverage via Go validator tests and documentation examples

## ⚠️ server.json Update

This PR updates the `server.json` schema. A new schema version will be
cut after this lands.

## Problem

The current schema describes URL templating with `{curly_braces}` for
transports but provides no mechanism for Remote contexts to define what
those variables should resolve to, making the feature unusable for
remote servers.

Referenced issue: #394
- Users need multi-tenant remote servers with different endpoints per
deployment
- Each tenant/region has its own URL (e.g., `us-cell1.example.com`,
`emea-cell1.example.com`)
- Current schema doesn't support parameterized remote URLs

## Solution

### Schema Architecture

**LocalTransport** (for Package context):
```typescript
LocalTransport = StdioTransport | StreamableHttpTransport | SseTransport
```
- Used in Package context (non-breaking rename of existing behavior)
- Variables in `{curly_braces}` reference parent Package
arguments/environment variables
- Supports all three transport types including stdio

**RemoteTransport** (for Remote context):
```typescript
RemoteTransport = (StreamableHttpTransport | SseTransport) + { variables: object }
```
- Extends StreamableHttp/Sse via `allOf` composition - no duplication!
- Adds `variables` object for URL templating
- Only supports streamable-http and sse (stdio not valid for remotes)

### Key Changes

**1. Schema Updates** (`openapi.yaml`, `server.schema.json`):
- Added `LocalTransport` union type for Package context
- Added `RemoteTransport` with `allOf` composition extending base
transports
- Updated Package to reference `LocalTransport`
- Updated remotes to reference `RemoteTransport`
- Added URL pattern validation: `^https?://[^\\s]+$` to both
StreamableHttp and SSE
- Removed `format: uri` from SSE (was blocking template variables)

**2. Go Types** (`pkg/model/types.go`):
- Base `Transport` struct unchanged for Package context
- `RemoteTransport` struct for remotes with `Variables` field
- Both work with existing validation infrastructure

**3. Validators** (`internal/validators/`):
- `validateRemoteTransport()` validates Remote-specific constraints
- `collectRemoteTransportVariables()` extracts available variables
- `IsValidTemplatedURL()` validates template variables reference defined
variables
- `IsValidRemoteURL()` handles template variable substitution before
localhost check
- 6 new test cases for remote transport variable validation

**4. Documentation Examples** (`generic-server-json.md`):
- Remote Server with URL Templating (StreamableHttp with `{tenant_id}`)
- SSE Remote with URL Templating (SSE with `{tenant_id}`)
- Local Server with URL Templating (Package with `{port}`)
- All examples validate via existing `validate-examples` tool

## Example: Remote Transport with Variables

```json
{
  "remotes": [
    {
      "type": "streamable-http",
      "url": "https://api.example.com/mcp/{tenant_id}/{region}",
      "variables": {
        "tenant_id": {
          "description": "Tenant identifier",
          "isRequired": true,
          "choices": ["us-cell1", "emea-cell1", "apac-cell1"]
        },
        "region": {
          "description": "Deployment region",
          "isRequired": true
        }
      }
    }
  ]
}
```

Clients configure the variables, and `{tenant_id}` and `{region}` get
replaced to connect to tenant-specific endpoints like
`https://api.example.com/mcp/us-cell1/east`.

## Architecture Details

**Context-based variable resolution:**
- **Package + LocalTransport**: `{port}` references `--port` argument or
`PORT` env var from parent Package
- **Remote + RemoteTransport**: `{tenant_id}` references
`variables.tenant_id` defined in the transport itself
- **Code reuse**: StreamableHttp/Sse definitions shared via `allOf`, not
duplicated
- **Validation**: Template variables validated against available
variables for each context

---

## Follow-on Work

Follow-on work will be done to adopt the feedback in
https://github.com/modelcontextprotocol/registry/pull/570#issuecomment-3367417636
regarding variable naming/prioritzation/scoping conventions, but should
not have any impact on the shape being introduced here (just
validations).

---------

Co-authored-by: yuna0x0 <yuna@yuna0x0.com>
Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: Connor Peet <connor@peet.io>
2025-12-11 09:17:32 -08:00

529 lines
16 KiB
Go

package validators
import (
"context"
"encoding/json"
"fmt"
"net/url"
"regexp"
"strings"
"github.com/modelcontextprotocol/registry/internal/config"
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
"github.com/modelcontextprotocol/registry/pkg/model"
)
// Server name validation patterns
var (
// Component patterns for namespace and name parts
namespacePattern = `[a-zA-Z0-9][a-zA-Z0-9.-]*[a-zA-Z0-9]`
namePartPattern = `[a-zA-Z0-9][a-zA-Z0-9._-]*[a-zA-Z0-9]`
// Compiled regexes
namespaceRegex = regexp.MustCompile(`^` + namespacePattern + `$`)
namePartRegex = regexp.MustCompile(`^` + namePartPattern + `$`)
serverNameRegex = regexp.MustCompile(`^` + namespacePattern + `/` + namePartPattern + `$`)
)
// Regexes to detect semver range syntaxes
var (
// Case 1: comparator ranges
// - "^1.2.3",
// - "~1.2.3",
// - ">=1.0.0",
// - "<=1.0.0",
// - ">1.0.0",
// - "<1.0.0",
// - "=1.0.0",
comparatorRangeRe = regexp.MustCompile(`^\s*(?:\^|~|>=|<=|>|<|=)\s*v?\d+(?:\.\d+){0,3}(?:-[0-9A-Za-z.-]+)?\s*$`)
// Case 2: hyphen ranges
// - "1.2.3 - 2.0.0",
hyphenRangeRe = regexp.MustCompile(`^\s*v?\d+(?:\.\d+){0,3}(?:-[0-9A-Za-z.-]+)?\s-\s*v?\d+(?:\.\d+){0,3}(?:-[0-9A-Za-z.-]+)?\s*$`)
// Case 3: OR ranges
// - "1.2 || 1.3",
orRangeRe = regexp.MustCompile(`^\s*(?:v?\d+(?:\.\d+){0,3}(?:-[0-9A-Za-z.-]+)?\s*)(?:\|\|\s*v?\d+(?:\.\d+){0,3}(?:-[0-9A-Za-z.-]+)?\s*)+$`)
// Case 4: dotted version wildcards
// - "1.2.*",
// - "1.2.x",
// - "1.2.X",
// - "1.x",
// etc.
dottedVersionLikeRe = regexp.MustCompile(`^\s*(?:v?\d+|x|X|\*)(?:\.(?:\d+|x|X|\*)){1,2}(?:-[0-9A-Za-z.-]+)?\s*$`)
)
func ValidateServerJSON(serverJSON *apiv0.ServerJSON) error {
// Validate schema version is provided and supported
// Note: Schema field is also marked as required in the ServerJSON struct definition
// for API-level validation and documentation
if serverJSON.Schema == "" {
return fmt.Errorf("$schema field is required")
}
if !strings.Contains(serverJSON.Schema, model.CurrentSchemaVersion) {
return fmt.Errorf("schema version %s is not supported. Please use schema version %s", serverJSON.Schema, model.CurrentSchemaVersion)
}
// Validate server name exists and format
if _, err := parseServerName(*serverJSON); err != nil {
return err
}
// Validate top-level server version is a specific version (not a range) & not "latest"
if err := validateVersion(serverJSON.Version); err != nil {
return err
}
// Validate repository
if err := validateRepository(serverJSON.Repository); err != nil {
return err
}
// Validate website URL if provided
if err := validateWebsiteURL(serverJSON.WebsiteURL); err != nil {
return err
}
// Validate title if provided
if err := validateTitle(serverJSON.Title); err != nil {
return err
}
// Validate icons if provided
if err := validateIcons(serverJSON.Icons); err != nil {
return err
}
// Validate all packages (basic field validation)
// Detailed package validation (including registry checks) is done during publish
for _, pkg := range serverJSON.Packages {
if err := validatePackageField(&pkg); err != nil {
return err
}
}
// Validate all remotes
for _, remote := range serverJSON.Remotes {
if err := validateRemoteTransport(&remote); err != nil {
return err
}
}
return nil
}
func validateRepository(obj *model.Repository) error {
// Skip validation if repository is nil or empty (optional field)
if obj == nil || (obj.URL == "" && obj.Source == "") {
return nil
}
// validate the repository source
repoSource := RepositorySource(obj.Source)
if !IsValidRepositoryURL(repoSource, obj.URL) {
return fmt.Errorf("%w: %s", ErrInvalidRepositoryURL, obj.URL)
}
// validate subfolder if present
if obj.Subfolder != "" && !IsValidSubfolderPath(obj.Subfolder) {
return fmt.Errorf("%w: %s", ErrInvalidSubfolderPath, obj.Subfolder)
}
return nil
}
func validateWebsiteURL(websiteURL string) error {
// Skip validation if website URL is not provided (optional field)
if websiteURL == "" {
return nil
}
// Parse the URL to ensure it's valid
parsedURL, err := url.Parse(websiteURL)
if err != nil {
return fmt.Errorf("invalid websiteUrl: %w", err)
}
// Ensure it's an absolute URL with valid scheme
if !parsedURL.IsAbs() {
return fmt.Errorf("websiteUrl must be absolute (include scheme): %s", websiteURL)
}
// Only allow HTTPS scheme for security
if parsedURL.Scheme != SchemeHTTPS {
return fmt.Errorf("websiteUrl must use https scheme: %s", websiteURL)
}
return nil
}
func validateTitle(title string) error {
// Skip validation if title is not provided (optional field)
if title == "" {
return nil
}
// Check that title is not only whitespace
if strings.TrimSpace(title) == "" {
return fmt.Errorf("title cannot be only whitespace")
}
return nil
}
func validateIcons(icons []model.Icon) error {
// Skip validation if no icons are provided (optional field)
if len(icons) == 0 {
return nil
}
// Validate each icon
for i, icon := range icons {
if err := validateIcon(&icon); err != nil {
return fmt.Errorf("invalid icon at index %d: %w", i, err)
}
}
return nil
}
func validateIcon(icon *model.Icon) error {
// Parse the URL to ensure it's valid
parsedURL, err := url.Parse(icon.Src)
if err != nil {
return fmt.Errorf("invalid icon src URL: %w", err)
}
// Ensure it's an absolute URL
if !parsedURL.IsAbs() {
return fmt.Errorf("icon src must be an absolute URL (include scheme): %s", icon.Src)
}
// Only allow HTTPS scheme for security (no HTTP or data: URIs)
if parsedURL.Scheme != SchemeHTTPS {
return fmt.Errorf("icon src must use https scheme (got %s): %s", parsedURL.Scheme, icon.Src)
}
return nil
}
func validatePackageField(obj *model.Package) error {
if !HasNoSpaces(obj.Identifier) {
return ErrPackageNameHasSpaces
}
// Validate version string
if err := validateVersion(obj.Version); err != nil {
return err
}
// Validate runtime arguments
for _, arg := range obj.RuntimeArguments {
if err := validateArgument(&arg); err != nil {
return fmt.Errorf("invalid runtime argument: %w", err)
}
}
// Validate package arguments
for _, arg := range obj.PackageArguments {
if err := validateArgument(&arg); err != nil {
return fmt.Errorf("invalid package argument: %w", err)
}
}
// Validate transport with template variable support
availableVariables := collectAvailableVariables(obj)
if err := validatePackageTransport(&obj.Transport, availableVariables); err != nil {
return fmt.Errorf("invalid transport: %w", err)
}
return nil
}
// validateVersion validates the version string.
// NB: we decided that we would not enforce strict semver for version strings
func validateVersion(version string) error {
if version == "latest" {
return ErrReservedVersionString
}
// Reject semver range-like inputs
if looksLikeVersionRange(version) {
return fmt.Errorf("%w: %q", ErrVersionLooksLikeRange, version)
}
return nil
}
// looksLikeVersionRange detects common semver range syntaxes and wildcard patterns.
// that indicate the value is not a single, specific version.
// Examples that should return true:
// - "^1.2.3",
// - "~1.2.3",
// - ">=1.0.0",
// - "1.x",
// - "1.2.*",
// - "1 - 2",
// - "1.2 || 1.3"
func looksLikeVersionRange(version string) bool {
trimmed := strings.TrimSpace(version)
if trimmed == "" {
return false
}
if comparatorRangeRe.MatchString(trimmed) {
return true
}
if hyphenRangeRe.MatchString(trimmed) {
return true
}
if orRangeRe.MatchString(trimmed) {
return true
}
if dottedVersionLikeRe.MatchString(trimmed) {
// wildcard in a dotted version (x/X/*) implies range-like intent
return strings.Contains(trimmed, "x") || strings.Contains(trimmed, "X") || strings.Contains(trimmed, "*")
}
return false
}
// validateArgument validates argument details
func validateArgument(obj *model.Argument) error {
if obj.Type == model.ArgumentTypeNamed {
// Validate named argument name format
if err := validateNamedArgumentName(obj.Name); err != nil {
return err
}
// Validate value and default don't start with the name
if err := validateArgumentValueFields(obj.Name, obj.Value, obj.Default); err != nil {
return err
}
}
return nil
}
func validateNamedArgumentName(name string) error {
// Check if name is required for named arguments
if name == "" {
return ErrNamedArgumentNameRequired
}
// Check for invalid characters that suggest embedded values or descriptions
// Valid: "--directory", "--port", "-v", "config", "verbose"
// Invalid: "--directory <absolute_path_to_adfin_mcp_folder>", "--port 8080"
if strings.Contains(name, "<") || strings.Contains(name, ">") ||
strings.Contains(name, " ") || strings.Contains(name, "$") {
return fmt.Errorf("%w: %s", ErrInvalidNamedArgumentName, name)
}
return nil
}
func validateArgumentValueFields(name, value, defaultValue string) error {
// Check if value starts with the argument name (using startsWith, not contains)
if value != "" && strings.HasPrefix(value, name) {
return fmt.Errorf("%w: value starts with argument name '%s': %s", ErrArgumentValueStartsWithName, name, value)
}
if defaultValue != "" && strings.HasPrefix(defaultValue, name) {
return fmt.Errorf("%w: default starts with argument name '%s': %s", ErrArgumentDefaultStartsWithName, name, defaultValue)
}
return nil
}
// collectAvailableVariables collects all available template variables from a package
func collectAvailableVariables(pkg *model.Package) []string {
var variables []string
// Add environment variable names
for _, env := range pkg.EnvironmentVariables {
variables = append(variables, env.Name)
}
// Add runtime argument names and value hints
for _, arg := range pkg.RuntimeArguments {
if arg.Name != "" {
variables = append(variables, arg.Name)
}
if arg.ValueHint != "" {
variables = append(variables, arg.ValueHint)
}
}
// Add package argument names and value hints
for _, arg := range pkg.PackageArguments {
if arg.Name != "" {
variables = append(variables, arg.Name)
}
if arg.ValueHint != "" {
variables = append(variables, arg.ValueHint)
}
}
return variables
}
// collectRemoteTransportVariables extracts available variable names from a remote transport
func collectRemoteTransportVariables(transport *model.Transport) []string {
var variables []string
// Add variable names from the Variables map
for variableName := range transport.Variables {
if variableName != "" {
variables = append(variables, variableName)
}
}
return variables
}
// validatePackageTransport validates a package's transport with templating support
func validatePackageTransport(transport *model.Transport, availableVariables []string) error {
// Validate transport type is supported
switch transport.Type {
case model.TransportTypeStdio:
// Validate that URL is empty for stdio transport
if transport.URL != "" {
return fmt.Errorf("url must be empty for %s transport type, got: %s", transport.Type, transport.URL)
}
return nil
case model.TransportTypeStreamableHTTP, model.TransportTypeSSE:
// URL is required for streamable-http and sse
if transport.URL == "" {
return fmt.Errorf("url is required for %s transport type", transport.Type)
}
// Validate URL format with template variable support
if !IsValidTemplatedURL(transport.URL, availableVariables) {
// Check if it's a template variable issue or basic URL issue
templateVars := extractTemplateVariables(transport.URL)
if len(templateVars) > 0 {
return fmt.Errorf("%w: template variables in URL %s reference undefined variables. Available variables: %v",
ErrInvalidPackageTransportURL, transport.URL, availableVariables)
}
return fmt.Errorf("%w: %s", ErrInvalidPackageTransportURL, transport.URL)
}
return nil
default:
return fmt.Errorf("unsupported transport type: %s", transport.Type)
}
}
// validateRemoteTransport validates a remote transport with optional templating
func validateRemoteTransport(obj *model.Transport) error {
// Validate transport type is supported - remotes only support streamable-http and sse
switch obj.Type {
case model.TransportTypeStreamableHTTP, model.TransportTypeSSE:
// URL is required for streamable-http and sse
if obj.URL == "" {
return fmt.Errorf("url is required for %s transport type", obj.Type)
}
// Collect available variables from the transport's Variables field
availableVariables := collectRemoteTransportVariables(obj)
// Validate URL format with template variable support
if !IsValidTemplatedURL(obj.URL, availableVariables) {
// Check if it's a template variable issue or basic URL issue
templateVars := extractTemplateVariables(obj.URL)
if len(templateVars) > 0 {
return fmt.Errorf("%w: template variables in URL %s reference undefined variables. Available variables: %v",
ErrInvalidRemoteURL, obj.URL, availableVariables)
}
return fmt.Errorf("%w: %s", ErrInvalidRemoteURL, obj.URL)
}
// Additional check: reject localhost URLs for remotes (like the old IsValidRemoteURL did)
if !IsValidRemoteURL(obj.URL) {
return fmt.Errorf("%w: %s", ErrInvalidRemoteURL, obj.URL)
}
return nil
default:
return fmt.Errorf("unsupported transport type for remotes: %s (only streamable-http and sse are supported)", obj.Type)
}
}
// ValidatePublishRequest validates a complete publish request including extensions
func ValidatePublishRequest(ctx context.Context, req apiv0.ServerJSON, cfg *config.Config) error {
// Validate publisher extensions in _meta
if err := validatePublisherExtensions(req); err != nil {
return err
}
// Validate the server detail (includes all nested validation)
if err := ValidateServerJSON(&req); err != nil {
return err
}
// Validate registry ownership for all packages if validation is enabled
if cfg.EnableRegistryValidation {
for i, pkg := range req.Packages {
if err := ValidatePackage(ctx, pkg, req.Name); err != nil {
return fmt.Errorf("registry validation failed for package %d (%s): %w", i, pkg.Identifier, err)
}
}
}
return nil
}
func validatePublisherExtensions(req apiv0.ServerJSON) error {
const maxExtensionSize = 4 * 1024 // 4KB limit
// Check size limit for _meta publisher-provided extension
if req.Meta != nil && req.Meta.PublisherProvided != nil {
extensionsJSON, err := json.Marshal(req.Meta.PublisherProvided)
if err != nil {
return fmt.Errorf("failed to marshal _meta.io.modelcontextprotocol.registry/publisher-provided extension: %w", err)
}
if len(extensionsJSON) > maxExtensionSize {
return fmt.Errorf("_meta.io.modelcontextprotocol.registry/publisher-provided extension exceeds 4KB limit (%d bytes)", len(extensionsJSON))
}
}
// Note: ServerJSON._meta only contains PublisherProvided data
// Official registry metadata is handled separately in the response structure
return nil
}
func parseServerName(serverJSON apiv0.ServerJSON) (string, error) {
name := serverJSON.Name
if name == "" {
return "", fmt.Errorf("server name is required and must be a string")
}
// Validate format: dns-namespace/name
if !strings.Contains(name, "/") {
return "", fmt.Errorf("server name must be in format 'dns-namespace/name' (e.g., 'com.example.api/server')")
}
// Check for multiple slashes - reject if found
slashCount := strings.Count(name, "/")
if slashCount > 1 {
return "", ErrMultipleSlashesInServerName
}
// Split and check for empty parts
parts := strings.SplitN(name, "/", 2)
if len(parts) != 2 || parts[0] == "" || parts[1] == "" {
return "", fmt.Errorf("server name must be in format 'dns-namespace/name' with non-empty namespace and name parts")
}
// Validate name format using regex
if !serverNameRegex.MatchString(name) {
namespace := parts[0]
serverName := parts[1]
// Check which part is invalid for a better error message
if !namespaceRegex.MatchString(namespace) {
return "", fmt.Errorf("%w: namespace '%s' is invalid. Namespace must start and end with alphanumeric characters, and may contain dots and hyphens in the middle", ErrInvalidServerNameFormat, namespace)
}
if !namePartRegex.MatchString(serverName) {
return "", fmt.Errorf("%w: name '%s' is invalid. Name must start and end with alphanumeric characters, and may contain dots, underscores, and hyphens in the middle", ErrInvalidServerNameFormat, serverName)
}
// Fallback in case both somehow pass individually but not together
return "", fmt.Errorf("%w: invalid format for '%s'", ErrInvalidServerNameFormat, name)
}
return name, nil
}