Find RPC method names, Ruby argument signatures, and authentication requirements.

Defaults to a bundled reference catalog pinned to an upstream commit. Pass the installed Framework root to scan its source instead. This is source discovery, not a live capability probe; plugins and versions can differ. The catalog never restricts msf_rpc calls to unlisted methods.

Authenticate and get Metasploit and API version information.

Call ANY Metasploit RPC method with positional arguments, excluding its auth token.

Examples: core.version []; module.info ["auxiliary", "module/name"]; job.list []; session.list []; db.workspaces []; plugin.loaded []. Methods and arguments depend on your installed Metasploit version. authenticated=null detects auth.login and health.check as unauthenticated; false omits the token for other noauth endpoints. timeout overrides the per-request HTTP timeout in seconds, without retrying a failed action. For binary arguments use an exact {"$binary": "base64..."} object. For typed map keys or literal marker objects use {"$map": [[key, value], ...]}. Non-string map keys in results are preserved using the same pair-list form. This can mutate state, execute modules, manage sessions, or stop the daemon. Use console tools for functionality without an RPC method.

Search Metasploit modules using its search syntax (e.g. type:auxiliary name:http).

Return module metadata. Use msf_rpc module.options for its option schema.

Execute an installed module with its datastore options; returns job/UUID or output.

Inspect module.info and module.options first. Execution may continue after this tool returns. Poll job.list, module.running_stats, or module.results using msf_rpc. Binary output is represented as a $binary base64 object.

List running jobs. Use msf_rpc job.info or job.stop with a job ID.

List sessions; use msf_rpc session.* methods to interact with them.

Create a persistent msfconsole and return its ID; destroy it when finished.

List consoles and their busy state.

Send arbitrary console commands, including multiline scripts.

The console retains state (selected module, options, workspace). This tool only submits input; read output separately. A newline is appended by default.

Consume available console output; returns data, prompt, and busy status.

Reads drain the console's output buffer. busy=false is a snapshot, not proof that a just-submitted command has completed or that a job has ended.

Destroy a console by ID. This does not stop its background jobs/sessions.

Start a local executable with literal argv, without a shell.

Use ["msfconsole", "-q"] with terminal=true for a real interactive PTY, including IRB, prompts, and terminal input. Use ["msfvenom", "--help"] with terminal=false for exact binary output and separate stderr. Other installed Framework utilities and interpreters can be run the same way. These processes do not share the RPC daemon's in-memory sessions or jobs. Returns immediately with process_id. Read output, write input, signal, resize, and close using the process tools. cwd and env are optional.

Read lossless spooled output at a byte offset, without consuming it.

data is base64 bytes; text is a display-only UTF-8 decoding. Use next_offset to continue reading. Pipe mode separates stdout/stderr; PTY merges them into stdout. eof means the process exited and this stream has been read. A process timeout/cancellation never implicitly replays or stops it.

Write text or {$binary: base64} to stdin, without adding a newline.

For commands include a newline explicitly. Control characters can be sent directly in PTY mode (e.g.  for Ctrl-C,  for EOF). In pipe mode, close_stdin=true sends EOF after data. PTY stdin cannot be closed separately.

Signal the process group: interrupt, terminate, kill, stop, or continue.

Accepts named POSIX signals, including SIGINT, SIGTERM, SIGKILL, SIGSTOP, SIGCONT, SIGHUP, SIGUSR1, SIGUSR2, and SIGWINCH. SIGINT interrupts native console/IRB work. It may exit a standalone tool.

Resize a persistent PTY and notify its foreground terminal program.

List processes owned by this bridge and their exit status.

Stop this process and owned descendants, release its PTY, and delete output.

Detached descendants are tracked by ancestry and an inherited ownership marker. Retrieve output first. Owned processes are also stopped when the MCP server shuts down. This does not stop an external RPC daemon.

Read a local file as lossless base64 chunks; continue using next_offset.

Use for generated binaries, loot, reports, resource scripts, or modules. This accesses the MCP host's filesystem with its OS permissions.

Write text or {$binary: base64} at a local file byte offset.

Creates missing parent directories and files. truncate=true clears an existing file first; use only on the first chunk when replacing a file. Supports arbitrary-sized resource scripts, modules, and import artifacts by writing successive chunks at next_offset. Paths are local to the MCP host.

List a local directory with pagination to locate scripts and output artifacts.