API Reference

This page lists the MCP tools and resources currently exposed by Maverick SSH MCP.

Tool Areas

Tool	Purpose
`ssh_connect`	Open an SSH connection and return an `sshHandle`.
`ssh_status`	Get status and metadata for one `sshHandle`.
`ssh_close`	Close an `sshHandle`.

Tool	Purpose
`shell_open`	Open an interactive shell or run a remote command on an SSH handle.
`shell_write`	Write input to a shell handle.
`shell_read`	Read stdout and stderr currently available on a shell handle.
`shell_close`	Close a shell handle.

Tool	Purpose
`socket_open`	Open an outbound local TCP socket and return a `socketHandle`.
`socket_status`	Get status and metadata for one `socketHandle`.
`socket_set_options`	Update socket options on an existing `socketHandle`.
`socket_write`	Write bytes to an open socket handle.
`socket_read`	Read bytes from an open socket handle.
`socket_close`	Close a socket handle.
`socket_listen_open`	Open a listening socket and return a `socketListenerHandle`.
`socket_listen_accept`	Accept one incoming connection and return a `socketHandle`.
`socket_listen_close`	Close a listening socket handle.

Tool	Purpose
`sftp_open`	Open an SFTP client and return an `sftpHandle`.
`sftp_close`	Close an `sftpHandle`.
`sftp_pwd`	Get current remote working directory.
`sftp_cd`	Change remote working directory.
`sftp_ls`	List files in a directory.
`sftp_stat`	Read remote file or directory attributes.
`sftp_mkdir`	Create a remote directory.
`sftp_rmdir`	Remove a remote directory.
`sftp_rm`	Remove a remote file or directory tree.
`sftp_rename`	Rename a remote file or directory.
`sftp_symlink`	Create a symbolic link.
`sftp_chmod`	Change file or directory permissions.
`sftp_chown`	Change file or directory owner and group.
`sftp_file_open`	Open a remote file for random access and return an `sftpFileHandle`.
`sftp_file_read`	Read bytes at a specific offset from an open file handle.
`sftp_file_write`	Write bytes at a specific offset to an open file handle.
`sftp_file_close`	Close an `sftpFileHandle`.

Tool	Purpose
`scp_copy_to`	Upload files or directories to the remote host.
`scp_copy_from`	Download files or directories from the remote host.

Tool	Purpose
`tunnel_open_local`	Open local port or Unix-socket forwarding and return a `tunnelHandle`.
`tunnel_open_remote`	Open remote port or Unix-socket forwarding and return a `tunnelHandle`.
`tunnel_close`	Close a tunnel handle.

Tool	Purpose
`sshteam_register`	Start OAuth device flow registration for this runtime.
`sshteam_register_poll`	Poll device flow completion using a `deviceCode`.
`sshteam_status`	List local registrations and token status.
`sshteam_revoke_device`	Revoke a registered remote device by id.

For full SSH Teams workflow details, see SSH Teams Integration.

Tool	Purpose
`sftp_remove_guard`	Check destructive-operation policy and confirmation before deletion flows.

Resource URI	Purpose
`mcp://maverick/handles`	Snapshot of active SSH, shell, SFTP, file, and tunnel handles.
`mcp://maverick/policy`	Current destructive-operation policy state.

Most tools are handle-oriented: call open first, then work with the returned handle, then close.
For destructive operations, check policy and use confirmation flows where required.