From cf66cc8b567f2e6f84138c541e8ed472a990f320 Mon Sep 17 00:00:00 2001 From: zzstoatzz Date: Thu, 12 Jun 2025 11:53:15 -0500 Subject: [PATCH 1/2] Add Community section to documentation MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add new Community tab to docs navigation - Create community showcase page for featuring high-quality projects - Include example project (MCP Dummy Server) as initial content - Add guidelines for community contributions - Link to contrib modules in Further Reading section 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- docs/community/README.md | 22 ++++++++++++++++++++++ docs/community/showcase.mdx | 34 ++++++++++++++++++++++++++++++++++ docs/docs.json | 7 +++++++ 3 files changed, 63 insertions(+) create mode 100644 docs/community/README.md create mode 100644 docs/community/showcase.mdx 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..8bbd087e5 --- /dev/null +++ b/docs/community/showcase.mdx @@ -0,0 +1,34 @@ +--- +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. + + +### 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" + ] } ] }, From 313b8d5bf16b1b99d1e2ad3af206801c18657da1 Mon Sep 17 00:00:00 2001 From: zzstoatzz Date: Thu, 12 Jun 2025 11:59:18 -0500 Subject: [PATCH 2/2] Add video tutorials to community showcase MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Add YouTube tutorial by Greg + Code on building remote MCP servers - Add YouTube tutorial by ZazenCodes on FastMCP best practices - Create Video Tutorials subsection under Learning Resources - Add docs command to justfile for local documentation serving 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude --- docs/community/showcase.mdx | 10 ++++++++++ justfile | 5 ++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/community/showcase.mdx b/docs/community/showcase.mdx index 8bbd087e5..c3b5ad967 100644 --- a/docs/community/showcase.mdx +++ b/docs/community/showcase.mdx @@ -14,6 +14,16 @@ Discover exemplary MCP servers and implementations created by our community. The 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. 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