yijun-lee commited on
Commit
87c5d76
Β·
verified Β·
1 Parent(s): eca2420

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +65 -1
README.md CHANGED
@@ -13,4 +13,68 @@ short_description: Your Gateway to Optimal MCP Servers in Seconds
13
  license: mit
14
  ---
15
 
16
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
13
  license: mit
14
  ---
15
 
16
+ # Router MCP
17
+
18
+ Router MCP is a powerful tool that helps you discover and connect to MCP servers. Whether you're looking for specific functionality or exploring new possibilities, Router MCP makes it easy to find the perfect MCP server for your needs.
19
+
20
+ ## πŸŽ₯ Demo
21
+
22
+ Check out our [demo video](demo.mp4) to see Router MCP in action.
23
+
24
+ ## 🎯 How to Use Router MCP
25
+
26
+ 1. **Enter Your Query**
27
+ - Type a natural language description of the MCP Server you're looking for
28
+ - Be as specific or general as you need
29
+
30
+ 2. **Select Search Sources**
31
+ - Choose where to search for MCP Servers
32
+ - Currently supports Hugging Face Spaces and Smithery
33
+ - Note: Anthropic's Registry is under development and not yet available
34
+
35
+ 3. **Choose Your OS**
36
+ - Select your operating system (Mac/Linux, Windows, or WSL)
37
+ - This ensures you get the correct configuration format for your system
38
+
39
+ 4. **Choose Search Type**
40
+ - **Keyword Search**: Use when you have specific terms or names in mind
41
+ - **Semantic Search**: Use when you want to find servers based on meaning and intent
42
+ - Both methods will return ready-to-use MCP configurations
43
+
44
+ ## πŸ“Š Understanding Search Results
45
+
46
+ The search results will show MCP Servers from different sources, each with their own format:
47
+
48
+ ### Hugging Face Spaces Results
49
+ - **id**: The Space's unique identifier
50
+ - **likes**: Number of likes the Space has received
51
+ - **trending_score**: The Space's popularity score
52
+ - **source**: Always "huggingface"
53
+ - **configuration**: Ready-to-use MCP configuration for SSE connection
54
+
55
+ ### Smithery Results
56
+ - **id**: The server's qualified name (e.g., "author/server-name")
57
+ - **name**: Display name of the server
58
+ - **description**: Detailed description of the server's capabilities
59
+ - **likes**: Number of times the server has been used
60
+ - **source**: Always "smithery"
61
+ - **configuration**: OS-specific MCP configuration (requires your Smithery key)
62
+
63
+ > Note: For Smithery servers, you'll need to replace "YOUR_SMITHERY_KEY" in the configuration with your actual Smithery API key.
64
+
65
+ > Note: When using Semantic Search, each result includes a similarity score (0-1) that indicates how well the server matches your query's meaning. Higher scores (closer to 1) indicate better semantic matches.
66
+
67
+ ## πŸš€ Upcoming Features
68
+
69
+ We're constantly working to improve Router MCP. Here's what's coming soon:
70
+
71
+ ### πŸ”„ Enhanced Integration
72
+ - Integration with Anthropic's Registry for comprehensive MCP server discovery
73
+ - Complete support for Smithery search capabilities
74
+ - Enhanced server discovery with improved filtering and sorting options
75
+
76
+ ### ⚑️ Automated Setup
77
+ - One-click MCP server addition to your client
78
+ - Automatic configuration generation and validation
79
+ - Seamless integration with popular MCP clients
80
+