Skip to main content

fastmcp.utilities.docstring_parsing

Extract descriptions from function docstrings. Uses griffelib to parse Google, NumPy, and Sphinx-style docstrings. The interface is intentionally narrow — a single function returning a ParsedDocstring — so the implementation can be swapped without touching callers.

Functions

parse_docstring

Parse a function’s docstring into a summary and parameter descriptions. Tries Google, NumPy, and Sphinx parsers in order, using the first one that recognizes a structured section (parameters, returns, raises, and so on). The description is the free-form text before the first such section. If no parser recognizes a section, returns the full docstring as the description with no parameter descriptions.

Classes

ParsedDocstring

The extracted description and per-parameter descriptions from a docstring.