fastmcp.resources.types

Concrete resource implementations.

Classes

TextResource ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L21" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A resource that reads from a string.

Methods:

read ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L26" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(self) -> ResourceResult

Read the text content.

BinaryResource ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L37" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A resource that reads from bytes.

Methods:

read ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L42" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(self) -> ResourceResult

Read the binary content.

FileResource ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L53" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A resource that reads from a file.

Set is_binary=True to read file as binary data instead of text.

Methods:

validate_absolute_path ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L83" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_absolute_path(cls, path: Path) -> Path

Ensure path is absolute.

set_binary_from_mime_type ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L91" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

set_binary_from_mime_type(cls, is_binary: bool, info: ValidationInfo) -> bool

Set is_binary based on mime_type if not explicitly set.

read ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L99" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(self) -> ResourceResult

Read the file content.

HttpResource ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L113" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A resource that reads from an HTTP endpoint.

Methods:

read ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L122" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(self) -> ResourceResult

Read the HTTP content.

DirectoryResource ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L134" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

A resource that lists files in a directory.

Methods:

validate_absolute_path ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L154" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

validate_absolute_path(cls, path: Path) -> Path

Ensure path is absolute.

list_files ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L160" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

list_files(self) -> list[Path]

List files in the directory.

read ^{<a href="https://github.com/PrefectHQ/fastmcp/blob/main/src/fastmcp/resources/types.py#L176" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

read(self) -> ResourceResult

Read the directory listing.