Spaces:
Running
Running
| --- | |
| title: prompt | |
| sidebarTitle: prompt | |
| --- | |
| # `fastmcp.prompts.prompt` | |
| Base classes for FastMCP prompts. | |
| ## Functions | |
| ### `Message` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L31" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| Message(content: str | ContentBlock, role: Role | None = None, **kwargs: Any) -> PromptMessage | |
| ``` | |
| A user-friendly constructor for PromptMessage. | |
| ## Classes | |
| ### `PromptArgument` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L53" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| An argument that can be passed to a prompt. | |
| ### `Prompt` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L65" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| A prompt template that can be rendered with parameters. | |
| **Methods:** | |
| #### `enable` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L72" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| enable(self) -> None | |
| ``` | |
| #### `disable` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L80" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| disable(self) -> None | |
| ``` | |
| #### `to_mcp_prompt` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L88" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| to_mcp_prompt(self, **overrides: Any) -> MCPPrompt | |
| ``` | |
| Convert the prompt to an MCP prompt. | |
| #### `from_function` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L113" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| from_function(fn: Callable[..., PromptResult | Awaitable[PromptResult]], name: str | None = None, title: str | None = None, description: str | None = None, tags: set[str] | None = None, enabled: bool | None = None, meta: dict[str, Any] | None = None) -> FunctionPrompt | |
| ``` | |
| Create a Prompt from a function. | |
| The function can return: | |
| - A string (converted to a message) | |
| - A Message object | |
| - A dict (converted to a message) | |
| - A sequence of any of the above | |
| #### `render` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L141" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| render(self, arguments: dict[str, Any] | None = None) -> list[PromptMessage] | |
| ``` | |
| Render the prompt with arguments. | |
| ### `FunctionPrompt` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L149" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| A prompt that is a function. | |
| **Methods:** | |
| #### `from_function` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L155" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| from_function(cls, fn: Callable[..., PromptResult | Awaitable[PromptResult]], name: str | None = None, title: str | None = None, description: str | None = None, tags: set[str] | None = None, enabled: bool | None = None, meta: dict[str, Any] | None = None) -> FunctionPrompt | |
| ``` | |
| Create a Prompt from a function. | |
| The function can return: | |
| - A string (converted to a message) | |
| - A Message object | |
| - A dict (converted to a message) | |
| - A sequence of any of the above | |
| #### `render` <sup><a href="https://github.com/jlowin/fastmcp/blob/main/src/fastmcp/prompts/prompt.py#L315" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup> | |
| ```python | |
| render(self, arguments: dict[str, Any] | None = None) -> list[PromptMessage] | |
| ``` | |
| Render the prompt with arguments. | |