Add a status field indicating if a server is deprecated or active (#210)

The following PR adds a new server `status` field to support the status
of servers, like deprecated or active

Details:
* Add status field to server.json schema with 'active' and 'deprecated'
values
* Update OpenAPI spec to include status field in Server responses
* Add ServerStatus enum and field to Go model structs
* Update examples to demonstrate status field usage (`active` and
`deprecated`)

Since this is my first PR there's a good chance I might have missed
something so I'll appreciate any feedback to make this and any PRs in
the future easier for you to review 😃

Fixes: #181

## Motivation and Context
<!-- Why is this change needed? What problem does it solve? -->
The main goal is to have a way for server authors to notify registry
consumers that a server may no longer be maintained and shouldn't be
considered for using.

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

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

## 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)
- [x] New feature (non-breaking change which adds functionality)
- [ ] 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. -->
- [x] 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>
Co-authored-by: Tadas Antanavicius <tadas@tadasant.com>
This commit is contained in:
Radoslav Dimitrov 2025-07-31 17:18:35 +03:00 • committed by GitHub
commit d461400055
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 78 additions and 3 deletions

View file

@ -55,6 +55,7 @@ type Package struct {
type ServerJSON struct {
Name string `json:"name"`
Description string `json:"description"`
Status string `json:"status,omitempty"`
Repository Repository `json:"repository"`
VersionDetail VersionDetail `json:"version_detail"`
Packages []Package `json:"packages"`
@ -176,6 +177,7 @@ func createCommand() error {
var repoURL string
var repoSource string
var output string
var status string
// Package information flags
var registryName string
@ -198,6 +200,7 @@ func createCommand() error {
createFlags.StringVar(&repoSource, "repo-source", "github", "Repository source")
createFlags.StringVar(&output, "output", "server.json", "Output file path")
createFlags.StringVar(&output, "o", "server.json", "Output file path (shorthand)")
createFlags.StringVar(&status, "status", "active", "Server status (active or deprecated)")
createFlags.StringVar(&registryName, "registry", "npm", "Package registry name")
createFlags.StringVar(&packageName, "package-name", "", "Package name (defaults to server name)")
@ -229,6 +232,7 @@ func createCommand() error {
fmt.Fprint(os.Stdout, " --description/-d string Server description (required)\n")
fmt.Fprint(os.Stdout, " --repo-url string Repository URL (required)\n")
fmt.Fprint(os.Stdout, " --version/-v string Server version (default: 1.0.0)\n")
fmt.Fprint(os.Stdout, " --status string Server status (active or deprecated) (default: active)\n")
fmt.Fprint(os.Stdout, " --execute/-e string Command to execute the server\n")
fmt.Fprint(os.Stdout, " --output/-o string Output file path (default: server.json)\n")
fmt.Fprint(os.Stdout, " --registry string Package registry name (default: npm)\n")
@ -255,6 +259,11 @@ func createCommand() error {
return errors.New("--repo-url is required")
}
// Validate status field
if status != "active" && status != "deprecated" {
return errors.New("--status must be either 'active' or 'deprecated'")
}
// Set defaults
if packageName == "" {
packageName = name
@ -275,7 +284,7 @@ func createCommand() error {
// Create server structure
server := createServerStructure(name, description, version, repoURL, repoSource,
registryName, packageName, packageVersion, runtimeHint, execute, envVars, packageArgs)
registryName, packageName, packageVersion, runtimeHint, execute, envVars, packageArgs, status)
// Convert to JSON
jsonData, err := json.MarshalIndent(server, "", " ")
@ -352,7 +361,7 @@ func publishToRegistry(registryURL string, mcpData []byte, token string) error {
}
func createServerStructure(name, description, version, repoURL, repoSource, registryName,
packageName, packageVersion, runtimeHint, execute string, envVars []string, packageArgs []string) ServerJSON {
packageName, packageVersion, runtimeHint, execute string, envVars []string, packageArgs []string, status string) ServerJSON {
// Parse environment variables
var environmentVariables []EnvironmentVariable
for _, envVar := range envVars {
@ -442,6 +451,7 @@ func createServerStructure(name, description, version, repoURL, repoSource, regi
return ServerJSON{
Name: name,
Description: description,
Status: status,
Repository: Repository{
URL: repoURL,
Source: repoSource,

View file

@ -1,6 +1,7 @@
{
"description": "<your description here>",
"name": "io.github.<owner>/<server-name>",
"status": "active",
"packages": [
{
"registry_name": "npm",

View file

@ -22,7 +22,7 @@ const (
// IMPORTANT: Only change this count if you have intentionally added or removed examples
// from the examples.md file. This check prevents accidental formatting changes from
// causing examples to be skipped during validation.
expectedExampleCount = 8
expectedExampleCount = 9
)
func main() {