fastmcp/docs
Bill Easton be6b1670d3
[Draft] Add documentation for read-only tool patterns (#2536)
* Add comprehensive documentation for read-only tool patterns

Created new patterns guide explaining readOnlyHint annotation usage,
including practical examples, client-specific behavior, and best
practices for marking tools as read-only.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-authored-by: William Easton <strawgate@users.noreply.github.com>

* Reorganize read-only tools docs into tools section

Moved read-only tools documentation from standalone patterns page into the tools.mdx file as a "Using Annotation Hints" subsection. Condensed from 218 lines to ~50 lines focusing on practical usage while maintaining essential information about readOnlyHint and other annotations.

Changes:
- Added "Using Annotation Hints" subsection in tools.mdx after MCP Annotations
- Removed docs/patterns/read-only-tools.mdx
- Updated docs.json navigation to remove patterns entry
- Content now positioned as core tool feature rather than advanced pattern

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Bill Easton <strawgate@users.noreply.github.com>

---------

Co-authored-by: claude[bot] <41898282+claude[bot]@users.noreply.github.com>
Co-authored-by: William Easton <strawgate@users.noreply.github.com>
2025-12-09 13:47:29 -05:00
..
.cursor/rules Clean up parameter documentation 2025-06-22 20:59:53 -04:00
assets Support custom server name, icons, and link in OAuth Proxy consent page (#2135) 2025-10-18 11:49:26 -04:00
clients Rewrite background tasks documentation (#2567) 2025-12-06 19:28:14 -05:00
community Update docs (#2094) 2025-10-14 16:38:21 -07:00
css Update VersionBadge to use Mintlify native Badge component (#2571) 2025-12-06 21:23:53 -05:00
deployment SEP-1699: Add SSE polling support with EventStore (#2564) 2025-12-09 09:55:51 -05:00
development Add v2.14.0 upgrade guide (#2565) 2025-12-06 11:40:42 -05:00
getting-started Pin Cyclopts to v4.0.0 + compliance note (#2354) 2025-11-03 18:37:12 -05:00
integrations Add supabase docs (#2030) 2025-12-04 18:25:57 -05:00
patterns docs: clarify pytest-asyncio dependency and asyncio mode configuration (#2399) 2025-11-15 10:34:29 -05:00
public/schemas/fastmcp.json chore: Update fastmcp.json schema (#1955) 2025-09-29 20:12:24 -04:00
python-sdk Switch to new OpenAPI parser as default (#2513) 2025-12-01 20:29:18 -05:00
servers [Draft] Add documentation for read-only tool patterns (#2536) 2025-12-09 13:47:29 -05:00
snippets Update VersionBadge to use Mintlify native Badge component (#2571) 2025-12-06 21:23:53 -05:00
tutorials Remove trailing slashes from MCP endpoint URLs in docs (#2277) 2025-10-27 10:36:47 -04:00
.ccignore Add comprehensive OAuth 2.1 authentication system with WorkOS integration (#1327) 2025-08-01 17:06:55 -04:00
changelog.mdx 2.14 deprecation removals (#2329) 2025-12-01 14:11:00 -05:00
docs.json [2.14] SEP-1686 tasks (#2378) 2025-12-04 20:10:35 -05:00
updates.mdx Stage 2.13.0 updates (#2252) 2025-10-25 08:52:21 -04:00