feat(run): allow empty strings for required config fields during runtime (#110)

Author: arjunkmrm

CHANGELOG.md

@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/).
 
+## [1.1.66] - 2025-04-03
+
+### Changed
+- Modified runtime config validation to allow empty strings for required fields
+- Added separate config validation for run vs install commands
+- Improved error handling for missing required fields during runtime
+
 ## [1.1.65] - 2025-04-02
 
 ### Added

package.json

@@ -49,11 +49,7 @@
 		"tsx": "^4.19.2",
 		"typescript": "^5.0.0"
 	},
-	"files": [
-		"dist",
-		"README.md",
-		"package.json"
-	],
+	"files": ["dist", "README.md", "package.json"],
 	"exports": {
 		".": {
 			"import": "./dist/index.js"

src/commands/run/index.ts

@@ -5,7 +5,7 @@ import {
 	initializeSettings,
 } from "../../smithery-config.js"
 import type { RegistryServer, ServerConfig } from "../../types/registry.js"
-import { chooseConnection } from "../../utils/config.js"
+import { chooseConnection, formatRunConfigValues } from "../../utils/config.js"
 import { createStdioRunner as startSTDIOrunner } from "./stdio-runner.js"
 import { createWSRunner as startWSRunner } from "./ws-runner.js"
 
@@ -40,7 +40,12 @@ export async function run(
 			try {
 				const result = await fetchConfigWithApiKey(qualifiedName, apiKey)
 				resolvedServer = result.server
-				finalConfig = { ...result.config, ...config } // Merge configs, with local config taking precedence
+				// Merge configs with proper schema validation
+				const connection = chooseConnection(result.server)
+				finalConfig = await formatRunConfigValues(connection, {
+					...result.config,
+					...config,
+				})
 				console.error("[Runner] Using saved configuration")
 			} catch (error) {
 				console.error("[Runner] Failed to fetch config with API key:", error)
@@ -58,6 +63,12 @@ export async function run(
 			throw new Error(`Could not resolve server: ${qualifiedName}`)
 		}
 
+		// Format final config with schema validation if not already done
+		if (!apiKey) {
+			const connection = chooseConnection(resolvedServer)
+			finalConfig = await formatRunConfigValues(connection, finalConfig)
+		}
+
 		console.error("[Runner] Connecting to server:", {
 			id: resolvedServer.qualifiedName,
 			connectionTypes: resolvedServer.connections.map((c) => c.type),

src/utils/config.ts

@@ -445,3 +445,56 @@ export function formatServerConfig(
 		args: npxArgs,
 	}
 }
+
+/**
+ * Formats and validates configuration values for the run command.
+ * This is a special case that allows empty strings for required fields.
+ *
+ * @param connection - Server connection details containing the config schema
+ * @param configValues - Optional existing configuration values to format
+ * @returns Formatted configuration values with proper types according to schema
+ */
+export async function formatRunConfigValues(
+	connection: ConnectionDetails,
+	configValues?: ServerConfig,
+): Promise<ServerConfig> {
+	const formattedValues: ServerConfig = {}
+
+	if (!connection.configSchema?.properties) {
+		return configValues || {}
+	}
+
+	const required = new Set<string>(connection.configSchema.required || [])
+
+	// First pass: collect all values and track missing required fields
+	for (const [key, prop] of Object.entries(
+		connection.configSchema.properties,
+	)) {
+		const schemaProp = prop as { type?: string; default?: unknown }
+		const value = configValues?.[key]
+
+		try {
+			let finalValue: unknown
+			if (value !== undefined) {
+				finalValue = value
+			} else if (!required.has(key)) {
+				finalValue = schemaProp.default
+			} else {
+				finalValue = "" // Use empty string for required fields that are missing
+			}
+
+			if (finalValue === undefined) {
+				// Use empty string for optional values without defaults
+				formattedValues[key] = ""
+				continue
+			}
+
+			formattedValues[key] = convertValueToType(finalValue, schemaProp.type)
+		} catch (error) {
+			// For any errors, use empty string for required fields and null for optional ones
+			formattedValues[key] = required.has(key) ? "" : null
+		}
+	}
+
+	return formattedValues
+}