diff --git a/docs/community/README.md b/docs/community/README.md new file mode 100644 index 000000000..b61f5cf6d --- /dev/null +++ b/docs/community/README.md @@ -0,0 +1,22 @@ +# Community Section + +This directory contains community-contributed content and showcases for FastMCP. + +## Structure + +- `showcase.mdx` - Main community showcase page featuring high-quality projects and examples + +## Adding Content + +To add new community content: +1. Create a new MDX file in this directory +2. Update `docs.json` to include it in the navigation +3. Follow the existing format for consistency + +## Guidelines + +Community content should: +- Demonstrate best practices +- Provide educational value +- Include proper documentation +- Be maintained and up-to-date \ No newline at end of file diff --git a/docs/community/showcase.mdx b/docs/community/showcase.mdx new file mode 100644 index 000000000..c3b5ad967 --- /dev/null +++ b/docs/community/showcase.mdx @@ -0,0 +1,44 @@ +--- +title: 'Community Showcase' +description: 'High-quality projects and examples from the FastMCP community' +icon: 'users' +--- + +## Featured Projects + +Discover exemplary MCP servers and implementations created by our community. These projects demonstrate best practices and innovative uses of FastMCP. + +### Learning Resources + + + A comprehensive educational example demonstrating FastMCP best practices with professional dual-transport server implementation, interactive test client, and detailed documentation. + + +#### Video Tutorials + + + Claude Integrations Tutorial by Greg + Code - Learn how to build remote MCP servers using Python and FastMCP. + + + + Tutorial by ZazenCodes - Comprehensive guide to building MCP servers with FastMCP in Python. + + +### Community Examples + +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. + +## Contributing + +To get your project featured: + +1. Ensure your project demonstrates best practices +2. Include comprehensive documentation +3. Add clear usage examples +4. Open a discussion in our [GitHub Discussions](https://github.com/jlowin/fastmcp/discussions) + +We review submissions regularly and feature projects that provide value to the FastMCP community. + +## Further Reading + +- [Contrib Modules](/integrations/contrib) - Community-contributed modules that are distributed with FastMCP itself \ No newline at end of file diff --git a/docs/docs.json b/docs/docs.json index e7cee5dbc..4b0b177d2 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -150,6 +150,13 @@ "pages": [ "changelog" ] + }, + { + "anchor": "Community", + "icon": "users", + "pages": [ + "community/showcase" + ] } ] }, diff --git a/justfile b/justfile index 18bad5aff..6d897b2e9 100644 --- a/justfile +++ b/justfile @@ -6,4 +6,7 @@ test: build # Run pyright on all files typecheck: - uv run --frozen pyright \ No newline at end of file + uv run --frozen pyright + +docs: + cd docs && npx mintlify dev