Skip to main content

Configuration

Once the SFTP connection is validated, configuration defines how MCP Express exposes SFTP file operations as callable tools. Most actions require a remote path and may optionally include filters, file content, or local destinations depending on the tool.

Tool Orchestration

SFTP uses an action-oriented model where each tool maps to a bounded file operation. Configuration should keep path scope explicit and expose only the runtime fields needed by that action.

Action Configuration

Use action configuration to define which file operation the tool performs and which parameters are resolved at runtime.

Supported Actions

The following actions are supported by the SFTP integration:

  • Search: Find files that match a wildcard pattern under a directory.
  • Read: Read the contents of a specific remote file.
  • Write: Create or update a remote file with provided content.
  • Upload: Send a local file to the remote server.
  • Download: Fetch a remote file to the MCP server host.
  • List: List files and directories under a remote path.

Common Runtime Parameters

Use the following parameters according to the configured action.

ParameterRequiredDescription
ActionYesThe operation to run: search, list, read, write, upload, or download.
Remote PathSomeDirectory to search or list. Required for search and list.
Remote Path (File)SomeRemote file path for read, write, upload, or download.
Local PathSomeLocal file path for upload and download (on the MCP server host).
File ContentSomeContent to write for write.
PatternNoWildcard match for search (e.g., *.log).
RecursiveNoEnable subdirectory traversal for search or list.
Include HiddenNoInclude dotfiles when listing.
Max ResultsNoCap the number of returned items. Defaults: search 100, list 1000.
EncodingNoRead mode for read: auto, text, or binary.
OverwriteNoOverwrite existing files for write, upload, or download.

Governance Controls

Limit tools to approved base directories and avoid broad patterns in production. Keep write, upload, and download targets explicit so content is only placed where you expect it.

Test Tool Contracts Before Deployment

Use the built-in testing utility to verify path resolution ({{ }} substitution), required field behavior, and permissions before enabling tools in production.