Skip to main content

fastmcp.cli.install.stdio

Stdio command generation for FastMCP install using Cyclopts.

Functions

install_stdio

install_stdio(file: Path, server_object: str | None) -> bool
Generate the stdio command for running a FastMCP server. Args:
  • file: Path to the server file
  • server_object: Optional server object name (for :object suffix)
  • with_editable: Optional list of directories to install in editable mode
  • with_packages: Optional list of additional packages to install
  • copy: If True, copy to clipboard instead of printing to stdout
  • python_version: Optional Python version to use
  • with_requirements: Optional requirements file to install from
  • project: Optional project directory to run within
Returns:
  • True if generation was successful, False otherwise

stdio_command

stdio_command(server_spec: str) -> None
Generate the stdio command for running a FastMCP server. Outputs the shell command that an MCP host would use to start this server over stdio transport. Useful for manual configuration or debugging. Args:
  • server_spec: Python file to run, optionally with :object suffix