ceos/fastmcp
1
0
Fork 0
mirror of https://github.com/PrefectHQ/fastmcp.git synced 2026-08-09 15:19:10 +02:00
Code Issues Projects Releases Packages Wiki Activity

fix: RST docstrings in fastmcp.types render raw on gofastmcp.com (#4367)

Browse source 
Co-authored-by: Justin van Zyl <justin.vanzyl@xero.com>
This commit is contained in:
Jeremiah Lowin 2026-06-24 11:52:05 -04:00 • committed by GitHub
commit 47101eeccd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 12 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

22
fastmcp_slim/fastmcp/types.py
View file

@ -1,19 +1,21 @@
"""Reusable type annotations for FastMCP tool parameters.
These types can be used in tool function signatures to influence how
parameters are presented in UIs (e.g. ``fastmcp dev apps``) and
parameters are presented in UIs (e.g. `fastmcp dev apps`) and
serialized in JSON Schema.
Example::
Example:
from fastmcp import FastMCP
from fastmcp.types import Textarea
```python
from fastmcp import FastMCP
from fastmcp.types import Textarea
mcp = FastMCP("demo")
mcp = FastMCP("demo")
@mcp.tool()
def run_query(sql: Textarea) -> str:
...
@mcp.tool()
def run_query(sql: Textarea) -> str:
...
```
"""
from __future__ import annotations
@ -25,8 +27,8 @@ from pydantic import Field
Textarea = Annotated[str, Field(json_schema_extra={"format": "textarea"})]
"""A string rendered as a multiline textarea in form-based UIs.
Produces ``"format": "textarea"`` in the JSON Schema, which
``fastmcp dev apps`` picks up automatically.
Produces `"format": "textarea"` in the JSON Schema, which
`fastmcp dev apps` picks up automatically.
"""
__all__ = ["Textarea"]