sftp_helper.mcp module

SFTP Helper — Model Context Protocol (MCP) surface.

Adapter that exposes the FastAPI app defined in sftp_helper.api as MCP tools so an MCP-aware client (Claude Desktop, custom agents, IDE integrations, …) can call upload / download / delete / exists / … as first-class tools. Uses fastapi_mcp (https://github.com/tadata-org/fastapi_mcp) — one line wraps the whole existing HTTP surface, so we never duplicate the route definitions.

Install the extra to pull in fastapi-mcp:

pip install 'sftp-helper[api,mcp]'

Then run the MCP server:

sftp-helper-mcp                 # entry point (see pyproject)
# or, equivalently:
python -m sftp_helper.mcp

Usage Example

>>> # Register the MCP endpoint in your client. It publishes:
>>> #   upload / download / delete / exists / dir-exists / mkdir /
>>> #   normalize-path / strip-path / tempfile / show-credentials
>>> # …with the same argument names as the FastAPI routes.

Author

Warith Harchaoui, Ph.D. — https://linkedin.com/in/warith-harchaoui/

sftp_helper.mcp.main()[source]

Entry point for the sftp-helper-mcp console script.

Boots the FastAPI app (which now serves both the /… HTTP routes and the MCP endpoint) with uvicorn in single-worker mode. Meant for local / container usage; behind a real load balancer use uvicorn/gunicorn directly.

Return type:: None