Learn how to use the FlashMCP command-line interface
Command | Purpose | Dependency Management |
---|---|---|
run | Run a FlashMCP server directly | Uses your current environment; you are responsible for ensuring all dependencies are available |
dev | Run a server with the MCP Inspector for testing | Creates an isolated environment; dependencies must be explicitly specified with --with and/or --with-editable |
install | Install a server in the Claude desktop app | Creates an isolated environment; dependencies must be explicitly specified with --with and/or --with-editable |
version | Display version information | N/A |
run
Option | Flag | Description |
---|---|---|
Transport | --transport , -t | Transport protocol to use (stdio , streamable-http , or sse ) |
Host | --host | Host to bind to when using http transport (default: 127.0.0.1) |
Port | --port , -p | Port to bind to when using http transport (default: 8000) |
Log Level | --log-level , -l | Log level (DEBUG, INFO, WARNING, ERROR, CRITICAL) |
New in version: 2.3.5
The server can be specified in three ways:
server.py
- imports the module and looks for a FlashMCP object named mcp
, server
, or app
. Errors if no such object is found.server.py:custom_name
- imports and uses the specified server objecthttp://server-url/path
or https://server-url/path
- connects to a remote server and creates a proxyFlashMCP run
with a local file, it ignores the if __name__ == "__main__"
block entirely. Instead, it finds your server object and calls its run()
method directly with the transport options you specify. This means you can use FlashMCP run
to override the transport specified in your code.__main__
block:
dev
--with
and/or --with-editable
options.dev
command is a shortcut for testing a server over STDIO only. When the Inspector launches, you may need to:Option | Flag | Description |
---|---|---|
Editable Package | --with-editable , -e | Directory containing pyproject.toml to install in editable mode |
Additional Packages | --with | Additional packages to install (can be used multiple times) |
Inspector Version | --inspector-version | Version of the MCP Inspector to use |
UI Port | --ui-port | Port for the MCP Inspector UI |
Server Port | --server-port | Port for the MCP Inspector Proxy server |
install
--with
and/or --with-editable
options.install
command currently only sets up servers for STDIO transport. When installed in the Claude desktop app, your server will be run using STDIO regardless of any transport configuration in your code.Option | Flag | Description |
---|---|---|
Server Name | --name , -n | Custom name for the server |
Editable Package | --with-editable , -e | Directory containing pyproject.toml to install in editable mode |
Additional Packages | --with | Additional packages to install (can be used multiple times) |
Environment Variables | --env-var , -v | Environment variables in KEY=VALUE format (can be used multiple times) |
Environment File | --env-file , -f | Load environment variables from a .env file |
version