@supernova123/docker-mcp-server 0.3.1 → 0.3.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/docker.d.ts +10 -0
- package/dist/docker.js +79 -0
- package/dist/server.js +1 -1
- package/dist/tools/container.js +6 -6
- package/dist/tools/image.js +3 -3
- package/dist/tools/logs.js +3 -3
- package/dist/tools/network.js +3 -3
- package/dist/tools/volume.js +3 -3
- package/dist/types.d.ts +2 -2
- package/package.json +1 -1
- package/src/docker.ts +83 -1
- package/src/server.ts +1 -1
- package/src/tools/container.ts +14 -11
- package/src/tools/health.ts +1 -1
- package/src/tools/image.ts +3 -3
- package/src/tools/logs.ts +3 -3
- package/src/tools/network.ts +3 -3
- package/src/tools/volume.ts +4 -4
- package/tests/retry.test.ts +82 -0
package/dist/docker.d.ts
CHANGED
|
@@ -34,6 +34,16 @@ export declare function checkDockerConnection(docker: Dockerode): Promise<{
|
|
|
34
34
|
* Returns structured error on timeout instead of hanging indefinitely.
|
|
35
35
|
*/
|
|
36
36
|
export declare function withTimeout<T>(promise: Promise<T>, ms: number, label: string): Promise<T>;
|
|
37
|
+
/**
|
|
38
|
+
* Retry a Docker API call with exponential backoff.
|
|
39
|
+
* Retries on transient errors (ECONNRESET, ETIMEDOUT, 5xx).
|
|
40
|
+
* Does NOT retry on 4xx errors (bad request, not found, permission denied).
|
|
41
|
+
*/
|
|
42
|
+
export declare function withRetry<T>(fn: () => Promise<T>, options?: {
|
|
43
|
+
maxRetries?: number;
|
|
44
|
+
baseDelayMs?: number;
|
|
45
|
+
label?: string;
|
|
46
|
+
}): Promise<T>;
|
|
37
47
|
export declare function formatError(error: unknown): string;
|
|
38
48
|
export declare function formatContainer(container: Dockerode.ContainerInfo): Record<string, unknown>;
|
|
39
49
|
export declare function formatImage(image: Dockerode.ImageInfo): Record<string, unknown>;
|
package/dist/docker.js
CHANGED
|
@@ -73,6 +73,85 @@ export async function withTimeout(promise, ms, label) {
|
|
|
73
73
|
new Promise((_, reject) => setTimeout(() => reject(new DockerTimeoutError(`Docker API call "${label}" timed out after ${ms}ms`)), ms)),
|
|
74
74
|
]);
|
|
75
75
|
}
|
|
76
|
+
/**
|
|
77
|
+
* Retry a Docker API call with exponential backoff.
|
|
78
|
+
* Retries on transient errors (ECONNRESET, ETIMEDOUT, 5xx).
|
|
79
|
+
* Does NOT retry on 4xx errors (bad request, not found, permission denied).
|
|
80
|
+
*/
|
|
81
|
+
export async function withRetry(fn, options = {}) {
|
|
82
|
+
const { maxRetries = 3, baseDelayMs = 1000, label = "Docker API call" } = options;
|
|
83
|
+
let lastError;
|
|
84
|
+
for (let attempt = 0; attempt <= maxRetries; attempt++) {
|
|
85
|
+
try {
|
|
86
|
+
return await fn();
|
|
87
|
+
}
|
|
88
|
+
catch (error) {
|
|
89
|
+
lastError = error;
|
|
90
|
+
// Don't retry on non-transient errors
|
|
91
|
+
if (!isRetryableError(error)) {
|
|
92
|
+
throw error;
|
|
93
|
+
}
|
|
94
|
+
// Don't retry on last attempt
|
|
95
|
+
if (attempt === maxRetries) {
|
|
96
|
+
throw error;
|
|
97
|
+
}
|
|
98
|
+
// Exponential backoff: 1s, 2s, 4s
|
|
99
|
+
const delay = baseDelayMs * Math.pow(2, attempt);
|
|
100
|
+
process.stderr.write(`[retry] ${label} failed (attempt ${attempt + 1}/${maxRetries + 1}), retrying in ${delay}ms...\n`);
|
|
101
|
+
await new Promise(resolve => setTimeout(resolve, delay));
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
throw lastError;
|
|
105
|
+
}
|
|
106
|
+
/**
|
|
107
|
+
* Determine if an error is transient and worth retrying.
|
|
108
|
+
* Retries on: connection resets, timeouts, 5xx status codes.
|
|
109
|
+
* Does NOT retry on: 4xx (client errors), permission denied, not found.
|
|
110
|
+
*/
|
|
111
|
+
function isRetryableError(error) {
|
|
112
|
+
if (!(error instanceof Error))
|
|
113
|
+
return false;
|
|
114
|
+
const msg = error.message.toLowerCase();
|
|
115
|
+
// Connection-level transient errors
|
|
116
|
+
if (msg.includes("econnreset") || msg.includes("econnrefused"))
|
|
117
|
+
return true;
|
|
118
|
+
if (msg.includes("etimedout") || msg.includes("socket hang up"))
|
|
119
|
+
return true;
|
|
120
|
+
if (msg.includes("epipe") || msg.includes("eai_again"))
|
|
121
|
+
return true;
|
|
122
|
+
// Docker API 5xx errors (server-side)
|
|
123
|
+
if (msg.includes("status code 5"))
|
|
124
|
+
return true;
|
|
125
|
+
if (msg.includes("internal server error"))
|
|
126
|
+
return true;
|
|
127
|
+
if (msg.includes("bad gateway"))
|
|
128
|
+
return true;
|
|
129
|
+
if (msg.includes("service unavailable"))
|
|
130
|
+
return true;
|
|
131
|
+
// Docker daemon busy (transient)
|
|
132
|
+
if (msg.includes("daemon is busy"))
|
|
133
|
+
return true;
|
|
134
|
+
if (msg.includes("too many requests"))
|
|
135
|
+
return true;
|
|
136
|
+
// 4xx errors are NOT retryable (client errors)
|
|
137
|
+
if (msg.includes("status code 4"))
|
|
138
|
+
return false;
|
|
139
|
+
if (msg.includes("not found"))
|
|
140
|
+
return false;
|
|
141
|
+
if (msg.includes("permission denied"))
|
|
142
|
+
return false;
|
|
143
|
+
if (msg.includes("bad request"))
|
|
144
|
+
return false;
|
|
145
|
+
// Permission/connection errors are NOT retryable
|
|
146
|
+
if (error.name === "DockerConnectionError")
|
|
147
|
+
return false;
|
|
148
|
+
if (error.name === "DockerPermissionError")
|
|
149
|
+
return false;
|
|
150
|
+
// Timeout errors ARE retryable (might be transient)
|
|
151
|
+
if (error.name === "DockerTimeoutError")
|
|
152
|
+
return true;
|
|
153
|
+
return false;
|
|
154
|
+
}
|
|
76
155
|
export function formatError(error) {
|
|
77
156
|
if (error instanceof DockerConnectionError)
|
|
78
157
|
return `${error.name}: ${error.message}`;
|
package/dist/server.js
CHANGED
|
@@ -11,7 +11,7 @@ import { registerMonitoringTools } from "./tools/monitoring.js";
|
|
|
11
11
|
export function createServer(docker, options) {
|
|
12
12
|
const server = new McpServer({
|
|
13
13
|
name: "docker-mcp-server",
|
|
14
|
-
version: "0.3.
|
|
14
|
+
version: "0.3.2",
|
|
15
15
|
});
|
|
16
16
|
// Register all tool categories
|
|
17
17
|
registerContainerTools(server, docker);
|
package/dist/tools/container.js
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { ListContainersSchema, InspectContainerSchema, StartContainerSchema, StopContainerSchema, RestartContainerSchema, RemoveContainerSchema, RecreateContainerSchema, RunContainerSchema, } from "../types.js";
|
|
2
|
-
import { formatContainer, formatError } from "../docker.js";
|
|
2
|
+
import { formatContainer, formatError, withRetry } from "../docker.js";
|
|
3
3
|
export function registerContainerTools(server, docker) {
|
|
4
4
|
server.tool("list_containers", "List Docker containers with optional filters (state, label, name). Returns container IDs, names, images, states, ports, and labels.", ListContainersSchema.shape, { readOnlyHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
5
5
|
try {
|
|
6
|
-
const containers = await docker.listContainers({
|
|
6
|
+
const containers = await withRetry(() => docker.listContainers({
|
|
7
7
|
all: params.all ?? false,
|
|
8
8
|
filters: JSON.stringify({
|
|
9
9
|
...(params.label ? { label: params.label } : {}),
|
|
10
10
|
...(params.name ? { name: [`/${params.name}`] } : {}),
|
|
11
11
|
...(params.state ? { status: [params.state] } : {}),
|
|
12
12
|
}),
|
|
13
|
-
});
|
|
13
|
+
}), { label: "list_containers" });
|
|
14
14
|
const results = containers.map(formatContainer);
|
|
15
15
|
return { content: [{ type: "text", text: JSON.stringify(results, null, 2) }] };
|
|
16
16
|
}
|
|
@@ -31,7 +31,7 @@ export function registerContainerTools(server, docker) {
|
|
|
31
31
|
server.tool("start_container", "Start a stopped Docker container by ID or name.", StartContainerSchema.shape, { idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
32
32
|
try {
|
|
33
33
|
const container = docker.getContainer(params.container_id);
|
|
34
|
-
await container.start();
|
|
34
|
+
await withRetry(() => container.start(), { label: "start_container" });
|
|
35
35
|
return { content: [{ type: "text", text: `Container ${params.container_id} started.` }] };
|
|
36
36
|
}
|
|
37
37
|
catch (error) {
|
|
@@ -41,7 +41,7 @@ export function registerContainerTools(server, docker) {
|
|
|
41
41
|
server.tool("stop_container", "Stop a running Docker container by ID or name with optional timeout.", StopContainerSchema.shape, { destructiveHint: true, openWorldHint: false }, async (params) => {
|
|
42
42
|
try {
|
|
43
43
|
const container = docker.getContainer(params.container_id);
|
|
44
|
-
await container.stop({ t: params.timeout ?? 10 });
|
|
44
|
+
await withRetry(() => container.stop({ t: params.timeout ?? 10 }), { label: "stop_container" });
|
|
45
45
|
return { content: [{ type: "text", text: `Container ${params.container_id} stopped.` }] };
|
|
46
46
|
}
|
|
47
47
|
catch (error) {
|
|
@@ -55,7 +55,7 @@ export function registerContainerTools(server, docker) {
|
|
|
55
55
|
server.tool("restart_container", "Restart a Docker container by ID or name with optional timeout. This tears down the running process and starts a new one — use stop_container for a graceful shutdown or remove_container to delete entirely. The timeout parameter (default 10s) controls how long to wait before force-killing. Returns a confirmation string on success. Idempotent: restarting an already-stopped container starts it again. Returns an error string if the container does not exist or is not running.", RestartContainerSchema.shape, { destructiveHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
56
56
|
try {
|
|
57
57
|
const container = docker.getContainer(params.container_id);
|
|
58
|
-
await container.restart({ t: params.timeout ?? 10 });
|
|
58
|
+
await withRetry(() => container.restart({ t: params.timeout ?? 10 }), { label: "restart_container" });
|
|
59
59
|
return { content: [{ type: "text", text: `Container ${params.container_id} restarted.` }] };
|
|
60
60
|
}
|
|
61
61
|
catch (error) {
|
package/dist/tools/image.js
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
import { ListImagesSchema, PullImageSchema, BuildImageSchema, RemoveImageSchema, } from "../types.js";
|
|
2
|
-
import { formatImage, formatError } from "../docker.js";
|
|
2
|
+
import { formatImage, formatError, withRetry } from "../docker.js";
|
|
3
3
|
export function registerImageTools(server, docker) {
|
|
4
4
|
server.tool("list_images", "List Docker images with optional filters. Returns image IDs, tags, sizes, and creation dates.", ListImagesSchema.shape, { readOnlyHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
5
5
|
try {
|
|
6
|
-
const images = await docker.listImages({
|
|
6
|
+
const images = await withRetry(() => docker.listImages({
|
|
7
7
|
all: params.all ?? false,
|
|
8
8
|
filters: params.filter ? JSON.stringify({ reference: [params.filter] }) : undefined,
|
|
9
|
-
});
|
|
9
|
+
}), { label: "list_images" });
|
|
10
10
|
const results = images.map(formatImage);
|
|
11
11
|
return { content: [{ type: "text", text: JSON.stringify(results, null, 2) }] };
|
|
12
12
|
}
|
package/dist/tools/logs.js
CHANGED
|
@@ -1,16 +1,16 @@
|
|
|
1
1
|
import { StreamLogsSchema, ContainerStatsSchema } from "../types.js";
|
|
2
|
-
import { formatError,
|
|
2
|
+
import { formatError, sanitizeOutput, withRetry, formatBytes } from "../docker.js";
|
|
3
3
|
export function registerLogsTools(server, docker) {
|
|
4
4
|
server.tool("stream_logs", "Get logs from a single Docker container by ID or name. Use stream_logs for one container; use compose_logs for multi-service Compose stacks. Supports tail count (default 100 lines), since timestamp for filtering, and follow mode. Returns UTF-8 log text with multiplexed stream headers stripped, or 'No logs found.' when the container has no output. Read-only and safe to call repeatedly. Returns an error string if the container does not exist.", StreamLogsSchema.shape, { readOnlyHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
5
5
|
try {
|
|
6
6
|
const container = docker.getContainer(params.container_id);
|
|
7
|
-
const logs = await container.logs({
|
|
7
|
+
const logs = await withRetry(() => container.logs({
|
|
8
8
|
stdout: true,
|
|
9
9
|
stderr: true,
|
|
10
10
|
tail: params.tail ?? 100,
|
|
11
11
|
since: params.since ? Math.floor(new Date(params.since).getTime() / 1000) : undefined,
|
|
12
12
|
follow: false,
|
|
13
|
-
});
|
|
13
|
+
}), { label: "container_logs" });
|
|
14
14
|
// Dockerode returns a Buffer with multiplexed stream headers
|
|
15
15
|
// Use 100KB cap for logs to keep LLM context small
|
|
16
16
|
const output = sanitizeOutput(logs.toString("utf-8"), 100_000);
|
package/dist/tools/network.js
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
import { ListNetworksSchema, ListVolumesSchema } from "../types.js";
|
|
2
|
-
import { formatError } from "../docker.js";
|
|
2
|
+
import { formatError, withRetry } from "../docker.js";
|
|
3
3
|
export function registerNetworkTools(server, docker) {
|
|
4
4
|
server.tool("list_networks", "List Docker networks with optional filter. Returns network IDs, names, drivers, and scopes.", ListNetworksSchema.shape, { readOnlyHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
5
5
|
try {
|
|
6
|
-
const networks = await docker.listNetworks({
|
|
6
|
+
const networks = await withRetry(() => docker.listNetworks({
|
|
7
7
|
filters: params.filter ? JSON.stringify({ name: [params.filter] }) : undefined,
|
|
8
|
-
});
|
|
8
|
+
}), { label: "list_networks" });
|
|
9
9
|
const results = networks.map((n) => ({
|
|
10
10
|
id: n.Id.substring(0, 12),
|
|
11
11
|
name: n.Name,
|
package/dist/tools/volume.js
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
import { CreateVolumeSchema, InspectVolumeSchema, RemoveVolumeSchema, PruneVolumesSchema, } from "../types.js";
|
|
2
|
-
import { formatError } from "../docker.js";
|
|
2
|
+
import { formatError, withRetry } from "../docker.js";
|
|
3
3
|
export function registerVolumeTools(server, docker) {
|
|
4
4
|
server.tool("create_volume", "Create a Docker volume with optional driver, labels, and options. Returns volume name, driver, and mountpoint.", CreateVolumeSchema.shape, { readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
5
5
|
try {
|
|
6
|
-
const result = await docker.createVolume({
|
|
6
|
+
const result = await withRetry(() => docker.createVolume({
|
|
7
7
|
Name: params.name,
|
|
8
8
|
Driver: params.driver || "local",
|
|
9
9
|
Labels: params.labels,
|
|
10
10
|
DriverOpts: params.options,
|
|
11
|
-
});
|
|
11
|
+
}), { label: "create_volume" });
|
|
12
12
|
return {
|
|
13
13
|
content: [{
|
|
14
14
|
type: "text",
|
package/dist/types.d.ts
CHANGED
|
@@ -5,15 +5,15 @@ export declare const ListContainersSchema: z.ZodObject<{
|
|
|
5
5
|
name: z.ZodOptional<z.ZodString>;
|
|
6
6
|
state: z.ZodOptional<z.ZodEnum<["running", "stopped", "paused", "exited", "created", "restarting"]>>;
|
|
7
7
|
}, "strip", z.ZodTypeAny, {
|
|
8
|
+
label?: string[] | undefined;
|
|
8
9
|
name?: string | undefined;
|
|
9
10
|
state?: "created" | "running" | "stopped" | "paused" | "exited" | "restarting" | undefined;
|
|
10
11
|
all?: boolean | undefined;
|
|
11
|
-
label?: string[] | undefined;
|
|
12
12
|
}, {
|
|
13
|
+
label?: string[] | undefined;
|
|
13
14
|
name?: string | undefined;
|
|
14
15
|
state?: "created" | "running" | "stopped" | "paused" | "exited" | "restarting" | undefined;
|
|
15
16
|
all?: boolean | undefined;
|
|
16
|
-
label?: string[] | undefined;
|
|
17
17
|
}>;
|
|
18
18
|
export declare const InspectContainerSchema: z.ZodObject<{
|
|
19
19
|
container_id: z.ZodString;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@supernova123/docker-mcp-server",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"mcpName": "io.github.friendlygeorge/docker-mcp-server",
|
|
5
5
|
"description": "MCP server for Docker — container management, health checks, auto-restart, Compose lifecycle, and log streaming for Claude, Cursor, and AI agents",
|
|
6
6
|
"type": "module",
|
package/src/docker.ts
CHANGED
|
@@ -96,6 +96,88 @@ export async function withTimeout<T>(
|
|
|
96
96
|
]);
|
|
97
97
|
}
|
|
98
98
|
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Retry a Docker API call with exponential backoff.
|
|
102
|
+
* Retries on transient errors (ECONNRESET, ETIMEDOUT, 5xx).
|
|
103
|
+
* Does NOT retry on 4xx errors (bad request, not found, permission denied).
|
|
104
|
+
*/
|
|
105
|
+
export async function withRetry<T>(
|
|
106
|
+
fn: () => Promise<T>,
|
|
107
|
+
options: { maxRetries?: number; baseDelayMs?: number; label?: string } = {}
|
|
108
|
+
): Promise<T> {
|
|
109
|
+
const { maxRetries = 3, baseDelayMs = 1000, label = "Docker API call" } = options;
|
|
110
|
+
let lastError: unknown;
|
|
111
|
+
|
|
112
|
+
for (let attempt = 0; attempt <= maxRetries; attempt++) {
|
|
113
|
+
try {
|
|
114
|
+
return await fn();
|
|
115
|
+
} catch (error) {
|
|
116
|
+
lastError = error;
|
|
117
|
+
|
|
118
|
+
// Don't retry on non-transient errors
|
|
119
|
+
if (!isRetryableError(error)) {
|
|
120
|
+
throw error;
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
// Don't retry on last attempt
|
|
124
|
+
if (attempt === maxRetries) {
|
|
125
|
+
throw error;
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
// Exponential backoff: 1s, 2s, 4s
|
|
129
|
+
const delay = baseDelayMs * Math.pow(2, attempt);
|
|
130
|
+
process.stderr.write(
|
|
131
|
+
`[retry] ${label} failed (attempt ${attempt + 1}/${maxRetries + 1}), retrying in ${delay}ms...\n`
|
|
132
|
+
);
|
|
133
|
+
await new Promise(resolve => setTimeout(resolve, delay));
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
throw lastError;
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/**
|
|
141
|
+
* Determine if an error is transient and worth retrying.
|
|
142
|
+
* Retries on: connection resets, timeouts, 5xx status codes.
|
|
143
|
+
* Does NOT retry on: 4xx (client errors), permission denied, not found.
|
|
144
|
+
*/
|
|
145
|
+
function isRetryableError(error: unknown): boolean {
|
|
146
|
+
if (!(error instanceof Error)) return false;
|
|
147
|
+
|
|
148
|
+
const msg = error.message.toLowerCase();
|
|
149
|
+
|
|
150
|
+
// Connection-level transient errors
|
|
151
|
+
if (msg.includes("econnreset") || msg.includes("econnrefused")) return true;
|
|
152
|
+
if (msg.includes("etimedout") || msg.includes("socket hang up")) return true;
|
|
153
|
+
if (msg.includes("epipe") || msg.includes("eai_again")) return true;
|
|
154
|
+
|
|
155
|
+
// Docker API 5xx errors (server-side)
|
|
156
|
+
if (msg.includes("status code 5")) return true;
|
|
157
|
+
if (msg.includes("internal server error")) return true;
|
|
158
|
+
if (msg.includes("bad gateway")) return true;
|
|
159
|
+
if (msg.includes("service unavailable")) return true;
|
|
160
|
+
|
|
161
|
+
// Docker daemon busy (transient)
|
|
162
|
+
if (msg.includes("daemon is busy")) return true;
|
|
163
|
+
if (msg.includes("too many requests")) return true;
|
|
164
|
+
|
|
165
|
+
// 4xx errors are NOT retryable (client errors)
|
|
166
|
+
if (msg.includes("status code 4")) return false;
|
|
167
|
+
if (msg.includes("not found")) return false;
|
|
168
|
+
if (msg.includes("permission denied")) return false;
|
|
169
|
+
if (msg.includes("bad request")) return false;
|
|
170
|
+
|
|
171
|
+
// Permission/connection errors are NOT retryable
|
|
172
|
+
if (error.name === "DockerConnectionError") return false;
|
|
173
|
+
if (error.name === "DockerPermissionError") return false;
|
|
174
|
+
|
|
175
|
+
// Timeout errors ARE retryable (might be transient)
|
|
176
|
+
if (error.name === "DockerTimeoutError") return true;
|
|
177
|
+
|
|
178
|
+
return false;
|
|
179
|
+
}
|
|
180
|
+
|
|
99
181
|
export function formatError(error: unknown): string {
|
|
100
182
|
if (error instanceof DockerConnectionError) return `${error.name}: ${error.message}`;
|
|
101
183
|
if (error instanceof DockerTimeoutError) return `${error.name}: ${error.message}`;
|
|
@@ -164,4 +246,4 @@ export function formatBytes(bytes: number): string {
|
|
|
164
246
|
const sizes = ["B", "KB", "MB", "GB", "TB"];
|
|
165
247
|
const i = Math.floor(Math.log(bytes) / Math.log(k));
|
|
166
248
|
return parseFloat((bytes / Math.pow(k, i)).toFixed(2)) + " " + sizes[i];
|
|
167
|
-
}
|
|
249
|
+
}
|
package/src/server.ts
CHANGED
|
@@ -17,7 +17,7 @@ export interface ServerOptions {
|
|
|
17
17
|
export function createServer(docker: Dockerode, options?: ServerOptions): McpServer {
|
|
18
18
|
const server = new McpServer({
|
|
19
19
|
name: "docker-mcp-server",
|
|
20
|
-
version: "0.3.
|
|
20
|
+
version: "0.3.2",
|
|
21
21
|
});
|
|
22
22
|
|
|
23
23
|
// Register all tool categories
|
package/src/tools/container.ts
CHANGED
|
@@ -10,7 +10,7 @@ import {
|
|
|
10
10
|
RecreateContainerSchema,
|
|
11
11
|
RunContainerSchema,
|
|
12
12
|
} from "../types.js";
|
|
13
|
-
import { formatContainer, formatError } from "../docker.js";
|
|
13
|
+
import { formatContainer, formatError, withRetry } from "../docker.js";
|
|
14
14
|
|
|
15
15
|
export function registerContainerTools(server: McpServer, docker: Dockerode): void {
|
|
16
16
|
server.tool(
|
|
@@ -20,14 +20,17 @@ export function registerContainerTools(server: McpServer, docker: Dockerode): vo
|
|
|
20
20
|
{ readOnlyHint: true, idempotentHint: true, openWorldHint: false },
|
|
21
21
|
async (params) => {
|
|
22
22
|
try {
|
|
23
|
-
const containers = await
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
23
|
+
const containers = await withRetry(
|
|
24
|
+
() => docker.listContainers({
|
|
25
|
+
all: params.all ?? false,
|
|
26
|
+
filters: JSON.stringify({
|
|
27
|
+
...(params.label ? { label: params.label } : {}),
|
|
28
|
+
...(params.name ? { name: [`/${params.name}`] } : {}),
|
|
29
|
+
...(params.state ? { status: [params.state] } : {}),
|
|
30
|
+
}),
|
|
29
31
|
}),
|
|
30
|
-
|
|
32
|
+
{ label: "list_containers" }
|
|
33
|
+
);
|
|
31
34
|
const results = containers.map(formatContainer);
|
|
32
35
|
return { content: [{ type: "text", text: JSON.stringify(results, null, 2) }] };
|
|
33
36
|
} catch (error) {
|
|
@@ -60,7 +63,7 @@ export function registerContainerTools(server: McpServer, docker: Dockerode): vo
|
|
|
60
63
|
async (params) => {
|
|
61
64
|
try {
|
|
62
65
|
const container = docker.getContainer(params.container_id);
|
|
63
|
-
await container.start();
|
|
66
|
+
await withRetry(() => container.start(), { label: "start_container" });
|
|
64
67
|
return { content: [{ type: "text", text: `Container ${params.container_id} started.` }] };
|
|
65
68
|
} catch (error) {
|
|
66
69
|
return { content: [{ type: "text", text: `Error: ${formatError(error)}` }], isError: true };
|
|
@@ -76,7 +79,7 @@ export function registerContainerTools(server: McpServer, docker: Dockerode): vo
|
|
|
76
79
|
async (params) => {
|
|
77
80
|
try {
|
|
78
81
|
const container = docker.getContainer(params.container_id);
|
|
79
|
-
await container.stop({ t: params.timeout ?? 10 });
|
|
82
|
+
await withRetry(() => container.stop({ t: params.timeout ?? 10 }), { label: "stop_container" });
|
|
80
83
|
return { content: [{ type: "text", text: `Container ${params.container_id} stopped.` }] };
|
|
81
84
|
} catch (error: any) {
|
|
82
85
|
// 304 means container is already stopped — treat as success
|
|
@@ -96,7 +99,7 @@ export function registerContainerTools(server: McpServer, docker: Dockerode): vo
|
|
|
96
99
|
async (params) => {
|
|
97
100
|
try {
|
|
98
101
|
const container = docker.getContainer(params.container_id);
|
|
99
|
-
await container.restart({ t: params.timeout ?? 10 });
|
|
102
|
+
await withRetry(() => container.restart({ t: params.timeout ?? 10 }), { label: "restart_container" });
|
|
100
103
|
return { content: [{ type: "text", text: `Container ${params.container_id} restarted.` }] };
|
|
101
104
|
} catch (error) {
|
|
102
105
|
return { content: [{ type: "text", text: `Error: ${formatError(error)}` }], isError: true };
|
package/src/tools/health.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import Dockerode from "dockerode";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
import { CheckHealthSchema, WatchHealthSchema, SetRestartPolicySchema } from "../types.js";
|
|
4
|
-
import { formatError } from "../docker.js";
|
|
4
|
+
import { formatError, withRetry } from "../docker.js";
|
|
5
5
|
|
|
6
6
|
export function registerHealthTools(server: McpServer, docker: Dockerode): void {
|
|
7
7
|
server.tool(
|
package/src/tools/image.ts
CHANGED
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
BuildImageSchema,
|
|
7
7
|
RemoveImageSchema,
|
|
8
8
|
} from "../types.js";
|
|
9
|
-
import { formatImage, formatError } from "../docker.js";
|
|
9
|
+
import { formatImage, formatError, withRetry } from "../docker.js";
|
|
10
10
|
|
|
11
11
|
export function registerImageTools(server: McpServer, docker: Dockerode): void {
|
|
12
12
|
server.tool(
|
|
@@ -16,10 +16,10 @@ export function registerImageTools(server: McpServer, docker: Dockerode): void {
|
|
|
16
16
|
{ readOnlyHint: true, idempotentHint: true, openWorldHint: false },
|
|
17
17
|
async (params) => {
|
|
18
18
|
try {
|
|
19
|
-
const images = await docker.listImages({
|
|
19
|
+
const images = await withRetry(() => docker.listImages({
|
|
20
20
|
all: params.all ?? false,
|
|
21
21
|
filters: params.filter ? JSON.stringify({ reference: [params.filter] }) : undefined,
|
|
22
|
-
});
|
|
22
|
+
}), { label: "list_images" });
|
|
23
23
|
const results = images.map(formatImage);
|
|
24
24
|
return { content: [{ type: "text", text: JSON.stringify(results, null, 2) }] };
|
|
25
25
|
} catch (error) {
|
package/src/tools/logs.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import Dockerode from "dockerode";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
import { StreamLogsSchema, ContainerStatsSchema } from "../types.js";
|
|
4
|
-
import { formatError,
|
|
4
|
+
import { formatError, sanitizeOutput, withRetry, formatBytes } from "../docker.js";
|
|
5
5
|
|
|
6
6
|
export function registerLogsTools(server: McpServer, docker: Dockerode): void {
|
|
7
7
|
server.tool(
|
|
@@ -12,13 +12,13 @@ export function registerLogsTools(server: McpServer, docker: Dockerode): void {
|
|
|
12
12
|
async (params) => {
|
|
13
13
|
try {
|
|
14
14
|
const container = docker.getContainer(params.container_id);
|
|
15
|
-
const logs = await container.logs({
|
|
15
|
+
const logs = await withRetry(() => container.logs({
|
|
16
16
|
stdout: true,
|
|
17
17
|
stderr: true,
|
|
18
18
|
tail: params.tail ?? 100,
|
|
19
19
|
since: params.since ? Math.floor(new Date(params.since).getTime() / 1000) : undefined,
|
|
20
20
|
follow: false as const,
|
|
21
|
-
});
|
|
21
|
+
}), { label: "container_logs" });
|
|
22
22
|
// Dockerode returns a Buffer with multiplexed stream headers
|
|
23
23
|
// Use 100KB cap for logs to keep LLM context small
|
|
24
24
|
const output = sanitizeOutput(logs.toString("utf-8"), 100_000);
|
package/src/tools/network.ts
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import Dockerode from "dockerode";
|
|
2
2
|
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
3
3
|
import { ListNetworksSchema, ListVolumesSchema } from "../types.js";
|
|
4
|
-
import { formatError } from "../docker.js";
|
|
4
|
+
import { formatError, withRetry } from "../docker.js";
|
|
5
5
|
|
|
6
6
|
export function registerNetworkTools(server: McpServer, docker: Dockerode): void {
|
|
7
7
|
server.tool(
|
|
@@ -11,9 +11,9 @@ export function registerNetworkTools(server: McpServer, docker: Dockerode): void
|
|
|
11
11
|
{ readOnlyHint: true, idempotentHint: true, openWorldHint: false },
|
|
12
12
|
async (params) => {
|
|
13
13
|
try {
|
|
14
|
-
const networks = await docker.listNetworks({
|
|
14
|
+
const networks = await withRetry(() => docker.listNetworks({
|
|
15
15
|
filters: params.filter ? JSON.stringify({ name: [params.filter] }) : undefined,
|
|
16
|
-
});
|
|
16
|
+
}), { label: "list_networks" });
|
|
17
17
|
const results = networks.map((n) => ({
|
|
18
18
|
id: n.Id.substring(0, 12),
|
|
19
19
|
name: n.Name,
|
package/src/tools/volume.ts
CHANGED
|
@@ -6,7 +6,7 @@ import {
|
|
|
6
6
|
RemoveVolumeSchema,
|
|
7
7
|
PruneVolumesSchema,
|
|
8
8
|
} from "../types.js";
|
|
9
|
-
import { formatError } from "../docker.js";
|
|
9
|
+
import { formatError, withRetry } from "../docker.js";
|
|
10
10
|
|
|
11
11
|
export function registerVolumeTools(server: McpServer, docker: Dockerode): void {
|
|
12
12
|
server.tool(
|
|
@@ -16,12 +16,12 @@ export function registerVolumeTools(server: McpServer, docker: Dockerode): void
|
|
|
16
16
|
{ readOnlyHint: false, destructiveHint: false, idempotentHint: true, openWorldHint: false },
|
|
17
17
|
async (params) => {
|
|
18
18
|
try {
|
|
19
|
-
const result = await docker.createVolume({
|
|
19
|
+
const result = await withRetry(() => docker.createVolume({
|
|
20
20
|
Name: params.name,
|
|
21
21
|
Driver: params.driver || "local",
|
|
22
22
|
Labels: params.labels,
|
|
23
23
|
DriverOpts: params.options,
|
|
24
|
-
});
|
|
24
|
+
}), { label: "create_volume" });
|
|
25
25
|
return {
|
|
26
26
|
content: [{
|
|
27
27
|
type: "text",
|
|
@@ -122,4 +122,4 @@ export function registerVolumeTools(server: McpServer, docker: Dockerode): void
|
|
|
122
122
|
}
|
|
123
123
|
}
|
|
124
124
|
);
|
|
125
|
-
}
|
|
125
|
+
}
|
|
@@ -0,0 +1,82 @@
|
|
|
1
|
+
import { describe, it, expect, vi } from "vitest";
|
|
2
|
+
import { withRetry, DockerTimeoutError, DockerConnectionError, DockerPermissionError } from "../src/docker.js";
|
|
3
|
+
|
|
4
|
+
describe("withRetry", () => {
|
|
5
|
+
it("returns result on first attempt (no retry needed)", async () => {
|
|
6
|
+
const fn = vi.fn().mockResolvedValue("success");
|
|
7
|
+
const result = await withRetry(fn, { maxRetries: 3, baseDelayMs: 10 });
|
|
8
|
+
expect(result).toBe("success");
|
|
9
|
+
expect(fn).toHaveBeenCalledTimes(1);
|
|
10
|
+
});
|
|
11
|
+
|
|
12
|
+
it("retries on transient ECONNRESET error", async () => {
|
|
13
|
+
const fn = vi.fn()
|
|
14
|
+
.mockRejectedValueOnce(new Error("read ECONNRESET"))
|
|
15
|
+
.mockResolvedValue("recovered");
|
|
16
|
+
const result = await withRetry(fn, { maxRetries: 3, baseDelayMs: 10, label: "test" });
|
|
17
|
+
expect(result).toBe("recovered");
|
|
18
|
+
expect(fn).toHaveBeenCalledTimes(2);
|
|
19
|
+
});
|
|
20
|
+
|
|
21
|
+
it("retries on timeout error", async () => {
|
|
22
|
+
const fn = vi.fn()
|
|
23
|
+
.mockRejectedValueOnce(new DockerTimeoutError("timed out"))
|
|
24
|
+
.mockResolvedValue("recovered");
|
|
25
|
+
const result = await withRetry(fn, { maxRetries: 3, baseDelayMs: 10 });
|
|
26
|
+
expect(result).toBe("recovered");
|
|
27
|
+
expect(fn).toHaveBeenCalledTimes(2);
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
it("does NOT retry on 404 Not Found", async () => {
|
|
31
|
+
const fn = vi.fn().mockRejectedValue(new Error("HTTP 404: Not Found"));
|
|
32
|
+
await expect(withRetry(fn, { maxRetries: 3, baseDelayMs: 10 }))
|
|
33
|
+
.rejects.toThrow("HTTP 404: Not Found");
|
|
34
|
+
expect(fn).toHaveBeenCalledTimes(1);
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
it("does NOT retry on permission denied", async () => {
|
|
38
|
+
const fn = vi.fn().mockRejectedValue(new Error("Permission denied"));
|
|
39
|
+
await expect(withRetry(fn, { maxRetries: 3, baseDelayMs: 10 }))
|
|
40
|
+
.rejects.toThrow("Permission denied");
|
|
41
|
+
expect(fn).toHaveBeenCalledTimes(1);
|
|
42
|
+
});
|
|
43
|
+
|
|
44
|
+
it("does NOT retry on DockerConnectionError", async () => {
|
|
45
|
+
const fn = vi.fn().mockRejectedValue(new DockerConnectionError("cannot connect"));
|
|
46
|
+
await expect(withRetry(fn, { maxRetries: 3, baseDelayMs: 10 }))
|
|
47
|
+
.rejects.toThrow("cannot connect");
|
|
48
|
+
expect(fn).toHaveBeenCalledTimes(1);
|
|
49
|
+
});
|
|
50
|
+
|
|
51
|
+
it("does NOT retry on DockerPermissionError", async () => {
|
|
52
|
+
const fn = vi.fn().mockRejectedValue(new DockerPermissionError("access denied"));
|
|
53
|
+
await expect(withRetry(fn, { maxRetries: 3, baseDelayMs: 10 }))
|
|
54
|
+
.rejects.toThrow("access denied");
|
|
55
|
+
expect(fn).toHaveBeenCalledTimes(1);
|
|
56
|
+
});
|
|
57
|
+
|
|
58
|
+
it("retries on 500 Internal Server Error", async () => {
|
|
59
|
+
const fn = vi.fn()
|
|
60
|
+
.mockRejectedValueOnce(new Error("HTTP 500: Internal Server Error"))
|
|
61
|
+
.mockResolvedValue("recovered");
|
|
62
|
+
const result = await withRetry(fn, { maxRetries: 3, baseDelayMs: 10 });
|
|
63
|
+
expect(result).toBe("recovered");
|
|
64
|
+
expect(fn).toHaveBeenCalledTimes(2);
|
|
65
|
+
});
|
|
66
|
+
|
|
67
|
+
it("exhausts retries and throws last error", async () => {
|
|
68
|
+
const fn = vi.fn().mockRejectedValue(new Error("read ECONNRESET"));
|
|
69
|
+
await expect(withRetry(fn, { maxRetries: 2, baseDelayMs: 10 }))
|
|
70
|
+
.rejects.toThrow("read ECONNRESET");
|
|
71
|
+
expect(fn).toHaveBeenCalledTimes(3); // initial + 2 retries
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
it("retries on socket hang up", async () => {
|
|
75
|
+
const fn = vi.fn()
|
|
76
|
+
.mockRejectedValueOnce(new Error("socket hang up"))
|
|
77
|
+
.mockResolvedValue("ok");
|
|
78
|
+
const result = await withRetry(fn, { maxRetries: 3, baseDelayMs: 10 });
|
|
79
|
+
expect(result).toBe("ok");
|
|
80
|
+
expect(fn).toHaveBeenCalledTimes(2);
|
|
81
|
+
});
|
|
82
|
+
});
|