@physics91/openrouter-mcp/docs/INDEX.md

A Model Context Protocol (MCP) server for OpenRouter API with Collective Intelligence - Multi-model consensus, ensemble reasoning, and collaborative problem solving

# OpenRouter MCP Server Documentation Index

Welcome to the OpenRouter MCP Server documentation. This index provides a structured overview of all available documentation to help you quickly find the information you need.

## 📚 Documentation Overview

### Getting Started
Essential guides for new users to quickly set up and start using the OpenRouter MCP Server.

| Document | Description | Last Updated |
|----------|-------------|--------------|
| [README](../README.md) | Project overview, quick start, and main features | 2025-01-12 |
| [Installation Guide](INSTALLATION.md) | Detailed installation and setup instructions | 2025-01-12 |
| [Claude Desktop Guide](CLAUDE_DESKTOP_GUIDE.md) | Integration with Claude Desktop application | 2025-01-12 |
| [Claude Code CLI Guide](CLAUDE_CODE_GUIDE.md) | Terminal workflow with Claude Code CLI | 2025-01-12 |

### API Reference
Complete API documentation for developers.

| Document | Description | Last Updated |
|----------|-------------|--------------|
| [API Documentation](API.md) | Comprehensive API reference for all MCP tools | 2025-01-12 |
| [Model Metadata Guide](METADATA_GUIDE.md) | Enhanced metadata system and filtering | 2025-01-12 |
| [Model Caching](MODEL_CACHING.md) | Intelligent caching system documentation | 2025-01-12 |

### Features & Capabilities
In-depth guides for specific features.

| Document | Description | Last Updated |
|----------|-------------|--------------|
| [Multimodal/Vision Guide](MULTIMODAL_GUIDE.md) | Using vision-capable models for image analysis | 2025-01-12 |
| [Benchmarking Guide](BENCHMARK_GUIDE.md) | Model performance comparison and analysis | 2025-01-12 |

### Development
Resources for contributors and developers.

| Document | Description | Last Updated |
|----------|-------------|--------------|
| [Contributing Guide](../CONTRIBUTING.md) | Development setup and contribution guidelines | 2025-01-12 |
| [Architecture Overview](ARCHITECTURE.md) | System design and technical architecture | 2025-01-12 |
| [Testing Guide](TESTING.md) | Test suite documentation and TDD practices | 2025-01-12 |

### Support
Help and troubleshooting resources.

| Document | Description | Last Updated |
|----------|-------------|--------------|
| [Troubleshooting Guide](TROUBLESHOOTING.md) | Common issues and solutions | 2025-01-12 |
| [FAQ](FAQ.md) | Frequently asked questions | 2025-01-12 |

## 🗺️ Quick Navigation Map

```
For New Users:
1. Start with README.md for overview
2. Follow INSTALLATION.md for setup
3. Choose integration guide (Claude Desktop or Code CLI)
4. Try examples in examples/ folder

For API Users:
1. Review API.md for tool reference
2. Check specific feature guides (Multimodal, Benchmarking)
3. Understand METADATA_GUIDE.md for filtering

For Contributors:
1. Read CONTRIBUTING.md first
2. Understand ARCHITECTURE.md
3. Follow TESTING.md for TDD practices
4. Submit PRs with proper documentation
```

## 📊 Documentation Statistics

- **Total Documents**: 14
- **Total Examples**: 2 (Python scripts)
- **API Tools Documented**: 7
- **Supported Models**: 200+
- **Test Coverage**: Comprehensive (TDD)

## 🔍 Search Keywords

### By Feature
- **Vision/Images**: MULTIMODAL_GUIDE.md
- **Performance Testing**: BENCHMARK_GUIDE.md
- **Model Selection**: METADATA_GUIDE.md
- **Caching**: MODEL_CACHING.md

### By Integration
- **Desktop App**: CLAUDE_DESKTOP_GUIDE.md
- **Terminal/CLI**: CLAUDE_CODE_GUIDE.md
- **Python API**: API.md, examples/

### By Task
- **Setup**: INSTALLATION.md
- **Development**: CONTRIBUTING.md, ARCHITECTURE.md
- **Testing**: TESTING.md, BENCHMARK_GUIDE.md
- **Debugging**: TROUBLESHOOTING.md, FAQ.md

## 📝 Documentation Standards

All documentation follows these standards:
- **Format**: Markdown with proper headers
- **Code Examples**: Syntax highlighted with language tags
- **Tables**: Used for structured data
- **Links**: Relative paths for internal docs
- **Updates**: Last updated date in header
- **Language**: Clear, concise technical writing

## 🔄 Version History

| Version | Date | Major Documentation Changes |
|---------|------|----------------------------|
| 1.0.0 | 2025-01-12 | Initial documentation structure |
| 1.0.1 | 2025-01-12 | Added INDEX.md and reorganized docs |

---

**Need help finding something?** Open an issue on GitHub or check the [FAQ](FAQ.md).