mirror of
https://github.com/binaricat/Netcatty.git
synced 2026-11-20 23:20:46 +00:00
* Run agent commands in a subshell so failures cannot close the session
Agent-generated commands were eval'd directly in the user's active login
shell, so a generated script containing `set -e` (or `exit`) terminated
the whole SSH session on the first failure. Wrap the eval in a subshell
unconditionally instead of trying to detect dangerous commands — the
detection approaches from PRs #1852/#1882 grew into shell parsing and
were abandoned. Output stays live in the user's terminal; the trade-off
is that cd/export no longer persist between calls, which the tool
descriptions now tell the model about.
Also fix multi-line command display: synthetic echo now normalizes line
breaks to CRLF (no more staircase indentation in xterm), and the POSIX
wrapper rebuilds newlines via printf so the typed command stays on one
physical line and PS2 continuation echoes ("> ...") no longer leak past
the marker filter.
Fixes #1850
Co-authored-by: Cursor <cursoragent@cursor.com>
* Move shellUtils require to module scope in cattyExecHandlers
The inline require("./ai/shellUtils.cjs") inside the with(ctx) block did
resolve correctly at runtime (bare `require` hits ctx.require, based in
electron/bridges/), but the path only works through that indirection and
reads as wrong relative to this file. Require at module scope with the
unambiguous ../ai path instead.
Co-authored-by: Cursor <cursoragent@cursor.com>
---------
Co-authored-by: Cursor <cursoragent@cursor.com>
323 lines
18 KiB
JavaScript
323 lines
18 KiB
JavaScript
"use strict";
|
|
|
|
/**
|
|
* Input field definitions keyed by capability id.
|
|
* Single source for MCP, Catty, and CLI tool schemas.
|
|
*/
|
|
const TOOL_INPUT_FIELDS = Object.freeze({
|
|
"terminal.execute": {
|
|
sessionId: { type: "string", description: "The terminal session ID to execute on." },
|
|
command: { type: "string", description: "The shell command to execute in the target session." },
|
|
},
|
|
"terminal.start": {
|
|
sessionId: { type: "string", description: "The terminal session ID to start a long-running command on." },
|
|
command: { type: "string", description: "The command to start in the target session." },
|
|
},
|
|
"terminal.poll": {
|
|
jobId: { type: "string", description: "The background job ID returned by terminal_start." },
|
|
offset: { type: "number", optional: true, description: "Character offset from a previous poll (default 0)." },
|
|
},
|
|
"terminal.stop": {
|
|
jobId: { type: "string", description: "The background job ID returned by terminal_start." },
|
|
},
|
|
"session.environment": {},
|
|
"attachment.list": {},
|
|
"attachment.read": {
|
|
filePath: { type: "string", optional: true, description: "Exact local attachment path." },
|
|
filename: { type: "string", optional: true, description: "Attachment filename from list_attachments." },
|
|
},
|
|
"sftp.list": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote directory path." },
|
|
},
|
|
"sftp.read": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote file path to read." },
|
|
},
|
|
"sftp.stat": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote path to stat." },
|
|
},
|
|
"sftp.home": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
},
|
|
"sftp.write": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote file path to write." },
|
|
content: { type: "string", description: "File content to write." },
|
|
},
|
|
"sftp.download": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
remotePath: { type: "string", description: "Remote file path to download." },
|
|
localPath: { type: "string", description: "Local destination path." },
|
|
},
|
|
"sftp.upload": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
localPath: { type: "string", description: "Local file path to upload." },
|
|
remotePath: { type: "string", description: "Remote destination path." },
|
|
},
|
|
"sftp.mkdir": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote directory path to create." },
|
|
},
|
|
"sftp.delete": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote file or directory path to delete." },
|
|
},
|
|
"sftp.rename": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
oldPath: { type: "string", description: "Current remote path." },
|
|
newPath: { type: "string", description: "New remote path." },
|
|
},
|
|
"sftp.chmod": {
|
|
sessionId: { type: "string", description: "SFTP session ID." },
|
|
path: { type: "string", description: "Remote file path." },
|
|
mode: { type: "string", description: "Octal permission mode (e.g. 755)." },
|
|
},
|
|
"vault.host.get": {
|
|
hostId: { type: "string", description: "Vault host ID." },
|
|
},
|
|
"vault.host.list": {},
|
|
"vault.hosts.create": {
|
|
hosts: {
|
|
type: "string",
|
|
description:
|
|
"JSON array of host objects you extracted from the user's text. Each object: hostname (required), label, port, username, password, group, tags (array or comma-separated string), notes (Host Details remarks — NOT Vault sidebar Notes), protocol (ssh|telnet|local).",
|
|
},
|
|
dryRun: {
|
|
type: "string",
|
|
optional: true,
|
|
description: "Set to true to validate and preview without writing to the vault.",
|
|
},
|
|
skipDuplicates: {
|
|
type: "string",
|
|
optional: true,
|
|
description: "Set to false to create even when a matching host already exists (default true).",
|
|
},
|
|
},
|
|
"vault.host.import": {
|
|
format: {
|
|
type: "string",
|
|
description: "Import format: csv, putty, mobaxterm, securecrt, ssh_config, or auto to detect from text.",
|
|
},
|
|
text: { type: "string", description: "Exported host data text to import." },
|
|
dryRun: {
|
|
type: "string",
|
|
optional: true,
|
|
description: "Set to true to parse and preview without writing to the vault.",
|
|
},
|
|
skipDuplicates: {
|
|
type: "string",
|
|
optional: true,
|
|
description: "Set to false to import even when a matching host already exists (default true).",
|
|
},
|
|
fileName: {
|
|
type: "string",
|
|
optional: true,
|
|
description: "Optional source file name (helps SecureCRT .ini parsing).",
|
|
},
|
|
},
|
|
"vault.host.notes.get": {
|
|
hostId: { type: "string", description: "Vault host ID." },
|
|
},
|
|
"vault.host.notes.set": {
|
|
hostId: { type: "string", description: "Vault host ID." },
|
|
notes: { type: "string", description: "Host metadata notes (Host Details — not Vault sidebar Notes)." },
|
|
},
|
|
"vault.note.list": {},
|
|
"vault.note.get": {
|
|
noteId: { type: "string", description: "Vault note ID from vault_notes_list." },
|
|
},
|
|
"vault.note.create": {
|
|
title: { type: "string", description: "Note title shown in Vault → Notes." },
|
|
content: { type: "string", description: "Markdown note body." },
|
|
group: { type: "string", optional: true, description: "Optional folder path (e.g. infra/prod)." },
|
|
linkedHostIds: { type: "string", optional: true, description: "Optional JSON array of vault host IDs to link." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
},
|
|
"vault.note.update": {
|
|
noteId: { type: "string", description: "Vault note ID to update." },
|
|
title: { type: "string", optional: true, description: "New title." },
|
|
content: { type: "string", optional: true, description: "New markdown body." },
|
|
group: { type: "string", optional: true, description: "New folder path." },
|
|
linkedHostIds: { type: "string", optional: true, description: "Optional JSON array of vault host IDs to link." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
},
|
|
"vault.snippets.list": {},
|
|
"vault.snippets.get": {
|
|
snippetId: { type: "string", description: "Snippet ID." },
|
|
},
|
|
"vault.snippets.run": {
|
|
snippetId: { type: "string", description: "Snippet ID to run." },
|
|
sessionId: { type: "string", description: "Terminal session ID to execute on." },
|
|
variables: { type: "string", optional: true, description: "JSON object of snippet variable values." },
|
|
wait: { type: "string", optional: true, description: "Set to true to wait for script completion when kind=script." },
|
|
},
|
|
"vault.snippets.create": {
|
|
label: { type: "string", description: "Snippet or script label." },
|
|
content: { type: "string", description: "Snippet command text or script JavaScript source." },
|
|
kind: { type: "string", optional: true, description: "snippet (default) or script for nct automation." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
targets: { type: "string", optional: true, description: "Optional JSON array of vault host IDs." },
|
|
targetsAllHosts: { type: "string", optional: true, description: "Set true to target all connectable hosts." },
|
|
package: { type: "string", optional: true, description: "Optional vault package path." },
|
|
shortkey: { type: "string", optional: true, description: "Optional keyboard shortcut." },
|
|
noAutoRun: { type: "string", optional: true, description: "For text snippets: paste without pressing Enter." },
|
|
multiLineRunMode: { type: "string", optional: true, description: "For multi-line text snippets: paste (default) or lineDelay." },
|
|
language: { type: "string", optional: true, description: "javascript or python (UI label only; runtime is JS)." },
|
|
description: { type: "string", optional: true, description: "Optional script description." },
|
|
trigger: { type: "string", optional: true, description: "manual, onConnect, or onOutput (scripts)." },
|
|
triggerPattern: { type: "string", optional: true, description: "Regex when trigger=onOutput." },
|
|
},
|
|
"vault.snippets.update": {
|
|
snippetId: { type: "string", description: "Snippet ID to update." },
|
|
label: { type: "string", optional: true, description: "New label." },
|
|
content: { type: "string", optional: true, description: "New command or script source." },
|
|
kind: { type: "string", optional: true, description: "snippet or script." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
targets: { type: "string", optional: true, description: "Optional JSON array of vault host IDs." },
|
|
targetsAllHosts: { type: "string", optional: true, description: "Set true to target all connectable hosts." },
|
|
package: { type: "string", optional: true, description: "Optional vault package path." },
|
|
shortkey: { type: "string", optional: true, description: "Optional keyboard shortcut." },
|
|
noAutoRun: { type: "string", optional: true, description: "For text snippets: paste without pressing Enter." },
|
|
multiLineRunMode: { type: "string", optional: true, description: "For multi-line text snippets: paste (default) or lineDelay." },
|
|
language: { type: "string", optional: true, description: "javascript or python." },
|
|
description: { type: "string", optional: true, description: "Optional script description." },
|
|
trigger: { type: "string", optional: true, description: "manual, onConnect, or onOutput." },
|
|
triggerPattern: { type: "string", optional: true, description: "Regex when trigger=onOutput." },
|
|
},
|
|
"vault.snippets.delete": {
|
|
snippetId: { type: "string", description: "Snippet ID to delete." },
|
|
},
|
|
"vault.scripts.list": {},
|
|
"vault.scripts.get": {
|
|
scriptId: { type: "string", description: "Automation script ID." },
|
|
},
|
|
"vault.scripts.create": {
|
|
label: { type: "string", description: "Script label." },
|
|
content: { type: "string", description: "JavaScript automation source using nct.* API." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
targets: { type: "string", optional: true, description: "Optional JSON array of vault host IDs." },
|
|
targetsAllHosts: { type: "string", optional: true, description: "Set true to target all connectable hosts." },
|
|
package: { type: "string", optional: true, description: "Optional vault package path." },
|
|
description: { type: "string", optional: true, description: "Optional script description." },
|
|
trigger: { type: "string", optional: true, description: "manual (default), onConnect, or onOutput." },
|
|
triggerPattern: { type: "string", optional: true, description: "Regex when trigger=onOutput." },
|
|
},
|
|
"vault.scripts.update": {
|
|
scriptId: { type: "string", description: "Script ID to update." },
|
|
label: { type: "string", optional: true, description: "New label." },
|
|
content: { type: "string", optional: true, description: "New JavaScript source." },
|
|
tags: { type: "string", optional: true, description: "Optional JSON array of tag strings." },
|
|
targets: { type: "string", optional: true, description: "Optional JSON array of vault host IDs." },
|
|
targetsAllHosts: { type: "string", optional: true, description: "Set true to target all connectable hosts." },
|
|
package: { type: "string", optional: true, description: "Optional vault package path." },
|
|
description: { type: "string", optional: true, description: "Optional script description." },
|
|
trigger: { type: "string", optional: true, description: "manual, onConnect, or onOutput." },
|
|
triggerPattern: { type: "string", optional: true, description: "Regex when trigger=onOutput." },
|
|
},
|
|
"vault.scripts.delete": {
|
|
scriptId: { type: "string", description: "Script ID to delete." },
|
|
},
|
|
"vault.scripts.run": {
|
|
scriptId: { type: "string", description: "Script ID to run." },
|
|
sessionId: { type: "string", description: "Terminal session ID." },
|
|
wait: { type: "string", optional: true, description: "Set to true to block until the script completes." },
|
|
},
|
|
"vault.scripts.reference": {},
|
|
"vault.scripts.runs.list": {
|
|
sessionId: { type: "string", optional: true, description: "Optional terminal session ID filter." },
|
|
},
|
|
"vault.scripts.run.stop": {
|
|
runId: { type: "string", description: "Script run ID from scripts_run or scripts_runs_list." },
|
|
},
|
|
"vault.scripts.run.pause": {
|
|
runId: { type: "string", description: "Script run ID to pause." },
|
|
},
|
|
"vault.scripts.run.resume": {
|
|
runId: { type: "string", description: "Script run ID to resume." },
|
|
},
|
|
"vault.scripts.targets.set": {
|
|
scriptId: { type: "string", description: "Script ID." },
|
|
targets: { type: "string", optional: true, description: "JSON array of vault host IDs (omit when targetsAllHosts=true)." },
|
|
targetsAllHosts: { type: "string", optional: true, description: "Set true to target all connectable hosts." },
|
|
},
|
|
"vault.host.connectScripts.list": {
|
|
hostId: { type: "string", description: "Vault host ID." },
|
|
},
|
|
"vault.host.connectScripts.set": {
|
|
hostId: { type: "string", description: "Vault host ID." },
|
|
scriptIds: { type: "string", description: "JSON array of onConnect script IDs in run order." },
|
|
},
|
|
"portforward.rules.list": {},
|
|
"portforward.tunnels.list": {},
|
|
"portforward.start": {
|
|
ruleId: { type: "string", description: "Port forwarding rule ID." },
|
|
},
|
|
"portforward.stop": {
|
|
ruleId: { type: "string", description: "Port forwarding rule ID." },
|
|
},
|
|
"harness.tool_output.read": {
|
|
handleId: { type: "string", description: "Tool output handle id from a prior truncated result." },
|
|
mode: { type: "string", optional: true, description: "Which portion to read: head, tail, or full." },
|
|
maxChars: { type: "number", optional: true, description: "Maximum characters to return." },
|
|
},
|
|
"harness.workspace.get_info": {},
|
|
"harness.workspace.get_session_info": {
|
|
sessionId: { type: "string", description: "The session ID to get information about." },
|
|
},
|
|
"harness.terminal.read_context": {
|
|
sessionId: { type: "string", optional: true, description: "Terminal session ID. Required when the current AI scope contains more than one terminal." },
|
|
range: { type: "string", optional: true, description: "Which terminal slice to read: viewport, tail, head, or lines. Defaults to viewport." },
|
|
startLine: { type: "number", optional: true, description: "Zero-based terminal buffer line to start from when range is lines." },
|
|
maxLines: { type: "number", optional: true, description: "Maximum terminal rows to return. Defaults to 80, capped at 300." },
|
|
},
|
|
"harness.web.search": {
|
|
query: { type: "string", description: "The search query to look up on the web." },
|
|
maxResults: { type: "number", optional: true, description: "Maximum number of search results to return." },
|
|
},
|
|
"harness.url.fetch": {
|
|
url: { type: "string", description: "The HTTPS URL to fetch." },
|
|
maxLength: { type: "number", optional: true, description: "Maximum characters to return (default 50000)." },
|
|
},
|
|
});
|
|
|
|
/** Long-form model guidance appended to terminal tool descriptions from catalog. */
|
|
const MODEL_DESCRIPTION_HINTS = Object.freeze({
|
|
"terminal.execute":
|
|
"Use only for commands expected to finish within about 60 seconds. For long-running commands use terminal_start and terminal_poll. Commands run in an isolated subshell of the visible terminal: the user sees the output live, but shell state such as cd, export, or set does not persist between calls — use absolute paths or combine cd with the command (cd /path && cmd).",
|
|
"terminal.start":
|
|
"Prefer for builds, scans, log-following, or anything likely to exceed about 2 minutes. Shell state such as cd or export does not persist between calls — combine cd with the command.",
|
|
"terminal.poll":
|
|
"Wait at least about 30 seconds between polls unless output justifies checking sooner.",
|
|
"vault.host.notes.get":
|
|
"Host metadata notes on a saved host — not Vault → Notes sidebar entries.",
|
|
"vault.host.notes.set":
|
|
"Host metadata notes on a saved host — not Vault → Notes sidebar entries. Prefer vault_notes_create/update when the user wants vault notes they can open in the Notes sidebar.",
|
|
"vault.host.import":
|
|
"Only for text in known export formats (PuTTY reg, MobaXterm ini, CSV template, SecureCRT, ssh_config). If attached host text is unknown or auto-detection fails, use read_attachment content, extract fields yourself, and call vault_hosts_create.",
|
|
"vault.hosts.create":
|
|
"Use when the user wants to add/create a host in Vault → Hosts (创建主机、SSH 连接凭据). NOT for Vault → Notes sidebar docs. Put SSH password in password field; long remarks/admin tables in host notes field. Never fall back to vault_notes_create if this fails.",
|
|
"vault.note.create":
|
|
"Use ONLY when the user wants markdown documentation in Vault → Notes sidebar (保险箱笔记). Do NOT use when the user asked to create/add a host — use vault_hosts_create instead.",
|
|
"vault.note.update":
|
|
"Update an existing Vault → Notes entry (visible in the vault notes sidebar).",
|
|
"vault.snippets.run":
|
|
"Text snippets (kind=snippet) paste shell commands with optional {{variables}}. Scripts (kind=script) run via nct JavaScript runtime — use scripts_run for script-only workflows.",
|
|
"vault.snippets.create":
|
|
"Create vault snippets (shell text) or scripts (kind=script, nct JavaScript). For multi-step terminal automation use kind=script and call scripts_reference.",
|
|
"vault.scripts.run":
|
|
"Runs automation scripts in the nct JavaScript sandbox. Use wait=true to block until completion. Prefer over terminal_execute for await nct.screen.* workflows.",
|
|
"vault.scripts.create":
|
|
"Create nct automation scripts. Call scripts_reference first to learn the nct API, triggers, and source wrapping rules.",
|
|
"vault.scripts.reference":
|
|
"Returns full Netcatty automation script syntax reference (nct API, triggers, host targeting). Read before authoring scripts.",
|
|
"vault.host.connectScripts.set":
|
|
"Sets per-host onConnect script queue order. Global targetsAllHosts scripts run first automatically.",
|
|
});
|
|
|
|
module.exports = {
|
|
TOOL_INPUT_FIELDS,
|
|
MODEL_DESCRIPTION_HINTS,
|
|
};
|