mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-22 13:34:17 +02:00
chore: Update SDK documentation (#2995)
Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
This commit is contained in:
parent
5fd41b2e15
commit
f6988c9206
35 changed files with 1068 additions and 324 deletions
50
docs/python-sdk/fastmcp-cli-install-stdio.mdx
Normal file
50
docs/python-sdk/fastmcp-cli-install-stdio.mdx
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
---
|
||||
title: stdio
|
||||
sidebarTitle: stdio
|
||||
---
|
||||
|
||||
# `fastmcp.cli.install.stdio`
|
||||
|
||||
|
||||
Stdio command generation for FastMCP install using Cyclopts.
|
||||
|
||||
## Functions
|
||||
|
||||
### `install_stdio` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/stdio.py#L21" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
||||
|
||||
```python
|
||||
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` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/cli/install/stdio.py#L78" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
||||
|
||||
```python
|
||||
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
|
||||
|
||||
Loading…
Add table
Add a link
Reference in a new issue