registry/cmd/publisher/commands/init.go
Radoslav Dimitrov e0e51eae37
Reflect the latest registry changes in openapi.yaml (#345)
<!-- Provide a brief summary of your changes -->

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
The following PR:
* Adds a new `transport` type used in Package and Remotes
* Added `docker` to the `runtime_hint` examples
* Added support for templated URLs. It is available for streamable-http
and sse transports for Packages. I didn't thought of reasons to have
this for Remotes, but we can enable it if needed.
* Added validation for templated URLs so we can ensure all referenced
placeholder variables are available.
* For streamable-http and SSE transport types the URL is now a required
property
* Updated the publisher init command to reflect these changes
* Updated the seed.json file
* Added unit tests for the transport type related changes
* Updated the server.json schema and the external pkg structs to reflect
the new transport type
* Updated the examples

Thanks to @kkkarthik for spotting it! 🙏 

## How Has This Been Tested?
<!-- Have you tested this in a real application? Which scenarios were
tested? -->
Ran the tests locally

## Breaking Changes
<!-- Will users need to update their code or configurations? -->
Yes

## Types of changes
<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [x] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Documentation update

## Checklist
<!-- Go over all the following points, and put an `x` in all the boxes
that apply. -->
- [ ] I have read the [MCP
Documentation](https://modelcontextprotocol.io)
- [ ] My code follows the repository's style guidelines
- [ ] New and existing tests pass locally
- [ ] I have added appropriate error handling
- [ ] I have added or updated documentation as needed

## Additional context
<!-- Add any other context, implementation notes, or design decisions
-->

---------

Signed-off-by: Radoslav Dimitrov <radoslav@stacklok.com>
2025-09-05 21:07:08 +01:00

317 lines
8.2 KiB
Go

package commands
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"os/exec"
"path/filepath"
"strings"
"time"
apiv0 "github.com/modelcontextprotocol/registry/pkg/api/v0"
"github.com/modelcontextprotocol/registry/pkg/model"
)
func InitCommand() error {
// Check if server.json already exists
if _, err := os.Stat("server.json"); err == nil {
return errors.New("server.json already exists")
}
// Try to detect values from environment
name := detectServerName()
description := detectDescription()
version := "1.0.0"
repoURL := detectRepoURL()
repoSource := "github"
if repoURL != "" && !strings.Contains(repoURL, "github.com") {
if strings.Contains(repoURL, "gitlab.com") {
repoSource = "gitlab"
} else {
repoSource = "git"
}
}
packageType := detectPackageType()
packageIdentifier := detectPackageIdentifier(name, packageType)
// Create example environment variables
envVars := []model.KeyValueInput{
{
Name: "YOUR_API_KEY",
InputWithVariables: model.InputWithVariables{
Input: model.Input{
Description: "Your API key for the service",
IsRequired: true,
IsSecret: true,
Format: model.FormatString,
},
},
},
}
// Create the server structure
server := createServerJSON(
name, description, version, repoURL, repoSource,
packageType, packageIdentifier, version, envVars,
)
// Write to file
jsonData, err := json.MarshalIndent(server, "", " ")
if err != nil {
return fmt.Errorf("error marshaling JSON: %w", err)
}
err = os.WriteFile("server.json", jsonData, 0600)
if err != nil {
return fmt.Errorf("error writing file: %w", err)
}
_, _ = fmt.Fprintln(os.Stdout, "Created server.json")
_, _ = fmt.Fprintln(os.Stdout, "\nEdit server.json to update:")
_, _ = fmt.Fprintln(os.Stdout, " • Server name and description")
_, _ = fmt.Fprintln(os.Stdout, " • Package details")
_, _ = fmt.Fprintln(os.Stdout, " • Environment variables")
_, _ = fmt.Fprintln(os.Stdout, "\nThen publish with:")
_, _ = fmt.Fprintln(os.Stdout, " mcp-publisher login github # or your preferred auth method")
_, _ = fmt.Fprintln(os.Stdout, " mcp-publisher publish")
return nil
}
func getNameFromPackageJSON() string {
data, err := os.ReadFile("package.json")
if err != nil {
return ""
}
var pkg map[string]any
if err := json.Unmarshal(data, &pkg); err != nil {
return ""
}
name, ok := pkg["name"].(string)
if !ok || name == "" {
return ""
}
// Convert npm package name to MCP server name
// @org/package -> io.npm.org/package
if strings.HasPrefix(name, "@") {
parts := strings.Split(name[1:], "/")
if len(parts) == 2 {
return fmt.Sprintf("io.github.%s/%s", parts[0], parts[1])
}
}
return fmt.Sprintf("io.github.<your-username>/%s", name)
}
func detectServerName() string {
// Try to get from git remote
repoURL := detectRepoURL()
if repoURL != "" {
// Extract owner/repo from GitHub URL
if strings.Contains(repoURL, "github.com") {
parts := strings.Split(repoURL, "/")
if len(parts) >= 5 {
owner := parts[3]
repo := strings.TrimSuffix(parts[4], ".git")
return fmt.Sprintf("io.github.%s/%s", owner, repo)
}
}
}
// Try to get from package.json
name := getNameFromPackageJSON()
if name != "" {
return name
}
// Use current directory name as fallback
if cwd, err := os.Getwd(); err == nil {
return fmt.Sprintf("com.example/%s", filepath.Base(cwd))
}
return "com.example/my-mcp-server"
}
func detectDescription() string {
// Try to get from package.json
if data, err := os.ReadFile("package.json"); err == nil {
var pkg map[string]any
if json.Unmarshal(data, &pkg) == nil {
if desc, ok := pkg["description"].(string); ok && desc != "" {
return desc
}
}
}
return "An MCP server that provides [describe what your server does]"
}
func detectRepoURL() string {
// Try git remote
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
cmd := exec.CommandContext(ctx, "git", "remote", "get-url", "origin")
if output, err := cmd.Output(); err == nil {
url := strings.TrimSpace(string(output))
// Convert SSH URL to HTTPS if needed
if strings.HasPrefix(url, "git@github.com:") {
url = strings.Replace(url, "git@github.com:", "https://github.com/", 1)
}
url = strings.TrimSuffix(url, ".git")
return url
}
// Try package.json repository field
if data, err := os.ReadFile("package.json"); err == nil {
var pkg map[string]any
if json.Unmarshal(data, &pkg) == nil {
if repo, ok := pkg["repository"].(map[string]any); ok {
if url, ok := repo["url"].(string); ok {
return strings.TrimSuffix(url, ".git")
}
}
if repo, ok := pkg["repository"].(string); ok {
return strings.TrimSuffix(repo, ".git")
}
}
}
return "https://github.com/YOUR_USERNAME/YOUR_REPO"
}
func detectPackageType() string {
// Check for package.json
if _, err := os.Stat("package.json"); err == nil {
return model.RegistryTypeNPM
}
// Check for pyproject.toml or setup.py
if _, err := os.Stat("pyproject.toml"); err == nil {
return model.RegistryTypePyPI
}
if _, err := os.Stat("setup.py"); err == nil {
return model.RegistryTypePyPI
}
// Check for Dockerfile
if _, err := os.Stat("Dockerfile"); err == nil {
return model.RegistryTypeOCI
}
// Default to npm as most common
return model.RegistryTypeNPM
}
func detectPackageIdentifier(serverName string, packageType string) string {
switch packageType {
case model.RegistryTypeNPM:
// Try to get from package.json
if data, err := os.ReadFile("package.json"); err == nil {
var pkg map[string]any
if json.Unmarshal(data, &pkg) == nil {
if name, ok := pkg["name"].(string); ok && name != "" {
return name
}
}
}
// Convert server name to npm package name
if strings.HasPrefix(serverName, "io.github.") {
parts := strings.Split(serverName, "/")
if len(parts) == 2 {
owner := strings.TrimPrefix(parts[0], "io.github.")
return fmt.Sprintf("@%s/%s", owner, parts[1])
}
}
return "@your-org/your-package"
case model.RegistryTypePyPI:
// Try to get from pyproject.toml or setup.py
if data, err := os.ReadFile("pyproject.toml"); err == nil {
// Simple extraction - could be improved with proper TOML parser
lines := strings.Split(string(data), "\n")
for _, line := range lines {
if strings.HasPrefix(line, "name") && strings.Contains(line, "=") {
parts := strings.Split(line, "=")
if len(parts) >= 2 {
name := strings.Trim(parts[1], " \"'")
if name != "" {
return name
}
}
}
}
}
return "your-package"
case model.RegistryTypeOCI:
// Use a sensible default
if strings.Contains(serverName, "/") {
parts := strings.Split(serverName, "/")
return parts[len(parts)-1]
}
return "your-image"
default:
return "your-package"
}
}
func createServerJSON(
name, description, version, repoURL, repoSource,
packageType, packageIdentifier, packageVersion string,
envVars []model.KeyValueInput,
) apiv0.ServerJSON {
// Determine registry type and base URL
var registryType, registryBaseURL string
switch packageType {
case model.RegistryTypeNPM:
registryType = model.RegistryTypeNPM
registryBaseURL = model.RegistryURLNPM
case model.RegistryTypePyPI:
registryType = model.RegistryTypePyPI
registryBaseURL = model.RegistryURLPyPI
case model.RegistryTypeOCI:
registryType = model.RegistryTypeOCI
registryBaseURL = model.RegistryURLDocker
case "url":
registryType = "url"
registryBaseURL = ""
default:
registryType = packageType
registryBaseURL = ""
}
// Create package
pkg := model.Package{
RegistryType: registryType,
RegistryBaseURL: registryBaseURL,
Identifier: packageIdentifier,
Version: packageVersion,
EnvironmentVariables: envVars,
Transport: model.Transport{
Type: model.TransportTypeStdio,
},
}
// Create server structure
return apiv0.ServerJSON{
Schema: "https://static.modelcontextprotocol.io/schemas/2025-07-09/server.schema.json",
Name: name,
Description: description,
Status: model.StatusActive,
Repository: model.Repository{
URL: repoURL,
Source: repoSource,
},
VersionDetail: model.VersionDetail{
Version: version,
},
Packages: []model.Package{pkg},
}
}