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

Update docs (#2094)

Browse source
This commit is contained in:
Jeremiah Lowin 2025-10-14 19:38:21 -04:00 • committed by GitHub
commit c17f96d4e2
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
5 changed files with 45 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

2
.github/workflows/run-tests.yml vendored
View file

@ -1,4 +1,4 @@
name: Run tests
name: Tests
env:
# enable colored output

3
README.md
View file

@ -15,6 +15,7 @@
*Made with ☕️ by [Prefect](https://www.prefect.io/)*
[![Docs](https://img.shields.io/badge/docs-gofastmcp.com-blue)](https://gofastmcp.com)
[![Discord](https://img.shields.io/badge/community-discord-5865F2?logo=discord&logoColor=white)](https://discord.gg/uu8dJCgttd)
[![PyPI - Version](https://img.shields.io/pypi/v/fastmcp.svg)](https://pypi.org/project/fastmcp)
[![Tests](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml/badge.svg)](https://github.com/jlowin/fastmcp/actions/workflows/run-tests.yml)
[![License](https://img.shields.io/github/license/jlowin/fastmcp.svg)](https://github.com/jlowin/fastmcp/blob/main/LICENSE)
@ -70,6 +71,8 @@ There are two ways to access the LLM-friendly documentation:
- [`llms.txt`](https://gofastmcp.com/llms.txt) is essentially a sitemap, listing all the pages in the documentation.
- [`llms-full.txt`](https://gofastmcp.com/llms-full.txt) contains the entire documentation. Note this may exceed the context window of your LLM.
**Community:** Join our [Discord server](https://discord.gg/uu8dJCgttd) to connect with other FastMCP developers and share what you're building.
---
<!-- omit in toc -->

6
docs/community/showcase.mdx
View file

@ -6,6 +6,12 @@ icon: 'users'
import { YouTubeEmbed } from '/snippets/youtube-embed.mdx'
## Join the Community
<Card title="FastMCP Discord" icon="discord" href="https://discord.gg/uu8dJCgttd">
Connect with other FastMCP developers, share your projects, and discuss ideas.
</Card>
## Featured Projects
Discover exemplary MCP servers and implementations created by our community. These projects demonstrate best practices and innovative uses of FastMCP.

59
docs/docs.json
View file

@ -9,10 +9,10 @@
"dark": "#222831",
"light": "#EEEEEE"
},
"decoration": "windows"
"decoration": "gradient"
},
"banner": {
"content": "Host your server on [FastMCP Cloud](https://fastmcp.cloud) for free!"
"content": "Join the [FastMCP community](https://discord.gg/uu8dJCgttd)!"
},
"colors": {
"dark": "#f72585",
@ -20,10 +20,7 @@
"primary": "#2d00f7"
},
"contextual": {
"options": [
"copy",
"view"
]
"options": ["copy", "view"]
},
"description": "The fast, Pythonic way to build MCP servers and clients.",
"favicon": {
@ -32,9 +29,10 @@
},
"footer": {
"socials": {
"bluesky": "https://bsky.app/profile/jlowin.dev",
"discord": "https://discord.gg/uu8dJCgttd",
"github": "https://github.com/jlowin/fastmcp",
"x": "https://x.com/jlowin"
"website": "https://prefect.ai",
"x": "https://x.com/fastmcp"
}
},
"integrations": {
@ -56,6 +54,11 @@
"href": "https://fastmcp.cloud",
"icon": "cloud",
"label": "FastMCP Cloud"
},
{
"href": "https://discord.gg/uu8dJCgttd",
"icon": "discord",
"label": "Discord"
}
],
"primary": {
@ -64,7 +67,7 @@
}
},
"navigation": {
"tabs": [
"dropdowns": [
{
"groups": [
{
@ -72,7 +75,8 @@
"pages": [
"getting-started/welcome",
"getting-started/installation",
"getting-started/quickstart"
"getting-started/quickstart",
"updates"
]
},
{
@ -132,10 +136,7 @@
{
"group": "Essentials",
"icon": "cube",
"pages": [
"clients/client",
"clients/transports"
]
"pages": ["clients/client", "clients/transports"]
},
{
"group": "Core Operations",
@ -161,10 +162,7 @@
{
"group": "Authentication",
"icon": "user-shield",
"pages": [
"clients/auth/oauth",
"clients/auth/bearer"
]
"pages": ["clients/auth/oauth", "clients/auth/bearer"]
}
]
},
@ -240,18 +238,13 @@
"pages": [
"development/contributing",
"development/tests",
"development/releases"
"development/releases",
"changelog"
]
}
],
"tab": "Documentation"
},
{
"pages": [
"updates",
"changelog"
],
"tab": "What's New"
"dropdown": "Documentation",
"icon": "book"
},
{
"anchors": [
@ -437,7 +430,8 @@
]
}
],
"tab": "SDK Reference"
"dropdown": "SDK Reference",
"icon": "code"
}
]
},
@ -454,7 +448,14 @@
"search": {
"prompt": "Search the docs..."
},
"theme": "mint",
"theme": "almond",
"errors": {
"404": {
"redirect": false,
"title": "Don't panic.",
"description": "You’ve wandered outside the context."
}
},
"thumbnails": {
"appearance": "light",
"background": "/assets/brand/thumbnail-background.png"

9
docs/getting-started/welcome.mdx
View file

@ -3,6 +3,7 @@ title: "Welcome to FastMCP 2.0!"
sidebarTitle: "Welcome!"
description: The fast, Pythonic way to build MCP servers and clients.
icon: hand-wave
mode: wide
---
<img
src="/assets/brand/f-watercolor-waves.png"
@ -38,12 +39,13 @@ if __name__ == "__main__":
## Beyond Basic MCP
FastMCP pioneered Python MCP development, with FastMCP 1.0 being incorporated into the [official MCP SDK](https://github.com/modelcontextprotocol/python-sdk) in 2024.
FastMCP pioneered Python MCP development, and FastMCP 1.0 was incorporated into the [official MCP SDK](https://github.com/modelcontextprotocol/python-sdk) in 2024.
**This is FastMCP 2.0** — the actively maintained version that extends far beyond basic protocol implementation. While the SDK provides core functionality, FastMCP 2.0 delivers everything needed for production: advanced MCP patterns (server composition, proxying, OpenAPI/FastAPI generation, tool transformation), enterprise auth (Google, GitHub, Azure, Auth0, WorkOS, and more), deployment tools, testing frameworks, and comprehensive client libraries.
**This is FastMCP 2.0,** the actively maintained version that extends far beyond basic protocol implementation. While the SDK provides core functionality, FastMCP 2.0 delivers everything needed for production: advanced MCP patterns (server composition, proxying, OpenAPI/FastAPI generation, tool transformation), enterprise auth (Google, GitHub, Azure, Auth0, WorkOS, and more), deployment tools, testing frameworks, and comprehensive client libraries.
Ready to build? Start with our [installation guide](/getting-started/installation) or jump straight to the [quickstart](/getting-started/quickstart).
FastMCP is made with 💙 by [Prefect](https://www.prefect.io/).
## What is MCP?
@ -70,7 +72,6 @@ FastMCP handles all the complex protocol details so you can focus on building. I
FastMCP provides the shortest path from idea to production. Deploy locally, to the cloud with [FastMCP Cloud](https://fastmcp.cloud) (free for personal servers), or to your own infrastructure.
FastMCP is made with 💙 by [Prefect](https://www.prefect.io/).
@ -99,7 +100,7 @@ async def main():
asyncio.run(main())
```
### Plain Text Formats
### Text Formats
The docs are also available in [llms.txt format](https://llmstxt.org/):
- [llms.txt](https://gofastmcp.com/llms.txt) - A sitemap listing all documentation pages