Skip to content

Create wrapper shim scripts #768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
adwsingh merged 3 commits into from
Jun 11, 2025
Merged

Create wrapper shim scripts #768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
02c6752
Create wrapper shim scripts
adwsingh Jun 11, 2025
775bf1e
Check for file write access and comments in shell script
adwsingh Jun 11, 2025
ee4c011
Make copy of readlines
adwsingh Jun 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 116 additions & 0 deletions mcp/mcp-cli-api/src/main/java/software/amazon/smithy/java/mcp/cli/ConfigUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.util.ArrayList;
import java.util.Comparator;
import java.util.HashMap;
import java.util.LinkedHashMap;
Expand Down Expand Up @@ -53,8 +54,12 @@ private ConfigUtils() {}
.serializeTypeInDocuments(false)
.build();

private static final String OS = System.getProperty("os.name").toLowerCase();
private static final boolean WINDOWS = OS.contains("windows");

private static final Path CONFIG_DIR = resolveFromHomeDir(".config", "smithy-mcp");
private static final Path BUNDLE_DIR = CONFIG_DIR.resolve("bundles");
private static final Path SHIMS_DIR = CONFIG_DIR.resolve("mcp-servers");
private static final Path CONFIG_PATH = CONFIG_DIR.resolve("config.json");

private static final DefaultConfigProvider DEFAULT_CONFIG_PROVIDER;
Expand All @@ -63,6 +68,7 @@ private ConfigUtils() {}
try {
ensureDirectoryExists(CONFIG_DIR);
ensureDirectoryExists(BUNDLE_DIR);
ensureDirectoryExists(SHIMS_DIR);
} catch (IOException e) {
throw new RuntimeException(e);
}
Expand Down Expand Up @@ -169,6 +175,8 @@ public static void removeMcpBundle(Config currentConfig, String bundleName) thro
updateConfig(newConfig);
var bundleFile = getBundleFileLocation(bundleName);
Files.deleteIfExists(bundleFile);
// Remove wrapper script if it exists
removeWrapperScript(bundleName);
}

public static void addToClientConfigs(Config config, String name, Set<String> clients, McpServerConfig serverConfig)
Expand Down Expand Up @@ -333,4 +341,112 @@ private static String captureProcessOutput(Process process) throws IOException {
return in.lines().collect(Collectors.joining(System.lineSeparator()));
}
}

public static void createWrapperScript(String bundleName) throws IOException {
Path scriptPath = SHIMS_DIR.resolve(bundleName);
String scriptContent = createScriptContent(bundleName);

Files.writeString(scriptPath, scriptContent, StandardOpenOption.CREATE, StandardOpenOption.TRUNCATE_EXISTING);
scriptPath.toFile().setExecutable(true);
}

private static String createScriptContent(String bundleName) {
if (WINDOWS) {
return "@echo off\nmcp-registry start-server " + bundleName + " %*\n";
} else {
return "#!/bin/bash\nexec mcp-registry start-server " + bundleName + " \"$@\"\n";
}
}

public static void removeWrapperScript(String bundleName) throws IOException {
Path scriptPath = SHIMS_DIR.resolve(bundleName);
Files.deleteIfExists(scriptPath);
}

public static boolean isMcpServersDirInPath() {
String pathEnv = System.getenv("PATH");
if (pathEnv == null) {
return false;
}

String shimsDirStr = SHIMS_DIR.toAbsolutePath().toString();
return pathEnv.contains(shimsDirStr);
}

public static void ensureMcpServersDirInPath() {
if (isMcpServersDirInPath()) {
return;
}

String shimsDirStr = SHIMS_DIR.toAbsolutePath().toString();

if (WINDOWS) {
printWindowsPathInstructions(shimsDirStr);
} else {
if (!tryAddToShellConfigs(shimsDirStr)) {
printUnixPathInstructions(shimsDirStr);
}
}
}

private static boolean tryAddToShellConfigs(String shimsDirStr) {
var pathExport = "export PATH=\"" + shimsDirStr + ":$PATH\"";
var comment = "# Added by smithy-mcp";
var configFiles = List.of(".zshrc", ".bashrc", ".profile", ".bash_profile");

String addedTo = null;

for (var configFile : configFiles) {
var configPath = resolveFromHomeDir(configFile);

if (Files.exists(configPath) && Files.isWritable(configPath)) {
try {
// Check if already present
var lines = new ArrayList<>(Files.readAllLines(configPath, StandardCharsets.UTF_8));
boolean alreadyPresent = lines.stream()
.anyMatch(line -> line.contains(shimsDirStr)
&& line.contains("PATH")
&& !(line.trim().startsWith("#")));

if (!alreadyPresent) {
// Add the export statement
lines.add("");
lines.add(comment);
lines.add(pathExport);

Files.write(configPath,
lines,
StandardCharsets.UTF_8,
StandardOpenOption.WRITE,
StandardOpenOption.TRUNCATE_EXISTING);

System.out.println("Added mcp-servers directory to PATH in " + configFile);
addedTo = configFile;
}
} catch (IOException e) {
// Continue to next config file if this one fails
}
}
}

if (addedTo != null) {
System.out.println("Please restart your shell or run 'source ~/" + configFiles + "' to reload your PATH");
return true;
}
return false;
}

private static void printWindowsPathInstructions(String shimsDirStr) {
System.out.println("\nTo use the installed bundle as a command, add the mcp-servers directory to your PATH:");
System.out.println(" set PATH=" + shimsDirStr + ";%PATH%");
System.out.println("Or permanently add it through System Properties > Environment Variables");
System.out.println();
}

private static void printUnixPathInstructions(String shimsDirStr) {
System.out.println("\nTo use the installed bundle as a command, add the mcp-servers directory to your PATH:");
System.out.println(" export PATH=\"" + shimsDirStr + ":$PATH\"");
System.out.println("Add this line to your shell profile (~/.bashrc, ~/.zshrc, etc.) to make it permanent");
System.out.println();
}
}
15 changes: 13 additions & 2 deletions mcp/mcp-cli/src/main/java/software/amazon/smithy/java/mcp/cli/commands/InstallBundle.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,12 +43,22 @@ protected void execute(ExecutionContext context) throws IOException {
var config = context.config();
var bundle = registry.getMcpBundle(name);
ConfigUtils.addMcpBundle(config, name, bundle);
var command = "mcp-registry";
var args = List.of("start-server", name);

var command = name;
List<String> args = null;
boolean shouldCreateWrapper = true;

if (bundle.getValue() instanceof GenericBundle genericBundle && genericBundle.isExecuteDirectly()) {
command = genericBundle.getRun().getExecutable();
args = genericBundle.getRun().getArgs();
shouldCreateWrapper = false;
}

if (shouldCreateWrapper) {
ConfigUtils.createWrapperScript(name);
ConfigUtils.ensureMcpServersDirInPath();
}

var newClientConfig = McpServerConfig.builder()
.command(command)
.args(args)
Expand All @@ -60,6 +70,7 @@ protected void execute(ExecutionContext context) throws IOException {
ConfigUtils.addToClientConfigs(config, name, clients, newClientConfig);

System.out.println("Successfully installed " + name);

if (print) {
System.out.println("You can add the following to your MCP Servers config to use " + name);
System.out.println(newClientConfig);
Expand Down