mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-09 15:19:10 +02:00
9b248a15b3* Update repository references from jlowin/fastmcp to prefecthq/fastmcp * Retrigger CI after repo transfer * chore: Update SDK documentation * Only run deep triage on bug issues for jlowin --------- Co-authored-by: marvin-context-protocol[bot] <225465937+marvin-context-protocol[bot]@users.noreply.github.com>
66 lines
2.3 KiB
Text
66 lines
2.3 KiB
Text
---
|
|
title: generate
|
|
sidebarTitle: generate
|
|
---
|
|
|
|
# `fastmcp.cli.generate`
|
|
|
|
|
|
Generate a standalone CLI script and agent skill from an MCP server.
|
|
|
|
## Functions
|
|
|
|
### `serialize_transport` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/generate.py#L122" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
serialize_transport(resolved: str | dict[str, Any] | ClientTransport) -> tuple[str, set[str]]
|
|
```
|
|
|
|
|
|
Serialize a resolved transport to a Python expression string.
|
|
|
|
Returns ``(expression, extra_imports)`` where *extra_imports* is a set of
|
|
import lines needed by the expression.
|
|
|
|
|
|
### `generate_cli_script` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/generate.py#L283" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
generate_cli_script(server_name: str, server_spec: str, transport_code: str, extra_imports: set[str], tools: list[mcp.types.Tool]) -> str
|
|
```
|
|
|
|
|
|
Generate the full CLI script source code.
|
|
|
|
|
|
### `generate_skill_content` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/generate.py#L621" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
generate_skill_content(server_name: str, cli_filename: str, tools: list[mcp.types.Tool]) -> str
|
|
```
|
|
|
|
|
|
Generate a SKILL.md file for a generated CLI script.
|
|
|
|
|
|
### `generate_cli_command` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/cli/generate.py#L672" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>
|
|
|
|
```python
|
|
generate_cli_command(server_spec: Annotated[str, cyclopts.Parameter(help='Server URL, Python file, MCPConfig JSON, discovered name, or .js file')], output: Annotated[str, cyclopts.Parameter(help='Output file path (default: cli.py)')] = 'cli.py') -> None
|
|
```
|
|
|
|
|
|
Generate a standalone CLI script from an MCP server.
|
|
|
|
Connects to the server, reads its tools/resources/prompts, and writes
|
|
a Python script that can invoke them directly. Also generates a SKILL.md
|
|
agent skill file unless --no-skill is passed.
|
|
|
|
**Examples:**
|
|
|
|
fastmcp generate-cli weather
|
|
fastmcp generate-cli weather my_cli.py
|
|
fastmcp generate-cli http://localhost:8000/mcp
|
|
fastmcp generate-cli server.py output.py -f
|
|
fastmcp generate-cli weather --no-skill
|
|
|