# Documentation Index

Welcome to the MCP-RLM Proxy Server documentation. This directory contains comprehensive documentation for the project.

## Documentation Files

### [Architecture Documentation](ARCHITECTURE.md)
System architecture, component design, data flow, and technical implementation details.

**Topics covered:**
- Core modules and components
- Data flow and request processing
- Connection management
- Tool aggregation
- Transformation pipeline
- Error handling
- Performance considerations

### [Logging Documentation](LOGGING.md)
Complete guide to the structured logging system.

**Topics covered:**
- Logging configuration
- Log levels and usage
- Environment variables
- Module-specific loggers
- Best practices
- Troubleshooting
- Integration with monitoring tools

### [Performance Documentation](PERFORMANCE.md)
Performance characteristics, optimizations, and benchmarking.

**Topics covered:**
- Performance optimizations
- Parallel tool discovery
- Tool caching
- Latency and throughput metrics
- Best practices
- Performance testing
- Monitoring and troubleshooting

### [Configuration Documentation](CONFIGURATION.md)
Complete guide to configuration files, validation, and best practices.

### [Quick Reference Guide](QUICK_REFERENCE.md)
Quick reference for common operations and configurations.

**Topics covered:**
- Logging commands
- Configuration examples
- Tool naming conventions
- Projection and grep syntax
- Troubleshooting tips
- File locations

## Getting Started

1. **New to the project?** Start with the [main README](../README.md)
2. **Want to understand the system?** Read [Architecture Documentation](ARCHITECTURE.md)
3. **Configuring servers?** See [Configuration Documentation](CONFIGURATION.md)
4. **Need to configure logging?** See [Logging Documentation](LOGGING.md)
5. **Optimizing performance?** Check [Performance Documentation](PERFORMANCE.md)
6. **Quick lookup?** Use [Quick Reference Guide](QUICK_REFERENCE.md)

## Documentation Standards

All documentation follows these standards:
- **Markdown format** for easy reading and editing
- **Code examples** with syntax highlighting
- **Clear structure** with headings and sections
- **Practical examples** for common use cases
- **Troubleshooting sections** for common issues

## Contributing to Documentation

When adding new features:
1. Update the relevant documentation file
2. Add examples to the Quick Reference Guide
3. Update the CHANGELOG.md
4. Ensure code examples are tested

## External Resources

- [MCP Protocol Specification](https://modelcontextprotocol.io)
- [MCP Python SDK](https://github.com/modelcontextprotocol/python-sdk)
- [GitHub Issue #1709 - Field Projection Discussion](https://github.com/modelcontextprotocol/servers/issues/1709)

