Spaces:
Running
Running
Merge pull request #819 from jlowin/add-community-docs
Browse files- docs/community/README.md +22 -0
- docs/community/showcase.mdx +44 -0
- docs/docs.json +7 -0
- justfile +4 -1
docs/community/README.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Community Section
|
| 2 |
+
|
| 3 |
+
This directory contains community-contributed content and showcases for FastMCP.
|
| 4 |
+
|
| 5 |
+
## Structure
|
| 6 |
+
|
| 7 |
+
- `showcase.mdx` - Main community showcase page featuring high-quality projects and examples
|
| 8 |
+
|
| 9 |
+
## Adding Content
|
| 10 |
+
|
| 11 |
+
To add new community content:
|
| 12 |
+
1. Create a new MDX file in this directory
|
| 13 |
+
2. Update `docs.json` to include it in the navigation
|
| 14 |
+
3. Follow the existing format for consistency
|
| 15 |
+
|
| 16 |
+
## Guidelines
|
| 17 |
+
|
| 18 |
+
Community content should:
|
| 19 |
+
- Demonstrate best practices
|
| 20 |
+
- Provide educational value
|
| 21 |
+
- Include proper documentation
|
| 22 |
+
- Be maintained and up-to-date
|
docs/community/showcase.mdx
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
title: 'Community Showcase'
|
| 3 |
+
description: 'High-quality projects and examples from the FastMCP community'
|
| 4 |
+
icon: 'users'
|
| 5 |
+
---
|
| 6 |
+
|
| 7 |
+
## Featured Projects
|
| 8 |
+
|
| 9 |
+
Discover exemplary MCP servers and implementations created by our community. These projects demonstrate best practices and innovative uses of FastMCP.
|
| 10 |
+
|
| 11 |
+
### Learning Resources
|
| 12 |
+
|
| 13 |
+
<Card title="MCP Dummy Server" icon="graduation-cap" href="https://github.com/WaiYanNyeinNaing/mcp-dummy-server">
|
| 14 |
+
A comprehensive educational example demonstrating FastMCP best practices with professional dual-transport server implementation, interactive test client, and detailed documentation.
|
| 15 |
+
</Card>
|
| 16 |
+
|
| 17 |
+
#### Video Tutorials
|
| 18 |
+
|
| 19 |
+
<Card title="Build Remote MCP Servers w/ Python & FastMCP" icon="youtube" href="https://www.youtube.com/watch?v=bOYkbXP-GGo">
|
| 20 |
+
Claude Integrations Tutorial by Greg + Code - Learn how to build remote MCP servers using Python and FastMCP.
|
| 21 |
+
</Card>
|
| 22 |
+
|
| 23 |
+
<Card title="FastMCP — the best way to build an MCP server with Python" icon="youtube" href="https://www.youtube.com/watch?v=rnljvmHorQw">
|
| 24 |
+
Tutorial by ZazenCodes - Comprehensive guide to building MCP servers with FastMCP in Python.
|
| 25 |
+
</Card>
|
| 26 |
+
|
| 27 |
+
### Community Examples
|
| 28 |
+
|
| 29 |
+
Have you built something interesting with FastMCP? We'd love to feature high-quality examples here! Start a [discussion on GitHub](https://github.com/jlowin/fastmcp/discussions) to share your project.
|
| 30 |
+
|
| 31 |
+
## Contributing
|
| 32 |
+
|
| 33 |
+
To get your project featured:
|
| 34 |
+
|
| 35 |
+
1. Ensure your project demonstrates best practices
|
| 36 |
+
2. Include comprehensive documentation
|
| 37 |
+
3. Add clear usage examples
|
| 38 |
+
4. Open a discussion in our [GitHub Discussions](https://github.com/jlowin/fastmcp/discussions)
|
| 39 |
+
|
| 40 |
+
We review submissions regularly and feature projects that provide value to the FastMCP community.
|
| 41 |
+
|
| 42 |
+
## Further Reading
|
| 43 |
+
|
| 44 |
+
- [Contrib Modules](/integrations/contrib) - Community-contributed modules that are distributed with FastMCP itself
|
docs/docs.json
CHANGED
|
@@ -150,6 +150,13 @@
|
|
| 150 |
"pages": [
|
| 151 |
"changelog"
|
| 152 |
]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 153 |
}
|
| 154 |
]
|
| 155 |
},
|
|
|
|
| 150 |
"pages": [
|
| 151 |
"changelog"
|
| 152 |
]
|
| 153 |
+
},
|
| 154 |
+
{
|
| 155 |
+
"anchor": "Community",
|
| 156 |
+
"icon": "users",
|
| 157 |
+
"pages": [
|
| 158 |
+
"community/showcase"
|
| 159 |
+
]
|
| 160 |
}
|
| 161 |
]
|
| 162 |
},
|
justfile
CHANGED
|
@@ -6,4 +6,7 @@ test: build
|
|
| 6 |
|
| 7 |
# Run pyright on all files
|
| 8 |
typecheck:
|
| 9 |
-
uv run --frozen pyright
|
|
|
|
|
|
|
|
|
|
|
|
| 6 |
|
| 7 |
# Run pyright on all files
|
| 8 |
typecheck:
|
| 9 |
+
uv run --frozen pyright
|
| 10 |
+
|
| 11 |
+
docs:
|
| 12 |
+
cd docs && npx mintlify dev
|