mirror of
https://github.com/PrefectHQ/fastmcp.git
synced 2026-08-21 13:04:18 +02:00
Merge pull request #819 from jlowin/add-community-docs
Add Community section to documentation
This commit is contained in:
commit
816ef98e5a
4 changed files with 77 additions and 1 deletions
22
docs/community/README.md
Normal file
22
docs/community/README.md
Normal file
|
|
@ -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
|
||||
44
docs/community/showcase.mdx
Normal file
44
docs/community/showcase.mdx
Normal file
|
|
@ -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
|
||||
|
||||
<Card title="MCP Dummy Server" icon="graduation-cap" href="https://github.com/WaiYanNyeinNaing/mcp-dummy-server">
|
||||
A comprehensive educational example demonstrating FastMCP best practices with professional dual-transport server implementation, interactive test client, and detailed documentation.
|
||||
</Card>
|
||||
|
||||
#### Video Tutorials
|
||||
|
||||
<Card title="Build Remote MCP Servers w/ Python & FastMCP" icon="youtube" href="https://www.youtube.com/watch?v=bOYkbXP-GGo">
|
||||
Claude Integrations Tutorial by Greg + Code - Learn how to build remote MCP servers using Python and FastMCP.
|
||||
</Card>
|
||||
|
||||
<Card title="FastMCP — the best way to build an MCP server with Python" icon="youtube" href="https://www.youtube.com/watch?v=rnljvmHorQw">
|
||||
Tutorial by ZazenCodes - Comprehensive guide to building MCP servers with FastMCP in Python.
|
||||
</Card>
|
||||
|
||||
### 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
|
||||
|
|
@ -150,6 +150,13 @@
|
|||
"pages": [
|
||||
"changelog"
|
||||
]
|
||||
},
|
||||
{
|
||||
"anchor": "Community",
|
||||
"icon": "users",
|
||||
"pages": [
|
||||
"community/showcase"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
5
justfile
5
justfile
|
|
@ -6,4 +6,7 @@ test: build
|
|||
|
||||
# Run pyright on all files
|
||||
typecheck:
|
||||
uv run --frozen pyright
|
||||
uv run --frozen pyright
|
||||
|
||||
docs:
|
||||
cd docs && npx mintlify dev
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue