Skip to content

Commit 080c5e6

Browse files
committed
update docs
1 parent a46dcd5 commit 080c5e6

File tree

3 files changed

+0
-257
lines changed

3 files changed

+0
-257
lines changed

docs/advanced_features.md

Lines changed: 0 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -179,57 +179,6 @@ export MCPM_DEBUG=1
179179
export MCPM_REGISTRY_URL="https://custom-registry.example.com"
180180
```
181181

182-
## Advanced Workflows
183-
184-
### Development Workflow
185-
186-
```bash
187-
# 1. Create development profile
188-
mcpm profile create dev-setup
189-
mcpm profile edit dev-setup
190-
191-
# 2. Test locally
192-
mcpm profile run dev-setup --http --port 8080
193-
194-
# 3. Share for collaboration
195-
mcpm profile share dev-setup --auth
196-
197-
# 4. Configure in clients
198-
mcpm client edit claude-desktop # Select dev-setup profile
199-
```
200-
201-
### Production Deployment
202-
203-
```bash
204-
# 1. Install production servers
205-
mcpm install production-server-1
206-
mcpm install production-server-2
207-
208-
# 2. Create production profile
209-
mcpm profile create production
210-
mcpm profile edit production
211-
212-
# 3. Configure monitoring
213-
mcpm usage --profile production --export metrics.json
214-
215-
# 4. Health checks
216-
mcpm doctor --profile production
217-
```
218-
219-
### Client Migration
220-
221-
```bash
222-
# 1. Import from old client
223-
mcpm client import old-client
224-
225-
# 2. Organize into profiles
226-
mcpm profile create imported-servers
227-
mcpm profile edit imported-servers
228-
229-
# 3. Configure new client
230-
mcpm client edit new-client
231-
```
232-
233182
## Performance Optimization
234183

235184
### Server Caching

docs/custom-server-config-explained.md

Lines changed: 0 additions & 132 deletions
This file was deleted.

docs/router_tech_design.md

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -187,23 +187,6 @@ mcpm profile run web-dev --http --port 8080
187187
- **Memory Efficiency**: No persistent router process
188188
- **Connection Pooling**: FastMCP manages connections efficiently
189189

190-
## Migration from v1 Router
191-
192-
### v1 Router System (Deprecated)
193-
```python
194-
# v1 had a persistent router daemon
195-
router = MCPRouter()
196-
await router.add_server("server1", config)
197-
await router.start_remote_server()
198-
```
199-
200-
### v2 Direct Execution
201-
```python
202-
# v2 uses direct execution via FastMCP
203-
# No persistent router needed
204-
# Servers run on-demand
205-
```
206-
207190
## Security Model
208191

209192
### Process Isolation
@@ -221,61 +204,4 @@ await router.start_remote_server()
221204
- Configurable tunnel endpoints
222205
- Optional authentication for public shares
223206

224-
## Troubleshooting
225-
226-
### Common Issues
227-
228-
**Server not starting**
229-
- Check server configuration: `mcpm ls`
230-
- Test server directly: `mcpm run server-name`
231-
- Verify dependencies: `mcpm doctor`
232-
233-
**Profile aggregation issues**
234-
- Ensure all servers in profile work: `mcpm profile inspect profile-name`
235-
- Check for naming conflicts between servers
236-
- Verify FastMCP compatibility
237-
238-
**Client integration problems**
239-
- Confirm client is detected: `mcpm client ls`
240-
- Check client configuration permissions
241-
- Verify server compatibility with client
242-
243-
### Debugging Tools
244-
245-
```bash
246-
# System health check
247-
mcpm doctor
248-
249-
# Server inspection
250-
mcpm inspect server-name
251-
252-
# Profile testing
253-
mcpm profile run profile-name --http --port 8080
254-
255-
# Usage analytics
256-
mcpm usage
257-
```
258-
259-
## Development
260-
261-
### Local Development
262-
263-
```bash
264-
# Install in development mode
265-
uv pip install -e .
266-
267-
# Run tests
268-
pytest tests/
269-
270-
# Test CLI directly
271-
python -m src.mcpm.cli --help
272-
```
273-
274-
### Extension Points
275-
276-
- **Custom Server Types**: Extend server configuration schemas
277-
- **Client Integrations**: Add support for new MCP clients
278-
- **Transport Layers**: Implement custom communication protocols
279-
- **Analytics**: Extend usage monitoring capabilities
280-
281207
For more technical details, see the source code documentation and inline comments.

0 commit comments

Comments
 (0)