Skip to content

Commit 5233d6d

Browse files
JAORMXJAORMX
committed
Add Maven and Gradle protocol support for Java MCP servers
This change introduces support for packaging and running Java-based MCP servers using Maven and Gradle build systems, extending ToolHive's capabilities beyond Python (uvx), Node.js (npx), and Go packages. Changes include: - New maven.tmpl and gradle.tmpl container templates for Java containers - Maven and Gradle transport types in templates.go - Protocol handling for maven:// and gradle:// schemes - GetSupportedSchemes() function for dynamic scheme listing - Comprehensive test coverage for new functionality - Updated CLI documentation for thv run and thv build commands The implementation follows the existing pattern used for other protocol schemes, ensuring consistency across the codebase.
1 parent 86edb93 commit 5233d6d

File tree

10 files changed

+319
-20
lines changed

10 files changed

+319
-20
lines changed

‎cmd/thv/app/build.go

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,24 @@ ToolHive supports building containers from protocol schemes:
2222
$ thv build npx://package-name
2323
$ thv build go://package-name
2424
$ thv build go://./local-path
25+
$ thv build maven://com.example.MCPServer
26+
$ thv build gradle://com.example.MCPServer
2527
2628
Automatically generates a container that can run the specified package
2729
using either uvx (Python with uv package manager), npx (Node.js),
28-
or go (Golang). For Go, you can also specify local paths starting
29-
with './' or '../' to build local Go projects.
30+
go (Golang), maven (Java with Maven), or gradle (Java with Gradle).
31+
For Go, you can also specify local paths starting with './' or '../'
32+
to build local Go projects.
3033
3134
The container will be built and tagged locally, ready to be used with 'thv run'
3235
or other container tools. The built image name will be displayed upon successful completion.
3336
3437
Examples:
3538
$ thv build uvx://mcp-server-git
3639
$ thv build --tag my-custom-name:latest npx://@modelcontextprotocol/server-filesystem
37-
$ thv build go://./my-local-server`,
40+
$ thv build go://./my-local-server
41+
$ thv build maven://com.example.MCPServer
42+
$ thv build gradle://com.example.MCPServer`,
3843
Args: cobra.ExactArgs(1),
3944
RunE: buildCmdFunc,
4045
}
@@ -66,7 +71,7 @@ func buildCmdFunc(cmd *cobra.Command, args []string) error {
6671

6772
// Validate that this is a protocol scheme
6873
if !runner.IsImageProtocolScheme(protocolScheme) {
69-
return fmt.Errorf("invalid protocol scheme: %s. Supported schemes are: uvx://, npx://, go://", protocolScheme)
74+
return fmt.Errorf("invalid protocol scheme: %s. Supported schemes are: %s", protocolScheme, runner.GetSupportedSchemes())
7075
}
7176

7277
// Create image manager (even for dry-run, we pass it but it won't be used)

‎cmd/thv/app/run.go

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,14 @@ ToolHive supports four ways to run an MCP server:
4747
$ thv run npx://package-name [-- args...]
4848
$ thv run go://package-name [-- args...]
4949
$ thv run go://./local-path [-- args...]
50-
51-
Automatically generates a container that runs the specified package
52-
using either uvx (Python with uv package manager), npx (Node.js),
53-
or go (Golang). For Go, you can also specify local paths starting
54-
with './' or '../' to build and run local Go projects.
50+
$ thv run maven://com.example.MCPServer [-- args...]
51+
$ thv run gradle://com.example.MCPServer [-- args...]
52+
53+
Automatically generates a container that runs the specified package
54+
using either uvx (Python with uv package manager), npx (Node.js),
55+
go (Golang), maven (Java with Maven), or gradle (Java with Gradle).
56+
For Go, you can also specify local paths starting with './' or '../'
57+
to build and run local Go projects.
5558
5659
4. From an exported configuration:
5760

‎docs/cli/thv_build.md

Lines changed: 7 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/cli/thv_run.md

Lines changed: 5 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pkg/container/templates/gradle.tmpl

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
FROM gradle:8.11-jdk21-alpine
2+
3+
{{if .CACertContent}}
4+
# Add custom CA certificate BEFORE any network operations
5+
# This ensures that package managers can verify TLS certificates in corporate networks
6+
COPY ca-cert.crt /tmp/custom-ca.crt
7+
RUN cat /tmp/custom-ca.crt >> /etc/ssl/certs/ca-certificates.crt && \
8+
rm /tmp/custom-ca.crt
9+
{{end}}
10+
11+
# Install CA certificates
12+
RUN apk add --no-cache ca-certificates
13+
14+
# Set working directory
15+
WORKDIR /app
16+
17+
# Create a non-root user to run the application and set proper permissions
18+
RUN addgroup -S appgroup && \
19+
adduser -S appuser -G appgroup && \
20+
mkdir -p /app && \
21+
chown -R appuser:appgroup /app && \
22+
mkdir -p /home/appuser/.gradle && \
23+
chown -R appuser:appgroup /home/appuser
24+
25+
{{if .CACertContent}}
26+
# Properly install the custom CA certificate using standard tools
27+
RUN mkdir -p /usr/local/share/ca-certificates && \
28+
cp /tmp/custom-ca.crt /usr/local/share/ca-certificates/custom-ca.crt 2>/dev/null || \
29+
echo "CA cert already added to bundle" && \
30+
chmod 644 /usr/local/share/ca-certificates/custom-ca.crt 2>/dev/null || true && \
31+
update-ca-certificates
32+
33+
# Configure Java to use the custom CA certificate
34+
ENV JAVA_TOOL_OPTIONS="-Djavax.net.ssl.trustStore=/etc/ssl/certs/java/cacerts -Djavax.net.ssl.trustStorePassword=changeit"
35+
{{end}}
36+
37+
# Set environment variables for better performance in containers
38+
ENV GRADLE_OPTS="-Xmx512m -XX:MaxMetaspaceSize=128m -Dorg.gradle.daemon=false" \
39+
GRADLE_USER_HOME="/home/appuser/.gradle"
40+
41+
{{if .IsLocalPath}}
42+
# Copy the local source code
43+
COPY . /app/
44+
45+
# Change ownership of copied files to appuser
46+
USER root
47+
RUN chown -R appuser:appgroup /app
48+
{{end}}
49+
50+
# Switch to non-root user
51+
USER appuser
52+
53+
# Run the MCP server using Gradle
54+
# The entrypoint will be constructed dynamically based on the package and arguments
55+
# Using 'gradle run' with main class and arguments
56+
ENTRYPOINT ["gradle", "run", "-PmainClass={{.MCPPackage}}"{{range .MCPArgs}}, "-Pargs={{.}}"{{end}}]

‎pkg/container/templates/maven.tmpl

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
FROM maven:3.9-eclipse-temurin-21-alpine
2+
3+
{{if .CACertContent}}
4+
# Add custom CA certificate BEFORE any network operations
5+
# This ensures that package managers can verify TLS certificates in corporate networks
6+
COPY ca-cert.crt /tmp/custom-ca.crt
7+
RUN cat /tmp/custom-ca.crt >> /etc/ssl/certs/ca-certificates.crt && \
8+
rm /tmp/custom-ca.crt
9+
{{end}}
10+
11+
# Install CA certificates
12+
RUN apk add --no-cache ca-certificates
13+
14+
# Set working directory
15+
WORKDIR /app
16+
17+
# Create a non-root user to run the application and set proper permissions
18+
RUN addgroup -S appgroup && \
19+
adduser -S appuser -G appgroup && \
20+
mkdir -p /app && \
21+
chown -R appuser:appgroup /app && \
22+
mkdir -p /home/appuser/.m2 && \
23+
chown -R appuser:appgroup /home/appuser
24+
25+
{{if .CACertContent}}
26+
# Properly install the custom CA certificate using standard tools
27+
RUN mkdir -p /usr/local/share/ca-certificates && \
28+
cp /tmp/custom-ca.crt /usr/local/share/ca-certificates/custom-ca.crt 2>/dev/null || \
29+
echo "CA cert already added to bundle" && \
30+
chmod 644 /usr/local/share/ca-certificates/custom-ca.crt 2>/dev/null || true && \
31+
update-ca-certificates
32+
33+
# Configure Java to use the custom CA certificate
34+
ENV JAVA_TOOL_OPTIONS="-Djavax.net.ssl.trustStore=/etc/ssl/certs/java/cacerts -Djavax.net.ssl.trustStorePassword=changeit"
35+
{{end}}
36+
37+
# Set environment variables for better performance in containers
38+
ENV MAVEN_OPTS="-Xmx512m -XX:MaxMetaspaceSize=128m" \
39+
MAVEN_CONFIG="/home/appuser/.m2"
40+
41+
{{if .IsLocalPath}}
42+
# Copy the local source code
43+
COPY . /app/
44+
45+
# Change ownership of copied files to appuser
46+
USER root
47+
RUN chown -R appuser:appgroup /app
48+
{{end}}
49+
50+
# Switch to non-root user
51+
USER appuser
52+
53+
# Run the MCP server using Maven
54+
# The entrypoint will be constructed dynamically based on the package and arguments
55+
ENTRYPOINT ["mvn", "exec:java", "-Dexec.mainClass={{.MCPPackage}}"{{range .MCPArgs}}, "-Dexec.args={{.}}"{{end}}]

‎pkg/container/templates/templates.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ const (
3434
TransportTypeNPX TransportType = "npx"
3535
// TransportTypeGO represents the go transport.
3636
TransportTypeGO TransportType = "go"
37+
// TransportTypeMaven represents the maven transport.
38+
TransportTypeMaven TransportType = "maven"
39+
// TransportTypeGradle represents the gradle transport.
40+
TransportTypeGradle TransportType = "gradle"
3741
)
3842

3943
// GetDockerfileTemplate returns the Dockerfile template for the specified transport type.
@@ -48,6 +52,10 @@ func GetDockerfileTemplate(transportType TransportType, data TemplateData) (stri
4852
templateName = "npx.tmpl"
4953
case TransportTypeGO:
5054
templateName = "go.tmpl"
55+
case TransportTypeMaven:
56+
templateName = "maven.tmpl"
57+
case TransportTypeGradle:
58+
templateName = "gradle.tmpl"
5159
default:
5260
return "", fmt.Errorf("unsupported transport type: %s", transportType)
5361
}
@@ -82,6 +90,10 @@ func ParseTransportType(s string) (TransportType, error) {
8290
return TransportTypeNPX, nil
8391
case "go":
8492
return TransportTypeGO, nil
93+
case "maven":
94+
return TransportTypeMaven, nil
95+
case "gradle":
96+
return TransportTypeGradle, nil
8597
default:
8698
return "", fmt.Errorf("unsupported transport type: %s", s)
8799
}

‎pkg/container/templates/templates_test.go

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,128 @@ func TestGetDockerfileTemplate(t *testing.T) {
181181
},
182182
wantErr: false,
183183
},
184+
{
185+
name: "Maven transport",
186+
transportType: TransportTypeMaven,
187+
data: TemplateData{
188+
MCPPackage: "com.example.MCPServer",
189+
MCPArgs: []string{"--arg1", "--arg2", "value"},
190+
},
191+
wantContains: []string{
192+
"ENTRYPOINT [\"mvn\", \"exec:java\", \"-Dexec.mainClass=com.example.MCPServer\", \"-Dexec.args=--arg1\", \"-Dexec.args=--arg2\", \"-Dexec.args=value\"]",
193+
},
194+
wantMatches: []string{
195+
`FROM maven:\d+\.\d+-eclipse-temurin-\d+-alpine`, // Match any Maven version
196+
},
197+
wantNotContains: []string{
198+
"Add custom CA certificate",
199+
"update-ca-certificates",
200+
},
201+
wantErr: false,
202+
},
203+
{
204+
name: "Maven transport with CA certificate",
205+
transportType: TransportTypeMaven,
206+
data: TemplateData{
207+
MCPPackage: "com.example.MCPServer",
208+
MCPArgs: []string{"--arg1", "--arg2", "value"},
209+
CACertContent: "-----BEGIN CERTIFICATE-----\nMIICertificateContent\n-----END CERTIFICATE-----",
210+
},
211+
wantContains: []string{
212+
"ENTRYPOINT [\"mvn\", \"exec:java\", \"-Dexec.mainClass=com.example.MCPServer\", \"-Dexec.args=--arg1\", \"-Dexec.args=--arg2\", \"-Dexec.args=value\"]",
213+
"Add custom CA certificate BEFORE any network operations",
214+
"COPY ca-cert.crt /tmp/custom-ca.crt",
215+
"cat /tmp/custom-ca.crt >> /etc/ssl/certs/ca-certificates.crt",
216+
"update-ca-certificates",
217+
"ENV JAVA_TOOL_OPTIONS=\"-Djavax.net.ssl.trustStore=/etc/ssl/certs/java/cacerts -Djavax.net.ssl.trustStorePassword=changeit\"",
218+
},
219+
wantMatches: []string{
220+
`FROM maven:\d+\.\d+-eclipse-temurin-\d+-alpine`, // Match any Maven version
221+
},
222+
wantNotContains: []string{},
223+
wantErr: false,
224+
},
225+
{
226+
name: "Maven transport with local path",
227+
transportType: TransportTypeMaven,
228+
data: TemplateData{
229+
MCPPackage: "com.example.MCPServer",
230+
MCPArgs: []string{"--arg1", "value"},
231+
IsLocalPath: true,
232+
},
233+
wantContains: []string{
234+
"COPY . /app/",
235+
"ENTRYPOINT [\"mvn\", \"exec:java\", \"-Dexec.mainClass=com.example.MCPServer\", \"-Dexec.args=--arg1\", \"-Dexec.args=value\"]",
236+
},
237+
wantMatches: []string{
238+
`FROM maven:\d+\.\d+-eclipse-temurin-\d+-alpine`, // Match any Maven version
239+
},
240+
wantNotContains: []string{
241+
"Add custom CA certificate",
242+
},
243+
wantErr: false,
244+
},
245+
{
246+
name: "Gradle transport",
247+
transportType: TransportTypeGradle,
248+
data: TemplateData{
249+
MCPPackage: "com.example.MCPServer",
250+
MCPArgs: []string{"--arg1", "--arg2", "value"},
251+
},
252+
wantContains: []string{
253+
"ENTRYPOINT [\"gradle\", \"run\", \"-PmainClass=com.example.MCPServer\", \"-Pargs=--arg1\", \"-Pargs=--arg2\", \"-Pargs=value\"]",
254+
},
255+
wantMatches: []string{
256+
`FROM gradle:\d+\.\d+-jdk\d+-alpine`, // Match any Gradle version
257+
},
258+
wantNotContains: []string{
259+
"Add custom CA certificate",
260+
"update-ca-certificates",
261+
},
262+
wantErr: false,
263+
},
264+
{
265+
name: "Gradle transport with CA certificate",
266+
transportType: TransportTypeGradle,
267+
data: TemplateData{
268+
MCPPackage: "com.example.MCPServer",
269+
MCPArgs: []string{"--arg1", "--arg2", "value"},
270+
CACertContent: "-----BEGIN CERTIFICATE-----\nMIICertificateContent\n-----END CERTIFICATE-----",
271+
},
272+
wantContains: []string{
273+
"ENTRYPOINT [\"gradle\", \"run\", \"-PmainClass=com.example.MCPServer\", \"-Pargs=--arg1\", \"-Pargs=--arg2\", \"-Pargs=value\"]",
274+
"Add custom CA certificate BEFORE any network operations",
275+
"COPY ca-cert.crt /tmp/custom-ca.crt",
276+
"cat /tmp/custom-ca.crt >> /etc/ssl/certs/ca-certificates.crt",
277+
"update-ca-certificates",
278+
"ENV JAVA_TOOL_OPTIONS=\"-Djavax.net.ssl.trustStore=/etc/ssl/certs/java/cacerts -Djavax.net.ssl.trustStorePassword=changeit\"",
279+
},
280+
wantMatches: []string{
281+
`FROM gradle:\d+\.\d+-jdk\d+-alpine`, // Match any Gradle version
282+
},
283+
wantNotContains: []string{},
284+
wantErr: false,
285+
},
286+
{
287+
name: "Gradle transport with local path",
288+
transportType: TransportTypeGradle,
289+
data: TemplateData{
290+
MCPPackage: "com.example.MCPServer",
291+
MCPArgs: []string{"--arg1", "value"},
292+
IsLocalPath: true,
293+
},
294+
wantContains: []string{
295+
"COPY . /app/",
296+
"ENTRYPOINT [\"gradle\", \"run\", \"-PmainClass=com.example.MCPServer\", \"-Pargs=--arg1\", \"-Pargs=value\"]",
297+
},
298+
wantMatches: []string{
299+
`FROM gradle:\d+\.\d+-jdk\d+-alpine`, // Match any Gradle version
300+
},
301+
wantNotContains: []string{
302+
"Add custom CA certificate",
303+
},
304+
wantErr: false,
305+
},
184306
{
185307
name: "Unsupported transport",
186308
transportType: "unsupported",
@@ -262,6 +384,18 @@ func TestParseTransportType(t *testing.T) {
262384
want: TransportTypeGO,
263385
wantErr: false,
264386
},
387+
{
388+
name: "Maven transport",
389+
s: "maven",
390+
want: TransportTypeMaven,
391+
wantErr: false,
392+
},
393+
{
394+
name: "Gradle transport",
395+
s: "gradle",
396+
want: TransportTypeGradle,
397+
wantErr: false,
398+
},
265399
{
266400
name: "Unsupported transport",
267401
s: "unsupported",

0 commit comments

Comments
 (0)