Merge branch 'main' of github.com:docker/mcp-registry into add-astro-docs-server

Author: kgprs

.github/workflows/ci.yaml

@@ -29,16 +29,4 @@ jobs:
 
       - name: Build and catalog changed servers
         shell: bash
-        run: |
-          set -eo pipefail
-          while IFS= read -r file; do
-            dir=$(dirname "$file")
-            name=$(basename "$dir")
-            task validate -- --name $name
-            task build -- --tools --pull-community $name
-            echo "--------------------------------"
-            task catalog -- $name
-            echo "--------------------------------"
-            cat catalogs/$name/catalog.yaml
-            echo "--------------------------------"
-          done < changed-servers.txt
+        run: ./scripts/ci-validation.sh

CONTRIBUTING.md

@@ -123,7 +123,7 @@ task create -- --category database --image myorg/my-mcp https://github.com/myorg
 After creating your server file with `task create`, you will be given instructions for running it locally. In the case of my-orgdb-mcp, we would run the following commands next.
 
 ```
-task build -- my-orgdb-mcp # Not needed if providing your own image
+task build -- --tools my-orgdb-mcp # Not needed if providing your own image
 task catalog -- my-orgdb-mcp
 docker mcp catalog import $PWD/catalogs/my-orgdb-mcp/catalog.yaml
 ```
@@ -134,6 +134,43 @@ Now, if we go into the MCP Toolkit on Docker Desktop, we'll see our new MCP serv
 docker mcp catalog reset
 ```
 
+### Avoiding `build --tools` failures
+
+If your MCP server needs to be configured before listing tools, you can now provide a `tools.json` file and the build process will not try to run
+the server and list the tools. This is one of the most common issues that block your PR.
+
+This is an example of a `tools.json` file:
+
+```
+[
+  {
+    "name": "tools_name",
+    "description": "description of what you tool does"
+    "arguments": [
+      {
+        "name": "name_of_the_argument",
+        "type": "string",
+        "desc": ""
+      }
+    ]
+  },
+  {
+    "name": "another_tool",
+    "description": "description of what another tool"
+    "arguments": [
+      {
+        "name": "name_of_the_argument",
+        "type": "string",
+        "desc": ""
+      }
+    ]
+  }
+]
+```
+
+When this file is found next to your `server.yaml`, the `task build -- --tools your-server-name` lists the tools by reading the file instead of
+running the server.
+
 ### 4️⃣ Wait for review and approval
 
 Upon approval your entry will be processed and it will be available in 24 hours at:

cmd/build/main.go

@@ -48,6 +48,11 @@ func run(ctx context.Context, name string, listTools bool, pullCommunity bool) e
 		return nil
 	}
 
+	if server.Type == "poci" {
+		fmt.Printf("✅ Build skipped for poci server %s\n", name)
+		return nil
+	}
+
 	isMcpImage := strings.HasPrefix(server.Image, "mcp/")
 
 	if isMcpImage {
@@ -62,6 +67,16 @@ func run(ctx context.Context, name string, listTools bool, pullCommunity bool) e
 			return err
 		}
 	}
+	// check if the server has a tools.json file
+	if _, err := os.Stat(filepath.Join("servers", name, "tools.json")); err == nil {
+		listTools = false
+		tools, err := mcp.ReadToolsFromFile(filepath.Join("servers", name, "tools.json"))
+		if err != nil {
+			return err
+		}
+		fmt.Println()
+		fmt.Println(len(tools), "tools found.")
+	}
 
 	if listTools {
 		tools, err := mcp.Tools(ctx, server, false, false, false)

cmd/validate/main.go

@@ -2,20 +2,24 @@ package main
 
 import (
 	"context"
+	"encoding/json"
 	"flag"
 	"fmt"
 	"image"
 	"log"
 	"net/http"
 	"os"
+	"os/exec"
 	"path/filepath"
 	"regexp"
 	"strings"
+	"time"
 
 	_ "image/jpeg"
 	_ "image/png"
 
 	"github.com/docker/mcp-registry/internal/licenses"
+	"github.com/docker/mcp-registry/internal/mcp"
 	"github.com/docker/mcp-registry/pkg/github"
 	"github.com/docker/mcp-registry/pkg/servers"
 	"gopkg.in/yaml.v3"
@@ -56,11 +60,15 @@ func run(name string) error {
 	if err := isRemoteValid(name); err != nil {
 		return err
 	}
-	
+
 	if err := isOAuthDynamicValid(name); err != nil {
 		return err
 	}
 
+	if err := isPociValid(name); err != nil {
+		return err
+	}
+
 	return nil
 }
 
@@ -147,13 +155,13 @@ func IsLicenseValid(name string) error {
 	if err != nil {
 		return err
 	}
-	
+
 	// Skip license validation for remote servers without source
 	if server.Source.Project == "" {
 		fmt.Println("✅ License validation skipped (remote server)")
 		return nil
 	}
-	
+
 	repository, err := client.GetProjectRepository(ctx, server.Source.Project)
 	if err != nil {
 		return err
@@ -193,14 +201,14 @@ func isIconValid(name string) error {
 		fmt.Println("🛑 Icon is too large. It must be less than 2MB")
 		return nil
 	}
-	
+
 	// Check content type for SVG support
 	contentType := resp.Header.Get("Content-Type")
 	if contentType == "image/svg+xml" {
 		fmt.Println("✅ Icon is valid (SVG)")
 		return nil
 	}
-	
+
 	img, format, err := image.DecodeConfig(resp.Body)
 	if err != nil {
 		return err
@@ -250,10 +258,52 @@ func isRemoteValid(name string) error {
 		return fmt.Errorf("remote server transport_type must be one of: stdio, sse, streamable-http (got: %s)", server.Remote.TransportType)
 	}
 
+	if err := hasValidTools(server); err != nil {
+		return err
+	}
+
 	fmt.Println("✅ Remote is valid")
 	return nil
 }
 
+// Check that there is either a tools.json, dynamic tools, or can fetch remote tools
+func hasValidTools(server servers.Server) error {
+	defaultErr := fmt.Errorf("server must have either a tools.json, dynamic tools, or can fetch remote tools")
+
+	// Dynamic tools are valid
+	if server.Dynamic != nil && server.Dynamic.Tools {
+		fmt.Println("✅ Dynamic tools are valid")
+		return nil
+	}
+
+	// Tools.json is valid
+	tools, err := readToolsJson(server.Name)
+	if err == nil {
+		toolCount := len(tools)
+		fmt.Printf("✅ tools.json is valid. Found %d tools.\n", toolCount)
+		return nil
+	}
+	if !os.IsNotExist(err) {
+		fmt.Printf("🛑 Tools.json could not be read: %v\n", err)
+		return defaultErr
+	}
+
+	ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
+	defer cancel()
+
+	// Remote tools are valid
+	remoteTools, err := mcp.RemoteTools(ctx, server)
+	if err != nil {
+		fmt.Printf("🛑 Remote tools could not be fetched (if auth is required, specify \ndynamic:\n  tools: true\n): %v\n", err)
+		return defaultErr
+	}
+
+	toolCount := len(remoteTools)
+
+	fmt.Printf("✅ Remote tools are valid. Found %d tools.\n", toolCount)
+	return nil
+}
+
 // check if servers with OAuth have dynamic tools enabled
 func isOAuthDynamicValid(name string) error {
 	server, err := readServerYaml(name)
@@ -284,3 +334,48 @@ func readServerYaml(name string) (servers.Server, error) {
 	}
 	return server, nil
 }
+
+func readToolsJson(name string) ([]mcp.Tool, error) {
+	path := filepath.Join("servers", name, "tools.json")
+	buf, err := os.ReadFile(path)
+	if err != nil {
+		return nil, err
+	}
+
+	var tools []mcp.Tool
+	if err := json.Unmarshal(buf, &tools); err != nil {
+		return nil, err
+	}
+
+	return tools, nil
+}
+
+func isPociValid(name string) error {
+	server, err := readServerYaml(name)
+	if err != nil {
+		return err
+	}
+
+	if server.Type != "poci" {
+		return nil
+	}
+
+	for _, tool := range server.Tools {
+		if tool.Container.Image != "" {
+			if err := pullPociImage(tool.Container.Image); err != nil {
+				fmt.Printf("🛑 Could not pull poci image %s: %v\n", tool.Container.Image, err)
+				return err
+			}
+		}
+	}
+
+	fmt.Println("✅ Poci image is valid")
+	return nil
+}
+
+func pullPociImage(image string) error {
+	cmd := exec.Command("docker", "pull", image)
+	cmd.Stdout = os.Stdout
+	cmd.Stderr = os.Stderr
+	return cmd.Run()
+}

go.mod

@@ -24,6 +24,7 @@ require (
 	github.com/dustin/go-humanize v1.0.1 // indirect
 	github.com/erikgeiser/coninput v0.0.0-20211004153227-1c3628e74d0f // indirect
 	github.com/google/go-querystring v1.1.0 // indirect
+	github.com/google/uuid v1.6.0 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-localereader v0.0.1 // indirect

go.sum

@@ -53,6 +53,8 @@ github.com/google/go-github/v70 v70.0.0 h1:/tqCp5KPrcvqCc7vIvYyFYTiCGrYvaWoYMGHS
 github.com/google/go-github/v70 v70.0.0/go.mod h1:xBUZgo8MI3lUL/hwxl3hlceJW1U8MVnXP3zUyI+rhQY=
 github.com/google/go-querystring v1.1.0 h1:AnCroh3fv4ZBgVIf1Iwtovgjaw/GiKJo8M8yD/fhyJ8=
 github.com/google/go-querystring v1.1.0/go.mod h1:Kcdr2DB4koayq7X8pmAG4sNG59So17icRSOU623lUBU=
+github.com/google/uuid v1.6.0 h1:NIvaJDMOsjHA8n1jAhLSgzrAzy1Hgr+hNrb57e+94F0=
+github.com/google/uuid v1.6.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=