Skip to content

πŸš€ The fast, Pythonic way to build MCP servers and clients.

1.4 KB
Raw Blame
---
title: docstring_parsing
sidebarTitle: docstring_parsing
---

# `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` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/docstring_parsing.py#L33" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>

```python
parse_docstring(fn: Callable[..., Any]) -> ParsedDocstring
```


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` <sup><a href="https://github.com/PrefectHQ/fastmcp/blob/main/fastmcp_slim/fastmcp/utilities/docstring_parsing.py#L26" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a></sup>


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