feat: Add LocalTransport/RemoteTransport with URL template variables #570
+350
−49
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -156,6 +156,20 @@ | |
| } | ||
| ] | ||
| }, | ||
| "LocalTransport": { | ||
| "anyOf": [ | ||
| { | ||
| "$ref": "#/definitions/StdioTransport" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/StreamableHttpTransport" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/SseTransport" | ||
| } | ||
| ], | ||
| "description": "Transport protocol configuration for local/package context" | ||
| }, | ||
| "NamedArgument": { | ||
| "allOf": [ | ||
| { | ||
|
|
@@ -262,17 +276,7 @@ | |
| "type": "string" | ||
| }, | ||
| "transport": { | ||
| "$ref": "#/definitions/LocalTransport", | ||
| "description": "Transport protocol configuration for the package" | ||
| }, | ||
| "version": { | ||
|
|
@@ -337,6 +341,33 @@ | |
| ], | ||
| "description": "A positional input is a value inserted verbatim into the command line." | ||
| }, | ||
| "RemoteTransport": { | ||
| "allOf": [ | ||
| { | ||
| "anyOf": [ | ||
| { | ||
| "$ref": "#/definitions/StreamableHttpTransport" | ||
| }, | ||
| { | ||
| "$ref": "#/definitions/SseTransport" | ||
| } | ||
| ] | ||
| }, | ||
| { | ||
| "properties": { | ||
| "variables": { | ||
| "additionalProperties": { | ||
| "$ref": "#/definitions/Input" | ||
| }, | ||
| "description": "Configuration variables that can be referenced in URL template {curly_braces}. The key is the variable name, and the value defines the variable properties.", | ||
| "type": "object" | ||
| } | ||
| }, | ||
| "type": "object" | ||
| } | ||
| ], | ||
| "description": "Transport protocol configuration for remote context - extends StreamableHttpTransport or SseTransport with variables" | ||
| }, | ||
| "Repository": { | ||
| "description": "Repository metadata for the MCP server source code. Enables users and security experts to inspect the code, improving transparency.", | ||
| "properties": { | ||
|
|
@@ -427,14 +458,7 @@ | |
| }, | ||
| "remotes": { | ||
| "items": { | ||
| "$ref": "#/definitions/RemoteTransport" | ||
| }, | ||
| "type": "array" | ||
| }, | ||
|
|
@@ -487,9 +511,9 @@ | |
| "type": "string" | ||
| }, | ||
| "url": { | ||
| "description": "Server-Sent Events endpoint URL template. Variables in {curly_braces} are resolved based on context: In Package context, they reference argument valueHints, argument names, or environment variable names from the parent Package. In Remote context, they reference variables from the transport's 'variables' object. After variable substitution, this should produce a valid URI.", | ||
| "example": "https://mcp-fs.example.com/sse", | ||
| "pattern": "^https?://[^\\s]+$", | ||
| "type": "string" | ||
| } | ||
| }, | ||
|
|
@@ -533,8 +557,9 @@ | |
| "type": "string" | ||
| }, | ||
| "url": { | ||
| "description": "URL template for the streamable-http transport. Variables in {curly_braces} are resolved based on context: In Package context, they reference argument valueHints, argument names, or environment variable names from the parent Package. In Remote context, they reference variables from the transport's 'variables' object. After variable substitution, this should produce a valid URI.", | ||
| "example": "https://api.example.com/mcp", | ||
| "pattern": "^https?://[^\\s]+$", | ||
| "type": "string" | ||
| } | ||
| }, | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -132,8 +132,11 @@ func IsValidRemoteURL(rawURL string) bool { | |
| return false | ||
| } | ||
|
|
||
| // Replace template variables with placeholders before parsing for localhost check | ||
| testURL := replaceTemplateVariables(rawURL) | ||
|
|
||
| // Parse the URL to check for localhost restriction | ||
| u, err := url.Parse(testURL) | ||
| if err != nil { | ||
| return false | ||
| } | ||
|
|
@@ -149,8 +152,8 @@ func IsValidRemoteURL(rawURL string) bool { | |
|
|
||
| // IsValidTemplatedURL validates a URL with template variables against available variables | ||
| // For packages: validates that template variables reference package arguments or environment variables | ||
| // For remotes: validates that template variables reference the transport's variables map | ||
| func IsValidTemplatedURL(rawURL string, availableVariables []string) bool { | ||
| // First check basic URL structure | ||
| if !IsValidURL(rawURL) { | ||
| return false | ||
|
|
@@ -164,11 +167,6 @@ func IsValidTemplatedURL(rawURL string, availableVariables []string, allowTempla | |
| return true | ||
| } | ||
|
|
||
| // Validate that all template variables are available | ||
| availableSet := make(map[string]bool) | ||
| for _, v := range availableVariables { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -374,6 +374,20 @@ func collectAvailableVariables(pkg *model.Package) []string { | |
| 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 | ||
|
|
@@ -390,7 +404,7 @@ func validatePackageTransport(transport *model.Transport, availableVariables []s | |
| 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 { | ||
|
|
@@ -405,7 +419,7 @@ func validatePackageTransport(transport *model.Transport, availableVariables []s | |
| } | ||
| } | ||
|
|
||
| // 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 { | ||
|
|
@@ -414,7 +428,22 @@ func validateRemoteTransport(obj *model.Transport) error { | |
| 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) | ||
| } | ||
|
|
@@ -540,8 +569,11 @@ func validateWebsiteURLNamespaceMatch(serverJSON apiv0.ServerJSON) error { | |
|
|
||
| // validateRemoteURLMatchesNamespace checks if a remote URL's hostname matches the publisher domain from the namespace | ||
| func validateRemoteURLMatchesNamespace(remoteURL, namespace string) error { | ||
| // Replace template variables with placeholders before parsing | ||
| testURL := replaceTemplateVariables(remoteURL) | ||
|
|
||
| // Parse the URL to extract the hostname | ||
| parsedURL, err := url.Parse(testURL) | ||
| if err != nil { | ||
| return fmt.Errorf("invalid URL format: %w", err) | ||
| } | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As things are specified currently we take the
nameliterally