@supernova123/docker-mcp-server 0.3.3 → 0.3.4
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/CHANGELOG.md +6 -0
- package/dist/server.js +2 -0
- package/dist/tools/transfer.d.ts +4 -0
- package/dist/tools/transfer.js +175 -0
- package/dist/types.d.ts +26 -0
- package/dist/types.js +11 -0
- package/package.json +1 -1
- package/src/server.ts +3 -1
- package/src/tools/transfer.ts +245 -0
- package/src/types.ts +14 -1
- package/tests/transfer.test.ts +176 -0
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,12 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to @supernova123/docker-mcp-server will be documented in this file.
|
|
4
4
|
|
|
5
|
+
## [0.3.3] - 2026-06-13
|
|
6
|
+
|
|
7
|
+
### Added
|
|
8
|
+
- **docker_info** tool — Docker daemon system information (version, OS, kernel, CPU, memory, storage driver, container/image counts)
|
|
9
|
+
- **disk_usage** tool — Disk usage breakdown by images, containers, volumes, and build cache with human-readable sizes
|
|
10
|
+
|
|
5
11
|
## [0.3.2] - 2026-06-13
|
|
6
12
|
|
|
7
13
|
### Added
|
package/dist/server.js
CHANGED
|
@@ -9,6 +9,7 @@ import { registerNetworkTools } from "./tools/network.js";
|
|
|
9
9
|
import { registerVolumeTools } from "./tools/volume.js";
|
|
10
10
|
import { registerMonitoringTools } from "./tools/monitoring.js";
|
|
11
11
|
import { registerSystemTools } from "./tools/system.js";
|
|
12
|
+
import { registerTransferTools } from "./tools/transfer.js";
|
|
12
13
|
export function createServer(docker, options) {
|
|
13
14
|
const server = new McpServer({
|
|
14
15
|
name: "docker-mcp-server",
|
|
@@ -25,6 +26,7 @@ export function createServer(docker, options) {
|
|
|
25
26
|
registerVolumeTools(server, docker);
|
|
26
27
|
registerMonitoringTools(server, docker);
|
|
27
28
|
registerSystemTools(server, docker);
|
|
29
|
+
registerTransferTools(server, docker);
|
|
28
30
|
return server;
|
|
29
31
|
}
|
|
30
32
|
//# sourceMappingURL=server.js.map
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { Readable } from "stream";
|
|
2
|
+
import { CopyFromContainerSchema, CopyToContainerSchema } from "../types.js";
|
|
3
|
+
import { formatError, withRetry } from "../docker.js";
|
|
4
|
+
/**
|
|
5
|
+
* Read a file from a container using docker exec (cat).
|
|
6
|
+
* Much simpler and more reliable than parsing getArchive tar streams.
|
|
7
|
+
*/
|
|
8
|
+
async function readFileViaExec(docker, containerId, filePath) {
|
|
9
|
+
const container = docker.getContainer(containerId);
|
|
10
|
+
// Create exec to cat the file
|
|
11
|
+
const exec = await container.exec({
|
|
12
|
+
Cmd: ["cat", filePath],
|
|
13
|
+
AttachStdout: true,
|
|
14
|
+
AttachStderr: true,
|
|
15
|
+
});
|
|
16
|
+
// Start exec and collect output
|
|
17
|
+
const stream = await exec.start({ Detach: false });
|
|
18
|
+
const chunks = [];
|
|
19
|
+
return new Promise((resolve, reject) => {
|
|
20
|
+
stream.on("data", (chunk) => {
|
|
21
|
+
// Docker exec streams have 8-byte headers per frame
|
|
22
|
+
// Skip the header bytes (first 8 bytes of each frame)
|
|
23
|
+
if (chunk.length > 8) {
|
|
24
|
+
chunks.push(chunk.slice(8));
|
|
25
|
+
}
|
|
26
|
+
});
|
|
27
|
+
stream.on("end", () => {
|
|
28
|
+
const content = Buffer.concat(chunks).toString("utf-8");
|
|
29
|
+
resolve({ content, size: content.length });
|
|
30
|
+
});
|
|
31
|
+
stream.on("error", reject);
|
|
32
|
+
});
|
|
33
|
+
}
|
|
34
|
+
/**
|
|
35
|
+
* Get file metadata (size, permissions) via stat command.
|
|
36
|
+
*/
|
|
37
|
+
async function getFileStat(docker, containerId, filePath) {
|
|
38
|
+
const container = docker.getContainer(containerId);
|
|
39
|
+
const exec = await container.exec({
|
|
40
|
+
Cmd: ["stat", "-c", "%s %a %f", filePath],
|
|
41
|
+
AttachStdout: true,
|
|
42
|
+
AttachStderr: true,
|
|
43
|
+
});
|
|
44
|
+
const stream = await exec.start({ Detach: false });
|
|
45
|
+
const chunks = [];
|
|
46
|
+
return new Promise((resolve, reject) => {
|
|
47
|
+
stream.on("data", (chunk) => {
|
|
48
|
+
if (chunk.length > 8)
|
|
49
|
+
chunks.push(chunk.slice(8));
|
|
50
|
+
});
|
|
51
|
+
stream.on("end", () => {
|
|
52
|
+
const output = Buffer.concat(chunks).toString("utf-8").trim();
|
|
53
|
+
const [sizeStr, modeStr, typeStr] = output.split(" ");
|
|
54
|
+
const size = parseInt(sizeStr, 10) || 0;
|
|
55
|
+
const mode = modeStr || "644";
|
|
56
|
+
const isFile = typeStr?.startsWith("81") ?? true;
|
|
57
|
+
resolve({ size, mode: `0${mode}`, isFile });
|
|
58
|
+
});
|
|
59
|
+
stream.on("error", reject);
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
/**
|
|
63
|
+
* Create a minimal tar archive buffer containing a single file.
|
|
64
|
+
* Used for putArchive to inject files into containers.
|
|
65
|
+
*/
|
|
66
|
+
function createSingleFileTar(filePath, content, mode) {
|
|
67
|
+
const contentBuffer = Buffer.from(content, "utf-8");
|
|
68
|
+
const contentBlocks = Math.ceil(contentBuffer.length / 512);
|
|
69
|
+
const totalSize = 512 + contentBlocks * 512;
|
|
70
|
+
const tar = Buffer.alloc(totalSize, 0);
|
|
71
|
+
// File name (100 bytes, null-terminated)
|
|
72
|
+
const nameBytes = Buffer.from(filePath, "utf-8");
|
|
73
|
+
nameBytes.copy(tar, 0, 0, Math.min(nameBytes.length, 100));
|
|
74
|
+
// File mode (8 bytes, octal, null-padded)
|
|
75
|
+
const modeStr = mode.toString(8).padStart(7, "0") + "\0";
|
|
76
|
+
Buffer.from(modeStr).copy(tar, 100);
|
|
77
|
+
// Owner ID (8 bytes) - 0
|
|
78
|
+
Buffer.from("0000000\0").copy(tar, 108);
|
|
79
|
+
// Group ID (8 bytes) - 0
|
|
80
|
+
Buffer.from("0000000\0").copy(tar, 116);
|
|
81
|
+
// File size (12 bytes, octal)
|
|
82
|
+
const sizeStr = contentBuffer.length.toString(8).padStart(11, "0") + "\0";
|
|
83
|
+
Buffer.from(sizeStr).copy(tar, 124);
|
|
84
|
+
// Modification time (12 bytes, octal)
|
|
85
|
+
const mtime = Math.floor(Date.now() / 1000);
|
|
86
|
+
const mtimeStr = mtime.toString(8).padStart(11, "0") + "\0";
|
|
87
|
+
Buffer.from(mtimeStr).copy(tar, 136);
|
|
88
|
+
// Type flag (1 byte) - '0' = regular file
|
|
89
|
+
tar[156] = 0x30; // '0'
|
|
90
|
+
// Checksum placeholder (8 bytes)
|
|
91
|
+
tar.fill(" ", 148, 156);
|
|
92
|
+
// Compute checksum
|
|
93
|
+
let checksum = 0;
|
|
94
|
+
for (let i = 0; i < 512; i++) {
|
|
95
|
+
checksum += tar[i];
|
|
96
|
+
}
|
|
97
|
+
const chkStr = checksum.toString(8).padStart(7, "0") + "\0";
|
|
98
|
+
Buffer.from(chkStr).copy(tar, 148);
|
|
99
|
+
// Copy content
|
|
100
|
+
contentBuffer.copy(tar, 512);
|
|
101
|
+
return tar;
|
|
102
|
+
}
|
|
103
|
+
export function registerTransferTools(server, docker) {
|
|
104
|
+
server.tool("copy_from_container", "Copy a file from a Docker container to read its contents. Returns the file content as text along with metadata (size, permissions). Useful for inspecting config files, logs, or application state inside running containers.", CopyFromContainerSchema.shape, { readOnlyHint: true, idempotentHint: true, openWorldHint: false }, async (params) => {
|
|
105
|
+
try {
|
|
106
|
+
const { content, size } = await withRetry(() => readFileViaExec(docker, params.container_id, params.container_path), { label: "copy_from_container" });
|
|
107
|
+
// Get metadata (stat)
|
|
108
|
+
let mode = "0644";
|
|
109
|
+
try {
|
|
110
|
+
const stat = await getFileStat(docker, params.container_id, params.container_path);
|
|
111
|
+
mode = stat.mode;
|
|
112
|
+
}
|
|
113
|
+
catch {
|
|
114
|
+
// stat might fail if file doesn't exist, exec already validated it
|
|
115
|
+
}
|
|
116
|
+
const result = {
|
|
117
|
+
path: params.container_path,
|
|
118
|
+
content,
|
|
119
|
+
size,
|
|
120
|
+
mode,
|
|
121
|
+
truncated: content.length > 50000,
|
|
122
|
+
};
|
|
123
|
+
return {
|
|
124
|
+
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
|
|
125
|
+
};
|
|
126
|
+
}
|
|
127
|
+
catch (error) {
|
|
128
|
+
return {
|
|
129
|
+
content: [{ type: "text", text: `Error: ${formatError(error)}` }],
|
|
130
|
+
isError: true,
|
|
131
|
+
};
|
|
132
|
+
}
|
|
133
|
+
});
|
|
134
|
+
server.tool("copy_to_container", "Write file content into a Docker container at the specified path. Overwrites existing files. Useful for injecting configuration files, scripts, or environment files into running or stopped containers.", CopyToContainerSchema.shape, { readOnlyHint: false, idempotentHint: false, openWorldHint: false }, async (params) => {
|
|
135
|
+
try {
|
|
136
|
+
const container = docker.getContainer(params.container_id);
|
|
137
|
+
const mode = params.mode ?? 0o644;
|
|
138
|
+
// Create tar archive with the file
|
|
139
|
+
const tarBuffer = createSingleFileTar(params.container_path, params.content, mode);
|
|
140
|
+
// putArchive expects the path to be the PARENT directory
|
|
141
|
+
const parts = params.container_path.split("/");
|
|
142
|
+
parts.pop(); // remove filename
|
|
143
|
+
const dirPath = parts.join("/") || "/";
|
|
144
|
+
const readable = Readable.from(tarBuffer);
|
|
145
|
+
// Use putArchive with promise API
|
|
146
|
+
await withRetry(() => new Promise((resolve, reject) => {
|
|
147
|
+
container
|
|
148
|
+
.putArchive(readable, { path: dirPath })
|
|
149
|
+
.then(() => resolve())
|
|
150
|
+
.catch(reject);
|
|
151
|
+
}), { label: "copy_to_container" });
|
|
152
|
+
return {
|
|
153
|
+
content: [
|
|
154
|
+
{
|
|
155
|
+
type: "text",
|
|
156
|
+
text: JSON.stringify({
|
|
157
|
+
success: true,
|
|
158
|
+
path: params.container_path,
|
|
159
|
+
size: Buffer.byteLength(params.content, "utf-8"),
|
|
160
|
+
mode: `0${(mode & 0o777).toString(8)}`,
|
|
161
|
+
message: `File written to ${params.container_path} in container ${params.container_id}`,
|
|
162
|
+
}),
|
|
163
|
+
},
|
|
164
|
+
],
|
|
165
|
+
};
|
|
166
|
+
}
|
|
167
|
+
catch (error) {
|
|
168
|
+
return {
|
|
169
|
+
content: [{ type: "text", text: `Error: ${formatError(error)}` }],
|
|
170
|
+
isError: true,
|
|
171
|
+
};
|
|
172
|
+
}
|
|
173
|
+
});
|
|
174
|
+
}
|
|
175
|
+
//# sourceMappingURL=transfer.js.map
|
package/dist/types.d.ts
CHANGED
|
@@ -405,4 +405,30 @@ export declare const ResourceAlertCheckSchema: z.ZodObject<{
|
|
|
405
405
|
export declare const MonitorDashboardSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
406
406
|
export declare const DockerInfoSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
407
407
|
export declare const DiskUsageSchema: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
|
|
408
|
+
export declare const CopyFromContainerSchema: z.ZodObject<{
|
|
409
|
+
container_id: z.ZodString;
|
|
410
|
+
container_path: z.ZodString;
|
|
411
|
+
}, "strip", z.ZodTypeAny, {
|
|
412
|
+
container_id: string;
|
|
413
|
+
container_path: string;
|
|
414
|
+
}, {
|
|
415
|
+
container_id: string;
|
|
416
|
+
container_path: string;
|
|
417
|
+
}>;
|
|
418
|
+
export declare const CopyToContainerSchema: z.ZodObject<{
|
|
419
|
+
container_id: z.ZodString;
|
|
420
|
+
container_path: z.ZodString;
|
|
421
|
+
content: z.ZodString;
|
|
422
|
+
mode: z.ZodOptional<z.ZodNumber>;
|
|
423
|
+
}, "strip", z.ZodTypeAny, {
|
|
424
|
+
container_id: string;
|
|
425
|
+
container_path: string;
|
|
426
|
+
content: string;
|
|
427
|
+
mode?: number | undefined;
|
|
428
|
+
}, {
|
|
429
|
+
container_id: string;
|
|
430
|
+
container_path: string;
|
|
431
|
+
content: string;
|
|
432
|
+
mode?: number | undefined;
|
|
433
|
+
}>;
|
|
408
434
|
//# sourceMappingURL=types.d.ts.map
|
package/dist/types.js
CHANGED
|
@@ -176,4 +176,15 @@ export const MonitorDashboardSchema = z.object({});
|
|
|
176
176
|
// System info schemas (v0.3.3)
|
|
177
177
|
export const DockerInfoSchema = z.object({});
|
|
178
178
|
export const DiskUsageSchema = z.object({});
|
|
179
|
+
// File transfer schemas (v0.3.4)
|
|
180
|
+
export const CopyFromContainerSchema = z.object({
|
|
181
|
+
container_id: z.string().describe("Container ID or name"),
|
|
182
|
+
container_path: z.string().describe("Path inside container to copy from (e.g., '/etc/nginx/nginx.conf')"),
|
|
183
|
+
});
|
|
184
|
+
export const CopyToContainerSchema = z.object({
|
|
185
|
+
container_id: z.string().describe("Container ID or name"),
|
|
186
|
+
container_path: z.string().describe("Destination path inside container (e.g., '/app/config.json')"),
|
|
187
|
+
content: z.string().describe("File content to write (plain text)"),
|
|
188
|
+
mode: z.number().optional().describe("File permissions in octal (e.g., 0o644 = 420). Default: 0o644"),
|
|
189
|
+
});
|
|
179
190
|
//# sourceMappingURL=types.js.map
|
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.4",
|
|
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/server.ts
CHANGED
|
@@ -10,6 +10,7 @@ import { registerNetworkTools } from "./tools/network.js";
|
|
|
10
10
|
import { registerVolumeTools } from "./tools/volume.js";
|
|
11
11
|
import { registerMonitoringTools } from "./tools/monitoring.js";
|
|
12
12
|
import { registerSystemTools } from "./tools/system.js";
|
|
13
|
+
import { registerTransferTools } from "./tools/transfer.js";
|
|
13
14
|
|
|
14
15
|
export interface ServerOptions {
|
|
15
16
|
timeoutMs?: number;
|
|
@@ -32,6 +33,7 @@ export function createServer(docker: Dockerode, options?: ServerOptions): McpSer
|
|
|
32
33
|
registerVolumeTools(server, docker);
|
|
33
34
|
registerMonitoringTools(server, docker);
|
|
34
35
|
registerSystemTools(server, docker);
|
|
36
|
+
registerTransferTools(server, docker);
|
|
35
37
|
|
|
36
38
|
return server;
|
|
37
|
-
}
|
|
39
|
+
}
|
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
import Dockerode from "dockerode";
|
|
2
|
+
import { Readable } from "stream";
|
|
3
|
+
import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
|
|
4
|
+
import { CopyFromContainerSchema, CopyToContainerSchema } from "../types.js";
|
|
5
|
+
import { formatError, withRetry } from "../docker.js";
|
|
6
|
+
|
|
7
|
+
/**
|
|
8
|
+
* Read a file from a container using docker exec (cat).
|
|
9
|
+
* Much simpler and more reliable than parsing getArchive tar streams.
|
|
10
|
+
*/
|
|
11
|
+
async function readFileViaExec(
|
|
12
|
+
docker: Dockerode,
|
|
13
|
+
containerId: string,
|
|
14
|
+
filePath: string
|
|
15
|
+
): Promise<{ content: string; size: number }> {
|
|
16
|
+
const container = docker.getContainer(containerId);
|
|
17
|
+
|
|
18
|
+
// Create exec to cat the file
|
|
19
|
+
const exec = await container.exec({
|
|
20
|
+
Cmd: ["cat", filePath],
|
|
21
|
+
AttachStdout: true,
|
|
22
|
+
AttachStderr: true,
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
// Start exec and collect output
|
|
26
|
+
const stream = await exec.start({ Detach: false });
|
|
27
|
+
|
|
28
|
+
const chunks: Buffer[] = [];
|
|
29
|
+
return new Promise((resolve, reject) => {
|
|
30
|
+
stream.on("data", (chunk: Buffer) => {
|
|
31
|
+
// Docker exec streams have 8-byte headers per frame
|
|
32
|
+
// Skip the header bytes (first 8 bytes of each frame)
|
|
33
|
+
if (chunk.length > 8) {
|
|
34
|
+
chunks.push(chunk.slice(8));
|
|
35
|
+
}
|
|
36
|
+
});
|
|
37
|
+
stream.on("end", () => {
|
|
38
|
+
const content = Buffer.concat(chunks).toString("utf-8");
|
|
39
|
+
resolve({ content, size: content.length });
|
|
40
|
+
});
|
|
41
|
+
stream.on("error", reject);
|
|
42
|
+
});
|
|
43
|
+
}
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Get file metadata (size, permissions) via stat command.
|
|
47
|
+
*/
|
|
48
|
+
async function getFileStat(
|
|
49
|
+
docker: Dockerode,
|
|
50
|
+
containerId: string,
|
|
51
|
+
filePath: string
|
|
52
|
+
): Promise<{ size: number; mode: string; isFile: boolean }> {
|
|
53
|
+
const container = docker.getContainer(containerId);
|
|
54
|
+
|
|
55
|
+
const exec = await container.exec({
|
|
56
|
+
Cmd: ["stat", "-c", "%s %a %f", filePath],
|
|
57
|
+
AttachStdout: true,
|
|
58
|
+
AttachStderr: true,
|
|
59
|
+
});
|
|
60
|
+
|
|
61
|
+
const stream = await exec.start({ Detach: false });
|
|
62
|
+
const chunks: Buffer[] = [];
|
|
63
|
+
|
|
64
|
+
return new Promise((resolve, reject) => {
|
|
65
|
+
stream.on("data", (chunk: Buffer) => {
|
|
66
|
+
if (chunk.length > 8) chunks.push(chunk.slice(8));
|
|
67
|
+
});
|
|
68
|
+
stream.on("end", () => {
|
|
69
|
+
const output = Buffer.concat(chunks).toString("utf-8").trim();
|
|
70
|
+
const [sizeStr, modeStr, typeStr] = output.split(" ");
|
|
71
|
+
const size = parseInt(sizeStr, 10) || 0;
|
|
72
|
+
const mode = modeStr || "644";
|
|
73
|
+
const isFile = typeStr?.startsWith("81") ?? true;
|
|
74
|
+
resolve({ size, mode: `0${mode}`, isFile });
|
|
75
|
+
});
|
|
76
|
+
stream.on("error", reject);
|
|
77
|
+
});
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Create a minimal tar archive buffer containing a single file.
|
|
82
|
+
* Used for putArchive to inject files into containers.
|
|
83
|
+
*/
|
|
84
|
+
function createSingleFileTar(
|
|
85
|
+
filePath: string,
|
|
86
|
+
content: string,
|
|
87
|
+
mode: number
|
|
88
|
+
): Buffer {
|
|
89
|
+
const contentBuffer = Buffer.from(content, "utf-8");
|
|
90
|
+
const contentBlocks = Math.ceil(contentBuffer.length / 512);
|
|
91
|
+
const totalSize = 512 + contentBlocks * 512;
|
|
92
|
+
|
|
93
|
+
const tar = Buffer.alloc(totalSize, 0);
|
|
94
|
+
|
|
95
|
+
// File name (100 bytes, null-terminated)
|
|
96
|
+
const nameBytes = Buffer.from(filePath, "utf-8");
|
|
97
|
+
nameBytes.copy(tar, 0, 0, Math.min(nameBytes.length, 100));
|
|
98
|
+
|
|
99
|
+
// File mode (8 bytes, octal, null-padded)
|
|
100
|
+
const modeStr = mode.toString(8).padStart(7, "0") + "\0";
|
|
101
|
+
Buffer.from(modeStr).copy(tar, 100);
|
|
102
|
+
|
|
103
|
+
// Owner ID (8 bytes) - 0
|
|
104
|
+
Buffer.from("0000000\0").copy(tar, 108);
|
|
105
|
+
|
|
106
|
+
// Group ID (8 bytes) - 0
|
|
107
|
+
Buffer.from("0000000\0").copy(tar, 116);
|
|
108
|
+
|
|
109
|
+
// File size (12 bytes, octal)
|
|
110
|
+
const sizeStr = contentBuffer.length.toString(8).padStart(11, "0") + "\0";
|
|
111
|
+
Buffer.from(sizeStr).copy(tar, 124);
|
|
112
|
+
|
|
113
|
+
// Modification time (12 bytes, octal)
|
|
114
|
+
const mtime = Math.floor(Date.now() / 1000);
|
|
115
|
+
const mtimeStr = mtime.toString(8).padStart(11, "0") + "\0";
|
|
116
|
+
Buffer.from(mtimeStr).copy(tar, 136);
|
|
117
|
+
|
|
118
|
+
// Type flag (1 byte) - '0' = regular file
|
|
119
|
+
tar[156] = 0x30; // '0'
|
|
120
|
+
|
|
121
|
+
// Checksum placeholder (8 bytes)
|
|
122
|
+
tar.fill(" ", 148, 156);
|
|
123
|
+
|
|
124
|
+
// Compute checksum
|
|
125
|
+
let checksum = 0;
|
|
126
|
+
for (let i = 0; i < 512; i++) {
|
|
127
|
+
checksum += tar[i];
|
|
128
|
+
}
|
|
129
|
+
const chkStr = checksum.toString(8).padStart(7, "0") + "\0";
|
|
130
|
+
Buffer.from(chkStr).copy(tar, 148);
|
|
131
|
+
|
|
132
|
+
// Copy content
|
|
133
|
+
contentBuffer.copy(tar, 512);
|
|
134
|
+
|
|
135
|
+
return tar;
|
|
136
|
+
}
|
|
137
|
+
|
|
138
|
+
export function registerTransferTools(
|
|
139
|
+
server: McpServer,
|
|
140
|
+
docker: Dockerode
|
|
141
|
+
): void {
|
|
142
|
+
server.tool(
|
|
143
|
+
"copy_from_container",
|
|
144
|
+
"Copy a file from a Docker container to read its contents. Returns the file content as text along with metadata (size, permissions). Useful for inspecting config files, logs, or application state inside running containers.",
|
|
145
|
+
CopyFromContainerSchema.shape,
|
|
146
|
+
{ readOnlyHint: true, idempotentHint: true, openWorldHint: false },
|
|
147
|
+
async (params) => {
|
|
148
|
+
try {
|
|
149
|
+
const { content, size } = await withRetry(
|
|
150
|
+
() => readFileViaExec(docker, params.container_id, params.container_path),
|
|
151
|
+
{ label: "copy_from_container" }
|
|
152
|
+
);
|
|
153
|
+
|
|
154
|
+
// Get metadata (stat)
|
|
155
|
+
let mode = "0644";
|
|
156
|
+
try {
|
|
157
|
+
const stat = await getFileStat(
|
|
158
|
+
docker,
|
|
159
|
+
params.container_id,
|
|
160
|
+
params.container_path
|
|
161
|
+
);
|
|
162
|
+
mode = stat.mode;
|
|
163
|
+
} catch {
|
|
164
|
+
// stat might fail if file doesn't exist, exec already validated it
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
const result = {
|
|
168
|
+
path: params.container_path,
|
|
169
|
+
content,
|
|
170
|
+
size,
|
|
171
|
+
mode,
|
|
172
|
+
truncated: content.length > 50000,
|
|
173
|
+
};
|
|
174
|
+
|
|
175
|
+
return {
|
|
176
|
+
content: [{ type: "text", text: JSON.stringify(result, null, 2) }],
|
|
177
|
+
};
|
|
178
|
+
} catch (error) {
|
|
179
|
+
return {
|
|
180
|
+
content: [{ type: "text", text: `Error: ${formatError(error)}` }],
|
|
181
|
+
isError: true,
|
|
182
|
+
};
|
|
183
|
+
}
|
|
184
|
+
}
|
|
185
|
+
);
|
|
186
|
+
|
|
187
|
+
server.tool(
|
|
188
|
+
"copy_to_container",
|
|
189
|
+
"Write file content into a Docker container at the specified path. Overwrites existing files. Useful for injecting configuration files, scripts, or environment files into running or stopped containers.",
|
|
190
|
+
CopyToContainerSchema.shape,
|
|
191
|
+
{ readOnlyHint: false, idempotentHint: false, openWorldHint: false },
|
|
192
|
+
async (params) => {
|
|
193
|
+
try {
|
|
194
|
+
const container = docker.getContainer(params.container_id);
|
|
195
|
+
const mode = params.mode ?? 0o644;
|
|
196
|
+
|
|
197
|
+
// Create tar archive with the file
|
|
198
|
+
const tarBuffer = createSingleFileTar(
|
|
199
|
+
params.container_path,
|
|
200
|
+
params.content,
|
|
201
|
+
mode
|
|
202
|
+
);
|
|
203
|
+
|
|
204
|
+
// putArchive expects the path to be the PARENT directory
|
|
205
|
+
const parts = params.container_path.split("/");
|
|
206
|
+
parts.pop(); // remove filename
|
|
207
|
+
const dirPath = parts.join("/") || "/";
|
|
208
|
+
|
|
209
|
+
const readable = Readable.from(tarBuffer);
|
|
210
|
+
|
|
211
|
+
// Use putArchive with promise API
|
|
212
|
+
await withRetry(
|
|
213
|
+
() =>
|
|
214
|
+
new Promise<void>((resolve, reject) => {
|
|
215
|
+
container
|
|
216
|
+
.putArchive(readable as any, { path: dirPath })
|
|
217
|
+
.then(() => resolve())
|
|
218
|
+
.catch(reject);
|
|
219
|
+
}),
|
|
220
|
+
{ label: "copy_to_container" }
|
|
221
|
+
);
|
|
222
|
+
|
|
223
|
+
return {
|
|
224
|
+
content: [
|
|
225
|
+
{
|
|
226
|
+
type: "text",
|
|
227
|
+
text: JSON.stringify({
|
|
228
|
+
success: true,
|
|
229
|
+
path: params.container_path,
|
|
230
|
+
size: Buffer.byteLength(params.content, "utf-8"),
|
|
231
|
+
mode: `0${(mode & 0o777).toString(8)}`,
|
|
232
|
+
message: `File written to ${params.container_path} in container ${params.container_id}`,
|
|
233
|
+
}),
|
|
234
|
+
},
|
|
235
|
+
],
|
|
236
|
+
};
|
|
237
|
+
} catch (error) {
|
|
238
|
+
return {
|
|
239
|
+
content: [{ type: "text", text: `Error: ${formatError(error)}` }],
|
|
240
|
+
isError: true,
|
|
241
|
+
};
|
|
242
|
+
}
|
|
243
|
+
}
|
|
244
|
+
);
|
|
245
|
+
}
|
package/src/types.ts
CHANGED
|
@@ -220,4 +220,17 @@ export const MonitorDashboardSchema = z.object({});
|
|
|
220
220
|
// System info schemas (v0.3.3)
|
|
221
221
|
export const DockerInfoSchema = z.object({});
|
|
222
222
|
|
|
223
|
-
export const DiskUsageSchema = z.object({});
|
|
223
|
+
export const DiskUsageSchema = z.object({});
|
|
224
|
+
|
|
225
|
+
// File transfer schemas (v0.3.4)
|
|
226
|
+
export const CopyFromContainerSchema = z.object({
|
|
227
|
+
container_id: z.string().describe("Container ID or name"),
|
|
228
|
+
container_path: z.string().describe("Path inside container to copy from (e.g., '/etc/nginx/nginx.conf')"),
|
|
229
|
+
});
|
|
230
|
+
|
|
231
|
+
export const CopyToContainerSchema = z.object({
|
|
232
|
+
container_id: z.string().describe("Container ID or name"),
|
|
233
|
+
container_path: z.string().describe("Destination path inside container (e.g., '/app/config.json')"),
|
|
234
|
+
content: z.string().describe("File content to write (plain text)"),
|
|
235
|
+
mode: z.number().optional().describe("File permissions in octal (e.g., 0o644 = 420). Default: 0o644"),
|
|
236
|
+
});
|
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
import { describe, it, expect, vi, beforeEach } from "vitest";
|
|
2
|
+
import { PassThrough } from "stream";
|
|
3
|
+
|
|
4
|
+
const { mockExec, mockPutArchive } = vi.hoisted(() => ({
|
|
5
|
+
mockExec: vi.fn(),
|
|
6
|
+
mockPutArchive: vi.fn(),
|
|
7
|
+
}));
|
|
8
|
+
|
|
9
|
+
vi.mock("dockerode", () => {
|
|
10
|
+
return {
|
|
11
|
+
default: vi.fn().mockImplementation(() => ({
|
|
12
|
+
getContainer: vi.fn().mockReturnValue({
|
|
13
|
+
exec: mockExec,
|
|
14
|
+
putArchive: mockPutArchive,
|
|
15
|
+
}),
|
|
16
|
+
})),
|
|
17
|
+
};
|
|
18
|
+
});
|
|
19
|
+
|
|
20
|
+
import { registerTransferTools } from "../src/tools/transfer.js";
|
|
21
|
+
import { createDockerClient } from "../src/docker.js";
|
|
22
|
+
|
|
23
|
+
function createMockServer() {
|
|
24
|
+
const tools: Record<string, { description: string; handler: Function }> = {};
|
|
25
|
+
return {
|
|
26
|
+
tool: (
|
|
27
|
+
name: string,
|
|
28
|
+
description: string,
|
|
29
|
+
_schemaOrAnnotations: unknown,
|
|
30
|
+
_annotationsOrHandler: unknown,
|
|
31
|
+
_maybeHandler?: Function
|
|
32
|
+
) => {
|
|
33
|
+
const handler =
|
|
34
|
+
typeof _annotationsOrHandler === "function"
|
|
35
|
+
? _annotationsOrHandler
|
|
36
|
+
: (_maybeHandler as Function);
|
|
37
|
+
tools[name] = { description, handler };
|
|
38
|
+
},
|
|
39
|
+
tools,
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
describe("Transfer Tools", () => {
|
|
44
|
+
let server: ReturnType<typeof createMockServer>;
|
|
45
|
+
let docker: ReturnType<typeof createDockerClient>;
|
|
46
|
+
|
|
47
|
+
beforeEach(() => {
|
|
48
|
+
vi.clearAllMocks();
|
|
49
|
+
server = createMockServer();
|
|
50
|
+
docker = createDockerClient();
|
|
51
|
+
registerTransferTools(server as any, docker);
|
|
52
|
+
});
|
|
53
|
+
|
|
54
|
+
describe("copy_from_container", () => {
|
|
55
|
+
it("calls exec with correct command", async () => {
|
|
56
|
+
// Mock exec to reject (error path tests the call chain)
|
|
57
|
+
mockExec.mockRejectedValue(new Error("No such container"));
|
|
58
|
+
|
|
59
|
+
const result = await server.tools["copy_from_container"].handler({
|
|
60
|
+
container_id: "test-container",
|
|
61
|
+
container_path: "/etc/hosts",
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
// Verify exec was called with the correct options
|
|
65
|
+
expect(mockExec).toHaveBeenCalledWith({
|
|
66
|
+
Cmd: ["cat", "/etc/hosts"],
|
|
67
|
+
AttachStdout: true,
|
|
68
|
+
AttachStderr: true,
|
|
69
|
+
});
|
|
70
|
+
expect(result.isError).toBe(true);
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
it("handles exec errors gracefully", async () => {
|
|
74
|
+
mockExec.mockRejectedValue(new Error("No such container"));
|
|
75
|
+
|
|
76
|
+
const result = await server.tools["copy_from_container"].handler({
|
|
77
|
+
container_id: "nonexistent",
|
|
78
|
+
container_path: "/etc/hosts",
|
|
79
|
+
});
|
|
80
|
+
|
|
81
|
+
expect(result.isError).toBe(true);
|
|
82
|
+
expect(result.content[0].text).toContain("Error");
|
|
83
|
+
expect(result.content[0].text).toContain("No such container");
|
|
84
|
+
});
|
|
85
|
+
|
|
86
|
+
it("tool is registered with correct metadata", () => {
|
|
87
|
+
const tool = server.tools["copy_from_container"];
|
|
88
|
+
expect(tool).toBeDefined();
|
|
89
|
+
expect(tool.description).toContain("Copy a file from a Docker container");
|
|
90
|
+
});
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
describe("copy_to_container", () => {
|
|
94
|
+
it("writes a file into container", async () => {
|
|
95
|
+
mockPutArchive.mockResolvedValue({});
|
|
96
|
+
|
|
97
|
+
const result = await server.tools["copy_to_container"].handler({
|
|
98
|
+
container_id: "abc123",
|
|
99
|
+
container_path: "/app/config.json",
|
|
100
|
+
content: '{"key": "value"}',
|
|
101
|
+
mode: 0o644,
|
|
102
|
+
});
|
|
103
|
+
|
|
104
|
+
const data = JSON.parse(result.content[0].text);
|
|
105
|
+
expect(data.success).toBe(true);
|
|
106
|
+
expect(data.path).toBe("/app/config.json");
|
|
107
|
+
expect(data.size).toBe(16); // '{"key": "value"}' = 16 bytes
|
|
108
|
+
expect(result.isError).toBeFalsy();
|
|
109
|
+
});
|
|
110
|
+
|
|
111
|
+
it("uses default mode 0o644 when not specified", async () => {
|
|
112
|
+
mockPutArchive.mockResolvedValue({});
|
|
113
|
+
|
|
114
|
+
const result = await server.tools["copy_to_container"].handler({
|
|
115
|
+
container_id: "abc123",
|
|
116
|
+
container_path: "/app/script.sh",
|
|
117
|
+
content: "#!/bin/bash\necho hello",
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
const data = JSON.parse(result.content[0].text);
|
|
121
|
+
expect(data.mode).toBe("0644");
|
|
122
|
+
});
|
|
123
|
+
|
|
124
|
+
it("calls putArchive with parent directory", async () => {
|
|
125
|
+
mockPutArchive.mockResolvedValue({});
|
|
126
|
+
|
|
127
|
+
await server.tools["copy_to_container"].handler({
|
|
128
|
+
container_id: "abc123",
|
|
129
|
+
container_path: "/app/config.json",
|
|
130
|
+
content: "data",
|
|
131
|
+
});
|
|
132
|
+
|
|
133
|
+
// putArchive should be called (stream, { path: "/app" })
|
|
134
|
+
expect(mockPutArchive).toHaveBeenCalled();
|
|
135
|
+
const callArgs = mockPutArchive.mock.calls[0];
|
|
136
|
+
expect(callArgs[1]).toEqual({ path: "/app" });
|
|
137
|
+
});
|
|
138
|
+
|
|
139
|
+
it("handles nested paths correctly", async () => {
|
|
140
|
+
mockPutArchive.mockResolvedValue({});
|
|
141
|
+
|
|
142
|
+
const result = await server.tools["copy_to_container"].handler({
|
|
143
|
+
container_id: "abc123",
|
|
144
|
+
container_path: "/etc/nginx/nginx.conf",
|
|
145
|
+
content: "worker_processes 1;",
|
|
146
|
+
});
|
|
147
|
+
|
|
148
|
+
const data = JSON.parse(result.content[0].text);
|
|
149
|
+
expect(data.success).toBe(true);
|
|
150
|
+
expect(data.path).toBe("/etc/nginx/nginx.conf");
|
|
151
|
+
|
|
152
|
+
// Parent dir should be /etc/nginx
|
|
153
|
+
const callArgs = mockPutArchive.mock.calls[0];
|
|
154
|
+
expect(callArgs[1]).toEqual({ path: "/etc/nginx" });
|
|
155
|
+
});
|
|
156
|
+
|
|
157
|
+
it("handles putArchive errors gracefully", async () => {
|
|
158
|
+
mockPutArchive.mockRejectedValue(new Error("Permission denied"));
|
|
159
|
+
|
|
160
|
+
const result = await server.tools["copy_to_container"].handler({
|
|
161
|
+
container_id: "abc123",
|
|
162
|
+
container_path: "/root/secret.txt",
|
|
163
|
+
content: "data",
|
|
164
|
+
});
|
|
165
|
+
|
|
166
|
+
expect(result.isError).toBe(true);
|
|
167
|
+
expect(result.content[0].text).toContain("Error");
|
|
168
|
+
});
|
|
169
|
+
|
|
170
|
+
it("tool is registered with correct metadata", () => {
|
|
171
|
+
const tool = server.tools["copy_to_container"];
|
|
172
|
+
expect(tool).toBeDefined();
|
|
173
|
+
expect(tool.description).toContain("Write file content into a Docker container");
|
|
174
|
+
});
|
|
175
|
+
});
|
|
176
|
+
});
|