Stop fighting with hallucinated widgets and deprecated APIs. Flutter MCP connects your AI assistant to real-time documentation, ensuring the Flutter code it generates actually works.
概览
Stop fighting with hallucinated widgets and deprecated APIs. Flutter MCP connects your AI assistant to real-time documentation, ensuring the Flutter code it generates actually works.
README
Flutter MCP: Give Your AI Real-Time Flutter Superpowers 🚀
A real-time MCP server providing Flutter/Dart documentation and pub.dev package info to AI assistants — supports ALL 50,000+ packages on demand.
Stop fighting with hallucinated widgets and deprecated APIs. Flutter MCP connects your AI assistant to real-time documentation, ensuring the Flutter code it generates actually works.
Quick Start • Demo • Features • How it Works • Contributing
🎬 Demo
See it in action: From npx flutter-mcp to getting real-time Flutter documentation in 20 seconds.
The Problem: Your AI is Stuck in 2021
🚀 Quick Start
Installation
Get started in seconds with npm:
# One-line usage (no installation required)
npx flutter-mcp
# Or install globally
npm install -g flutter-mcp
flutter-mcp
That’s it! No Python setup, no configuration, no complexity. The server automatically installs dependencies and starts running.
📢 For MCP SuperAssistant Users: Use
npx flutter-mcp --transport http --port 8000to enable HTTP transport!
Alternative Installation Methods
Requirements
- Node.js 16+ (for npm/npx)
- Python 3.10+ is auto-detected and used by the npm package
- That’s it! Built-in SQLite caching means no external dependencies
2. Add to Your AI Assistant
3. Start the Server (Optional for Testing)
3. Use It!
Flutter MCP now features simplified tools following Context7’s successful pattern - just 2 main tools instead of 5!
🎯 New Simplified Usage (Recommended)
The AI assistant can now use Flutter MCP more intelligently:
# Universal search
"Search for Flutter animation widgets"
"Find state management packages"
"Look for HTTP clients in pub.dev"
# Smart documentation fetching
"Show me Container widget documentation"
"Get the docs for provider package"
"Explain dart:async Future class"
💫 Natural Language Support
Your AI will automatically detect Flutter/Dart content and fetch relevant docs:
"How do I implement infinite scroll with infinite_scroll_pagination?"
"Show me dio interceptors for auth tokens"
"What's the difference between bloc and riverpod?"
🔧 Legacy Support
The @flutter_mcp mentions still work for backward compatibility:
"Explain @flutter_mcp freezed code generation"
"Show me all @flutter_mcp get_it service locator patterns"
🎯 Version-Specific Documentation (NEW!)
Get documentation for specific package versions using familiar pub.dev syntax:
# Exact versions
"Show me @flutter_mcp provider:6.0.5 breaking changes"
"How does @flutter_mcp riverpod:2.5.1 AsyncNotifier work?"
# Version ranges
"Compare @flutter_mcp dio:^5.0.0 vs @flutter_mcp dio:^4.0.0"
"What's new in @flutter_mcp bloc:>=8.0.0?"
# Special keywords
"Try @flutter_mcp get:latest experimental features"
"Is @flutter_mcp provider:stable production ready?"
See Version Specification Guide for details.
📚 Available Tools
🎯 NEW: Simplified Tools (Context7-style)
Flutter MCP now provides just 2 main tools, making it easier for AI assistants to use:
1. flutter_search - Universal Search
Search across Flutter/Dart documentation and pub.dev packages with intelligent ranking.
{
"tool": "flutter_search",
"arguments": {
"query": "state management",
"limit": 10 // Optional: max results (default: 10)
}
}
Returns multiple options for the AI to choose from, including Flutter classes, Dart libraries, pub packages, and concepts.
2. flutter_docs - Smart Documentation Fetcher
Get documentation for any Flutter/Dart identifier with automatic type detection.
{
"tool": "flutter_docs",
"arguments": {
"identifier": "Container", // Auto-detects as Flutter widget
"topic": "examples", // Optional: filter content
"max_tokens": 10000 // Optional: limit response size
}
}
Supports various formats:
"Container"- Flutter widget"material.AppBar"- Library-qualified class"provider"- pub.dev package"dart:async.Future"- Dart core library
3. flutter_status - Health Check (Optional)
Monitor service health and cache statistics.
{
"tool": "flutter_status",
"arguments": {}
}
📦 Legacy Tools (Deprecated but still functional)
The following tools are maintained for backward compatibility but internally use the new simplified tools:
🎯 Features
- ✨ NEW: Simplified Tools: Just 2 main tools instead of 5 - following Context7’s successful pattern
- 📦 Real-Time Documentation: Fetches the latest docs for any pub.dev package on-demand
- 🎯 Version-Specific Docs: Request exact versions, ranges, or use keywords like
latest/stable - 🚀 Zero Configuration: Automatically detects packages from your
pubspec.yaml - ⚡ Lightning Fast: Intelligent caching means instant responses after first fetch
- 🔒 100% Private: Runs locally - your code never leaves your machine
- 🎨 Smart Context: Provides constructors, methods, examples, and migration guides
- ♾️ Unlimited Packages: Works with all 50,000+ packages on pub.dev
- 🤖 AI-Optimized: Token limiting and smart truncation for efficient LLM usage
💡 How It Works
Flutter MCP is a local MCP server (think of it as a “RAG sidecar” for Flutter) built on the battle-tested Python MCP SDK. It enhances your AI with real-time documentation:
graph LR
A[Your Prompt] --> B[AI Assistant]
B --> C{Flutter/Dart Content?}
C -->|Yes| D[Query Flutter MCP]
D --> E[Check Local Cache]
E -->|Hit| F[Return Cached Docs]
E -->|Miss| G[Fetch from pub.dev]
G --> H[Process & Cache]
H --> F
F --> I[Enhanced Context]
I --> J[AI Generates Accurate Code]
C -->|No| J
The Magic Behind the Scenes
- MCP Integration: Your AI assistant automatically detects when you’re asking about Flutter/Dart packages
- Smart Detection: No special syntax required - just mention package names naturally
- Lightning Cache: First request fetches from pub.dev (1-2 seconds), subsequent requests are instant
- Context Injection: Documentation is seamlessly added to your AI’s knowledge before it responds
- Privacy First: Everything runs locally - your code and queries never leave your machine
Performance Notes
- ⚡ First Query: 1-2 seconds (fetching from pub.dev)
- 🚀 Cached Queries: <50ms (from local SQLite cache)
- 💾 Cache Duration: 24 hours for API docs, 12 hours for packages
- 🧹 Auto-Cleanup: Expired entries cleaned on access
Error Handling
If documentation isn’t available or a fetch fails, Flutter MCP gracefully informs your AI, preventing it from generating incorrect or hallucinated code based on missing information. Your AI will let you know it couldn’t find the docs rather than guessing.
📊 What Gets Indexed
When you request a package, Flutter MCP extracts:
- ✅ API Documentation: Classes, methods, properties with full signatures
- ✅ Constructors: All parameters, named arguments, defaults
- ✅ Code Examples: From official docs and README files
- ✅ Migration Guides: Breaking changes and upgrade paths
- ✅ Package Metadata: Dependencies, platform support, versions
🛠️ Advanced Usage
🛠️ Troubleshooting
📱 Client Configurations
Need help configuring your MCP client? We have detailed guides for:
- Claude Desktop
- MCP SuperAssistant
- Claude Code
- VS Code + Continue
- Custom HTTP/SSE clients
- Docker configurations
→ View all client configuration examples
🤝 Contributing
We love contributions! This is an open-source project and we welcome improvements.
Quick Ways to Contribute
- 🐛 Report bugs - Open an issue
- 💡 Suggest features - Start a discussion
- 📖 Improve docs - Even fixing a typo helps!
- 🧪 Add tests - Help us reach 100% coverage
- 🌐 Add translations - Make Flutter MCP accessible globally
- ⭐ Star the repo - Help others discover Flutter MCP
🚀 What’s New & Coming Soon
Recently Released:
- ✅ Simplified Tools: Reduced from 5 tools to just 2 main tools (Context7-style)
- ✅ Smart Detection: Auto-detects Flutter widgets, Dart classes, and pub packages
- ✅ Token Limiting: Default 10,000 tokens with smart truncation
- ✅ Topic Filtering: Focus on specific sections (examples, constructors, etc.)
On our roadmap:
- 📚 Stack Overflow integration for common Flutter questions
- 🎯 Natural language activation: “use flutter docs” pattern
- 🌍 Offline mode for airplane coding
- 🚀 Hosted service option for teams
Want to help build these features? Join us!
❤️ Spread the Word
Help other Flutter developers discover AI superpowers:
Add the badge to your project:
[](https://github.com/flutter-mcp/flutter-mcp)
📄 License
MIT © 2024 Flutter MCP Contributors
🏗️ Built With
- Python MCP SDK - The most popular MCP implementation (14k+ stars)
- FastMCP - High-level Python framework for MCP servers
- SQLite - Built-in caching with zero configuration
- npm/npx - Simple one-line installation and execution
- BeautifulSoup - Robust HTML parsing
- httpx - Modern async HTTP client
Ready to give your AI Flutter superpowers?
Get Started • Report Bug • Request Feature
Made with ❤️ by the Flutter community
安装
npx flutter-mcp配置
{
"mcpServers": {
"flutter-docs": {
"command": "npx",
"args": ["flutter-mcp"]
}
}
}