mirror of
https://github.com/samanhappy/mcphub.git
synced 2025-12-24 02:39:19 -05:00
refine docs
This commit is contained in:
@@ -30,9 +30,6 @@ Groups are named collections of MCP servers that can be accessed through dedicat
|
||||
3. **Fill Group Details**:
|
||||
|
||||
- **Name**: Unique identifier for the group
|
||||
- **Display Name**: Human-readable name
|
||||
- **Description**: Purpose and contents of the group
|
||||
- **Access Level**: Public, Private, or Restricted
|
||||
|
||||
4. **Add Servers**: Select servers to include in the group
|
||||
|
||||
@@ -46,14 +43,11 @@ curl -X POST http://localhost:3000/api/groups \
|
||||
-H "Authorization: Bearer YOUR_JWT_TOKEN" \
|
||||
-d '{
|
||||
"name": "web-automation",
|
||||
"displayName": "Web Automation Tools",
|
||||
"description": "Browser automation and web scraping tools",
|
||||
"servers": ["playwright", "fetch"],
|
||||
"accessLevel": "public"
|
||||
"servers": ["playwright", "fetch"]
|
||||
}'
|
||||
```
|
||||
|
||||
### Via Configuration File
|
||||
{/* ### Via Configuration File
|
||||
|
||||
Define groups in your `mcp_settings.json`:
|
||||
|
||||
@@ -66,20 +60,16 @@ Define groups in your `mcp_settings.json`:
|
||||
},
|
||||
"groups": {
|
||||
"web-tools": {
|
||||
"displayName": "Web Tools",
|
||||
"description": "Web scraping and browser automation",
|
||||
"name": "web",
|
||||
"servers": ["fetch", "playwright"],
|
||||
"accessLevel": "public"
|
||||
},
|
||||
"communication": {
|
||||
"displayName": "Communication Tools",
|
||||
"description": "Messaging and collaboration tools",
|
||||
"name": "communication",
|
||||
"servers": ["slack"],
|
||||
"accessLevel": "private"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Group Types and Use Cases
|
||||
|
||||
@@ -177,7 +167,7 @@ Define groups in your `mcp_settings.json`:
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
|
||||
## Group Access Control
|
||||
{/* ## Group Access Control
|
||||
|
||||
### Access Levels
|
||||
|
||||
@@ -254,7 +244,7 @@ curl -X DELETE http://localhost:3000/api/groups/web-tools/members/user123 \
|
||||
# List group members
|
||||
curl http://localhost:3000/api/groups/web-tools/members \
|
||||
-H "Authorization: Bearer YOUR_JWT_TOKEN"
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Group Endpoints
|
||||
|
||||
@@ -346,7 +336,7 @@ Response will only include tools from `fetch` and `playwright` servers.
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
### Batch Server Updates
|
||||
{/* ### Batch Server Updates
|
||||
|
||||
Update multiple servers at once:
|
||||
|
||||
@@ -357,9 +347,9 @@ curl -X PUT http://localhost:3000/api/groups/web-tools/servers \
|
||||
-d '{
|
||||
"servers": ["fetch", "playwright", "selenium"]
|
||||
}'
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Group Monitoring
|
||||
{/* ## Group Monitoring
|
||||
|
||||
### Group Status
|
||||
|
||||
@@ -393,9 +383,9 @@ Metrics include:
|
||||
- Request count by tool
|
||||
- Response times
|
||||
- Error rates
|
||||
- User activity
|
||||
- User activity */}
|
||||
|
||||
## Advanced Group Features
|
||||
{/* ## Advanced Group Features
|
||||
|
||||
### Nested Groups
|
||||
|
||||
@@ -474,7 +464,7 @@ Define policies for group behavior:
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Best Practices
|
||||
|
||||
@@ -494,7 +484,7 @@ Define policies for group behavior:
|
||||
**Use Descriptive Names**: Choose names that clearly indicate the group's purpose and contents.
|
||||
</Tip>
|
||||
|
||||
### Security Considerations
|
||||
{/* ### Security Considerations
|
||||
|
||||
<Warning>
|
||||
**Principle of Least Privilege**: Only give users access to groups they actually need.
|
||||
@@ -507,7 +497,7 @@ Define policies for group behavior:
|
||||
|
||||
<Warning>
|
||||
**Regular Access Reviews**: Periodically review group memberships and remove unnecessary access.
|
||||
</Warning>
|
||||
</Warning> */}
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
|
||||
@@ -311,7 +311,7 @@ Servers can use environment variables for configuration:
|
||||
- `${VAR_NAME:-default}`: Uses default if variable not set
|
||||
- `${VAR_NAME:+value}`: Uses value if variable is set
|
||||
|
||||
### Working Directory
|
||||
{/* ### Working Directory
|
||||
|
||||
Set the working directory for server execution:
|
||||
|
||||
@@ -323,7 +323,7 @@ Set the working directory for server execution:
|
||||
"cwd": "/path/to/server/directory"
|
||||
}
|
||||
}
|
||||
```
|
||||
``` */}
|
||||
|
||||
### Command Variations
|
||||
|
||||
@@ -352,7 +352,7 @@ Different ways to specify server commands:
|
||||
```
|
||||
</Tab>
|
||||
|
||||
<Tab title="Direct Python">
|
||||
{/* <Tab title="Direct Python">
|
||||
```json
|
||||
{
|
||||
"direct-python": {
|
||||
@@ -373,7 +373,7 @@ Different ways to specify server commands:
|
||||
}
|
||||
}
|
||||
```
|
||||
</Tab>
|
||||
</Tab> */}
|
||||
</Tabs>
|
||||
|
||||
## Advanced Features
|
||||
@@ -382,12 +382,12 @@ Different ways to specify server commands:
|
||||
|
||||
MCPHub supports hot reloading of server configurations:
|
||||
|
||||
1. **Config File Changes**: Automatically detects changes to `mcp_settings.json`
|
||||
2. **Dashboard Updates**: Immediately applies changes made through the web interface
|
||||
3. **API Updates**: Real-time updates via REST API calls
|
||||
4. **Zero Downtime**: Graceful server restarts without affecting other servers
|
||||
{/* 1. **Config File Changes**: Automatically detects changes to `mcp_settings.json` */}
|
||||
1. **Dashboard Updates**: Immediately applies changes made through the web interface
|
||||
2. **API Updates**: Real-time updates via REST API calls
|
||||
3. **Zero Downtime**: Graceful server restarts without affecting other servers
|
||||
|
||||
### Resource Limits
|
||||
{/* ### Resource Limits
|
||||
|
||||
Control server resource usage:
|
||||
|
||||
@@ -403,9 +403,9 @@ Control server resource usage:
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
``` */}
|
||||
|
||||
### Dependency Management
|
||||
{/* ### Dependency Management
|
||||
|
||||
Handle server dependencies:
|
||||
|
||||
@@ -439,7 +439,7 @@ Handle server dependencies:
|
||||
```
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
</AccordionGroup> */}
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ Smart Routing requires additional setup compared to basic MCPHub usage:
|
||||
2. **Embedding Service**: OpenAI API or compatible service
|
||||
3. **Environment Configuration**: Proper configuration variables
|
||||
|
||||
### Quick Setup
|
||||
{/* ### Quick Setup
|
||||
|
||||
<Tabs>
|
||||
<Tab title="Docker Compose">
|
||||
@@ -265,7 +265,7 @@ EMBEDDING_BATCH_SIZE=100
|
||||
```
|
||||
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
</AccordionGroup> */}
|
||||
|
||||
## Using Smart Routing
|
||||
|
||||
@@ -287,7 +287,7 @@ Access Smart Routing through the special `$smart` endpoint:
|
||||
</Tab>
|
||||
</Tabs>
|
||||
|
||||
### Basic Usage
|
||||
{/* ### Basic Usage
|
||||
|
||||
Connect your AI client to the Smart Routing endpoint and make natural language requests:
|
||||
|
||||
@@ -330,9 +330,9 @@ Response:
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
``` */}
|
||||
|
||||
### Advanced Queries
|
||||
{/* ### Advanced Queries
|
||||
|
||||
Smart Routing supports various query types:
|
||||
|
||||
@@ -405,9 +405,9 @@ Smart Routing supports various query types:
|
||||
}'
|
||||
```
|
||||
</Accordion>
|
||||
</AccordionGroup>
|
||||
</AccordionGroup> */}
|
||||
|
||||
### Tool Execution
|
||||
{/* ### Tool Execution
|
||||
|
||||
Once Smart Routing finds relevant tools, you can execute them directly:
|
||||
|
||||
@@ -426,9 +426,9 @@ curl -X POST http://localhost:3000/mcp/$smart \
|
||||
}
|
||||
}
|
||||
}'
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Performance Optimization
|
||||
{/* ## Performance Optimization
|
||||
|
||||
### Embedding Cache
|
||||
|
||||
@@ -585,7 +585,7 @@ curl -X POST http://localhost:3000/api/smart-routing/feedback \
|
||||
"successful": true,
|
||||
"comments": "Perfect tool for the task"
|
||||
}'
|
||||
```
|
||||
``` */}
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
|
||||
Reference in New Issue
Block a user