Improved docs

This commit is contained in:
Fahad
2025-06-17 12:20:52 +04:00
parent aec218a5ef
commit 863abf1a9f
15 changed files with 2151 additions and 391 deletions

127
docs/tools/version.md Normal file
View File

@@ -0,0 +1,127 @@
# Version Tool - Server Information
**Get server version, configuration details, and list of available tools**
The `version` tool provides information about the Zen MCP Server version, configuration details, and system capabilities. This is useful for debugging, understanding server capabilities, and verifying your installation.
## Usage
```
"Get zen to show its version"
```
## Key Features
- **Server version information**: Current version and build details
- **Configuration overview**: Active settings and capabilities
- **Tool inventory**: Complete list of available tools and their status
- **System health**: Basic server status and connectivity verification
- **Debug information**: Helpful details for troubleshooting
## Output Information
The tool provides:
**Version Details:**
- Server version number
- Build timestamp and commit information
- MCP protocol version compatibility
- Python runtime version
**Configuration Summary:**
- Active providers and their status
- Default model configuration
- Feature flags and settings
- Environment configuration overview
**Tool Availability:**
- Complete list of available tools
- Tool version information
- Capability status for each tool
**System Information:**
- Server uptime and status
- Memory and resource usage (if available)
- Connection status with Redis (for conversation memory)
- Docker container information
## Example Output
```
🔧 Zen MCP Server Information
📋 Version: 2.15.0
🏗️ Build: 2024-01-15T10:30:00Z (commit: abc123f)
🔌 MCP Protocol: 1.0.0
🐍 Python Runtime: 3.11.7
⚙️ Configuration:
• Default Model: auto
• Providers: Google ✅, OpenAI ✅, Custom ✅
• Conversation Memory: Redis ✅
• Web Search: Enabled
🛠️ Available Tools (12):
• chat - General development chat & collaborative thinking
• thinkdeep - Extended reasoning partner
• consensus - Multi-model perspective gathering
• codereview - Professional code review
• precommit - Pre-commit validation
• debug - Expert debugging assistant
• analyze - Smart file analysis
• refactor - Intelligent code refactoring
• tracer - Static code analysis prompt generator
• testgen - Comprehensive test generation
• listmodels - List available models
• version - Server information
🔍 System Status:
• Server Uptime: 2h 35m
• Redis Connection: Active
• Docker Container: zen-mcp-server (running)
```
## When to Use Version Tool
- **Troubleshooting**: When experiencing issues with the server or tools
- **Configuration verification**: To confirm your setup is correct
- **Support requests**: To provide system information when asking for help
- **Update checking**: To verify you're running the latest version
- **Capability discovery**: To understand what features are available
## Debug Information
The version tool can help diagnose common issues:
**Connection Problems:**
- Verify server is running and responsive
- Check MCP protocol compatibility
- Confirm tool availability
**Configuration Issues:**
- Validate provider setup
- Check API key configuration status
- Verify feature enablement
**Performance Troubleshooting:**
- Server uptime and stability
- Resource usage patterns
- Redis connection health
## Tool Parameters
This tool requires no parameters - it provides comprehensive server information automatically.
## Best Practices
- **Include in bug reports**: Always include version output when reporting issues
- **Check after updates**: Verify version information after server updates
- **Monitor system health**: Use periodically to check server status
- **Validate configuration**: Confirm settings match your expectations
## When to Use Version vs Other Tools
- **Use `version`** for: Server diagnostics, configuration verification, troubleshooting
- **Use `listmodels`** for: Model availability and capability information
- **Use other tools** for: Actual development and analysis tasks
- **Use with support**: Essential information for getting help with issues