@tcb-sandbox/cli 0.3.7

package/dist/bundled-docs.d.ts

@@ -0,0 +1,769 @@
+export declare const BUNDLED_API_DOCS: {
+    readonly service: "remote-workspace";
+    readonly protocol: "HTTP REST";
+    readonly auth: {
+        readonly required_header: "X-Cloudbase-Session-Id";
+    };
+    readonly endpoints: {
+        readonly health: "GET /health";
+        readonly docs: "GET /api/docs";
+        readonly tools: "POST /api/tools/{tool}";
+    };
+    readonly tools: readonly [{
+        readonly name: "read";
+        readonly description: "Read file contents (line-numbered). Also lists directory contents.";
+        readonly endpoint: "POST /api/tools/read";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["path"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly offset: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+                readonly limit: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+            };
+        };
+        readonly limits: {
+            readonly default_limit: 2000;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "write";
+        readonly description: "Create or overwrite a file atomically. Returns a unified diff of changes.";
+        readonly endpoint: "POST /api/tools/write";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["path", "content"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly content: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "edit";
+        readonly description: "Replace a specific string in a file with fuzzy matching fallbacks.";
+        readonly endpoint: "POST /api/tools/edit";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["path", "oldString", "newString"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly oldString: {
+                    readonly type: "string";
+                };
+                readonly newString: {
+                    readonly type: "string";
+                };
+                readonly replaceAll: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "add_mcp_servers";
+        readonly description: "Merge stdio MCP servers into session .mcporter/mcporter.json (idempotent by name). Returns available_mcp_servers.";
+        readonly endpoint: "POST /api/tools/add_mcp_servers";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly additionalProperties: true;
+            readonly properties: {
+                readonly mcpServers: {
+                    readonly oneOf: readonly [{
+                        readonly type: "object";
+                        readonly additionalProperties: true;
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly serverName: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly server: {
+                    readonly type: "string";
+                };
+                readonly command: {
+                    readonly type: "string";
+                };
+                readonly args: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly env: {
+                    readonly type: "object";
+                };
+                readonly capabilityIds: {
+                    readonly type: "object";
+                    readonly additionalProperties: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "remove_mcp_servers";
+        readonly description: "Remove MCP server(s) from session mcporter by name(s); returns updated available_mcp_servers (pairs with add_mcp_servers).";
+        readonly endpoint: "POST /api/tools/remove_mcp_servers";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly additionalProperties: false;
+            readonly properties: {
+                readonly serverNames: {
+                    readonly oneOf: readonly [{
+                        readonly type: "array";
+                        readonly items: {
+                            readonly type: "string";
+                        };
+                    }, {
+                        readonly type: "string";
+                    }];
+                };
+                readonly serverName: {
+                    readonly type: "string";
+                };
+                readonly name: {
+                    readonly type: "string";
+                };
+                readonly server: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "bash";
+        readonly description: "Execute a shell command in the workspace (default execute, explicit dry_run supported with riskSummary/decision/changeSet).";
+        readonly endpoint: "POST /api/tools/bash";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["command"];
+            readonly properties: {
+                readonly command: {
+                    readonly type: "string";
+                };
+                readonly timeout: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+                readonly mode: {
+                    readonly type: "string";
+                    readonly enum: readonly ["execute", "dry_run"];
+                };
+            };
+        };
+        readonly limits: {
+            readonly timeout_default_ms: 300000;
+            readonly timeout_max_ms: 600000;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "grep";
+        readonly description: "Search file contents by regex pattern. Returns matching lines with paths.";
+        readonly endpoint: "POST /api/tools/grep";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pattern"];
+            readonly properties: {
+                readonly pattern: {
+                    readonly type: "string";
+                };
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly include: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {
+            readonly result_limit: 100;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "glob";
+        readonly description: "Find files by glob pattern (e.g. '**/*.ts').";
+        readonly endpoint: "POST /api/tools/glob";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pattern"];
+            readonly properties: {
+                readonly pattern: {
+                    readonly type: "string";
+                };
+                readonly path: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {
+            readonly result_limit: 100;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "list_mcp_servers";
+        readonly description: "List MCP server names from session mcporter config (available_mcp_servers). Read-only.";
+        readonly endpoint: "POST /api/tools/list_mcp_servers";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {};
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "mcporter_cli";
+        readonly description: string;
+        readonly endpoint: "POST /api/tools/mcporter_cli";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["command"];
+            readonly properties: {
+                readonly command: {
+                    readonly type: "string";
+                    readonly description: "Mcporter subcommand (without 'mcporter' prefix)";
+                };
+                readonly timeout: {
+                    readonly type: "integer";
+                    readonly description: "Timeout in ms (default 300000)";
+                };
+            };
+        };
+        readonly limits: {
+            readonly default_timeout_ms: 300000;
+            readonly allowed_subcommands: readonly ["help", "list", "call", "config"];
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "ls";
+        readonly description: "List directory tree with common noise dirs excluded.";
+        readonly endpoint: "POST /api/tools/ls";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly ignore: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+            };
+        };
+        readonly limits: {
+            readonly result_limit: 100;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "pty_create";
+        readonly description: "Create a session-scoped PTY process.";
+        readonly endpoint: "POST /api/tools/pty_create";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly cmd: {
+                    readonly type: "string";
+                };
+                readonly args: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly cwd: {
+                    readonly type: "string";
+                };
+                readonly envs: {
+                    readonly type: "object";
+                };
+                readonly cols: {
+                    readonly type: "integer";
+                };
+                readonly rows: {
+                    readonly type: "integer";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "pty_send_input";
+        readonly description: "Send base64 input bytes to PTY by pid.";
+        readonly endpoint: "POST /api/tools/pty_send_input";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pid", "inputBase64"];
+            readonly properties: {
+                readonly pid: {
+                    readonly type: "integer";
+                };
+                readonly inputBase64: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "pty_resize";
+        readonly description: "Resize PTY by pid.";
+        readonly endpoint: "POST /api/tools/pty_resize";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pid", "cols", "rows"];
+            readonly properties: {
+                readonly pid: {
+                    readonly type: "integer";
+                };
+                readonly cols: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+                readonly rows: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "pty_read_output";
+        readonly description: "Read buffered PTY output events by pid.";
+        readonly endpoint: "POST /api/tools/pty_read_output";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pid"];
+            readonly properties: {
+                readonly pid: {
+                    readonly type: "integer";
+                };
+                readonly afterSeq: {
+                    readonly type: "integer";
+                    readonly minimum: 0;
+                };
+                readonly limit: {
+                    readonly type: "integer";
+                    readonly minimum: 1;
+                };
+            };
+        };
+        readonly limits: {
+            readonly default_limit: 128;
+            readonly max_limit: 512;
+            readonly buffer_size_events: 512;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "pty_kill";
+        readonly description: "Kill PTY by pid.";
+        readonly endpoint: "POST /api/tools/pty_kill";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["pid"];
+            readonly properties: {
+                readonly pid: {
+                    readonly type: "integer";
+                };
+                readonly signal: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "secrets_set";
+        readonly description: "Set or overwrite a session secret.";
+        readonly endpoint: "POST /api/tools/secrets_set";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["key", "value"];
+            readonly properties: {
+                readonly key: {
+                    readonly type: "string";
+                };
+                readonly value: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "secrets_get";
+        readonly description: "Get plaintext session secret.";
+        readonly endpoint: "POST /api/tools/secrets_get";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["key"];
+            readonly properties: {
+                readonly key: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "secrets_list";
+        readonly description: "List session secret keys.";
+        readonly endpoint: "POST /api/tools/secrets_list";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {};
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "secrets_delete";
+        readonly description: "Delete a session secret.";
+        readonly endpoint: "POST /api/tools/secrets_delete";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["key"];
+            readonly properties: {
+                readonly key: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "preview_ports";
+        readonly description: "List previewable ports for session.";
+        readonly endpoint: "POST /api/tools/preview_ports";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly endpoint: {
+                    readonly type: "string";
+                };
+                readonly includeSessionQuery: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "preview_url";
+        readonly description: "Build preview URL for a port.";
+        readonly endpoint: "POST /api/tools/preview_url";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["port"];
+            readonly properties: {
+                readonly port: {
+                    readonly type: "integer";
+                };
+                readonly endpoint: {
+                    readonly type: "string";
+                };
+                readonly includeSessionQuery: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "files_upload";
+        readonly description: "Upload file bytes as base64 payload.";
+        readonly endpoint: "POST /api/tools/files_upload";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["path", "contentBase64"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+                readonly contentBase64: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {
+            readonly max_bytes_per_transfer: number;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "files_download";
+        readonly description: "Download file bytes as base64 payload.";
+        readonly endpoint: "POST /api/tools/files_download";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["path"];
+            readonly properties: {
+                readonly path: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {
+            readonly max_bytes_per_transfer: number;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "batch";
+        readonly description: "Execute multiple tool calls in parallel chunks.";
+        readonly endpoint: "POST /api/tools/batch";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["tool_calls"];
+            readonly properties: {
+                readonly tool_calls: {
+                    readonly type: "array";
+                };
+            };
+        };
+        readonly limits: {
+            readonly max_tool_calls: 25;
+            readonly max_parallel_per_chunk: 5;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_list";
+        readonly description: "List available capabilities (built-in + registered).";
+        readonly endpoint: "POST /api/tools/capability_list";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly includeBuiltins: {
+                    readonly type: "boolean";
+                };
+                readonly revealPaths: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_install";
+        readonly description: "Return install guidance only. Caller executes installation/configuration and then registers metadata.";
+        readonly endpoint: "POST /api/tools/capability_install";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["id"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["cli", "mcp", "skill"];
+                };
+                readonly package: {
+                    readonly type: "string";
+                };
+                readonly version: {
+                    readonly type: "string";
+                };
+                readonly bin: {
+                    readonly type: "string";
+                };
+                readonly serverName: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_register";
+        readonly description: "Register externally prepared capability runtime metadata.";
+        readonly endpoint: "POST /api/tools/capability_register";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["id", "kind"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly kind: {
+                    readonly type: "string";
+                    readonly enum: readonly ["cli", "mcp", "skill"];
+                };
+                readonly source: {
+                    readonly type: "string";
+                    readonly enum: readonly ["managed", "external"];
+                };
+                readonly description: {
+                    readonly type: "string";
+                };
+                readonly command: {
+                    readonly type: "string";
+                };
+                readonly args: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly env: {
+                    readonly type: "object";
+                };
+                readonly serverName: {
+                    readonly type: "string";
+                };
+                readonly packagePath: {
+                    readonly type: "string";
+                };
+                readonly entryFile: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_remove";
+        readonly description: "Remove a registered capability.";
+        readonly endpoint: "POST /api/tools/capability_remove";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["id"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_describe";
+        readonly description: "Describe capability actions and schemas.";
+        readonly endpoint: "POST /api/tools/capability_describe";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["id"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly revealPaths: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "capability_invoke";
+        readonly description: "Invoke capability action only for capabilities that execute directly in capability layer.";
+        readonly endpoint: "POST /api/tools/capability_invoke";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["id", "action"];
+            readonly properties: {
+                readonly id: {
+                    readonly type: "string";
+                };
+                readonly action: {
+                    readonly type: "string";
+                };
+                readonly parameters: {
+                    readonly type: "object";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Only native data-plane capabilities execute here (for example secrets-store/files-transfer/preview-service/pty-service/git-archive)."];
+    }, {
+        readonly name: "git_push";
+        readonly description: "Commit all workspace changes and push to archive repository.";
+        readonly endpoint: "POST /api/tools/git_push";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly message: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "workspace_snapshot";
+        readonly description: "Create async workspace snapshot uploaded to S3. Returns snapshot_id immediately.";
+        readonly endpoint: "POST /api/tools/workspace_snapshot";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly exclude: {
+                    readonly type: "array";
+                    readonly items: {
+                        readonly type: "string";
+                    };
+                };
+                readonly include_all: {
+                    readonly type: "boolean";
+                };
+            };
+        };
+        readonly limits: {
+            readonly max_concurrent: 2;
+        };
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "workspace_snapshot_status";
+        readonly description: "Check snapshot task status by snapshot_id or list all session tasks.";
+        readonly endpoint: "POST /api/tools/workspace_snapshot_status";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly properties: {
+                readonly snapshot_id: {
+                    readonly type: "string";
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }, {
+        readonly name: "workspace_restore";
+        readonly description: "Restore workspace from snapshot. mode=\"merge\" overlays, mode=\"replace\" cleans first.";
+        readonly endpoint: "POST /api/tools/workspace_restore";
+        readonly input_schema: {
+            readonly type: "object";
+            readonly required: readonly ["snapshot_id"];
+            readonly properties: {
+                readonly snapshot_id: {
+                    readonly type: "string";
+                };
+                readonly mode: {
+                    readonly type: "string";
+                    readonly enum: readonly ["merge", "replace"];
+                };
+            };
+        };
+        readonly limits: {};
+        readonly notes: readonly ["Bundled fallback docs snapshot."];
+    }];
+};