Skip to main content

​
fastmcp.client.mixins.prompts

Prompt-related methods for FastMCP Client.

​
Classes

​
ClientPromptsMixin

Mixin providing prompt-related methods for Client. Methods:

​
list_prompts_mcp

Send a prompts/list request and return the complete MCP protocol result. Args:
  • cursor: Optional pagination cursor from a previous request’s nextCursor.
  • cache_mode: Response-cache behavior (only active with a cache and a modern connection). See list_tools_mcp.
Returns:
  • mcp_types.ListPromptsResult: The complete response object from the protocol, containing the list of prompts and any additional metadata.
Raises:
  • RuntimeError: If called while the client is not connected.
  • MCPError: If the request results in a TimeoutError | JSONRPCError

​
list_prompts

Retrieve all prompts available on the server. This method automatically fetches all pages if the server paginates results, returning the complete list. For manual pagination control (e.g., to handle large result sets incrementally), use list_prompts_mcp() with the cursor parameter. Args:
  • max_pages: Maximum number of pages to fetch before raising. Defaults to 250.
Returns:
  • list[mcp_types.Prompt]: A list of all Prompt objects.
Raises:
  • RuntimeError: If the page limit is reached before pagination completes.
  • MCPError: If the request results in a TimeoutError | JSONRPCError

​
get_prompt_mcp

Send a prompts/get request and return the complete MCP protocol result. Args:
  • name: The name of the prompt to retrieve.
  • arguments: Arguments to pass to the prompt. Defaults to None.
  • meta: Request metadata (e.g., for SEP-1686 tasks). Defaults to None.
Returns:
  • mcp_types.GetPromptResult: The complete response object from the protocol, containing the prompt messages and any additional metadata.
Raises:
  • RuntimeError: If called while the client is not connected.
  • MCPError: If the request results in a TimeoutError | JSONRPCError

​
get_prompt

Retrieve a rendered prompt message list from the server. Args:
  • name: The name of the prompt to retrieve.
  • arguments: Arguments to pass to the prompt. Defaults to None.
  • version: Specific prompt version to get. If None, gets highest version.
  • meta: Optional request-level metadata.
Returns:
  • mcp_types.GetPromptResult: The complete response object.
Raises:
  • RuntimeError: If called while the client is not connected.
  • MCPError: If the request results in a TimeoutError | JSONRPCError