fastmcp.resources.types

Concrete resource implementations.

Classes

TextResource

A resource that reads from a string. Methods:

read

read(self) -> str
Read the text content.

BinaryResource

A resource that reads from bytes. Methods:

read

read(self) -> bytes
Read the binary content.

FileResource

A resource that reads from a file. Set is_binary=True to read file as binary data instead of text. Methods:

validate_absolute_path

validate_absolute_path(cls, path: Path) -> Path
Ensure path is absolute.

set_binary_from_mime_type

set_binary_from_mime_type(cls, is_binary: bool, info: ValidationInfo) -> bool
Set is_binary based on mime_type if not explicitly set.

read

read(self) -> str | bytes
Read the file content.

HttpResource

A resource that reads from an HTTP endpoint. Methods:

read

read(self) -> str | bytes
Read the HTTP content.

DirectoryResource

A resource that lists files in a directory. Methods:

validate_absolute_path

validate_absolute_path(cls, path: Path) -> Path
Ensure path is absolute.

list_files

list_files(self) -> list[Path]
List files in the directory.

read

read(self) -> str
Read the directory listing.