# AIPaper-assisant Documentation

Welcome to the comprehensive documentation for AIPaper-assisant, a sophisticated Node.js Model Context Protocol (MCP) server for searching and downloading academic papers from multiple sources.

## 📚 Documentation Index

### 📋 Core Documentation
1. **[Project Documentation](PROJECT_DOCUMENTATION.md)** - Complete project overview, architecture, and features
2. **[User Guide](USER_GUIDE.md)** - Step-by-step guide for users, including setup and usage examples
3. **[Platform API Documentation](PLATFORM_API_DOCUMENTATION.md)** - Detailed API specifications for all 14+ integrated platforms
4. **[Architecture & Design Patterns](ARCHITECTURE_DESIGN_PATTERNS.md)** - System architecture and design pattern explanations
5. **[Testing & Development Workflow](TESTING_DEVELOPMENT_WORKFLOW.md)** - Testing strategies and development processes

### 🎯 Quick Links
- [Quick Start Guide](USER_GUIDE.md#-quick-start)
- [Platform Capabilities](PROJECT_DOCUMENTATION.md#-platform-support-matrix)
- [API Reference](PLATFORM_API_DOCUMENTATION.md#-core-tools)
- [Architecture Overview](ARCHITECTURE_DESIGN_PATTERNS.md#-system-architecture-overview)
- [Contributing Guidelines](TESTING_DEVELOPMENT_WORKFLOW.md#-development-workflow)

### 🚀 Getting Started

1. **New Users**: Start with the [User Guide](USER_GUIDE.md)
2. **Developers**: Check [Architecture Documentation](ARCHITECTURE_DESIGN_PATTERNS.md)
3. **Integrators**: Review [Platform API Documentation](PLATFORM_API_DOCUMENTATION.md)
4. **Contributors**: Read [Testing & Development Workflow](TESTING_DEVELOPMENT_WORKFLOW.md)

### 📊 Project Highlights

- **14+ Academic Platforms**: arXiv, Web of Science, PubMed, Google Scholar, Sci-Hub, ScienceDirect, Springer, Wiley, Scopus, Crossref, and more
- **Unified Interface**: Single API for all platforms
- **Enterprise Features**: Rate limiting, robust error handling, comprehensive testing
- **MCP Integration**: Native Claude Desktop support
- **TypeScript**: Full type safety and modern development experience
- **Extensible**: Easy to add new platforms following established patterns

### 🔧 Key Features

- **Smart Search**: Intelligent query handling across platforms
- **Rate Limiting**: Respectful API usage with automatic throttling
- **Error Recovery**: Graceful handling of failures with fallbacks
- **PDF Downloads**: Direct access to papers where available
- **Citation Tracking**: Find highly cited papers and references
- **Multi-language**: Support for various academic databases globally

### 📖 Documentation Philosophy

Our documentation follows these principles:
- **Complete**: Every aspect of the system is documented
- **Clear**: Easy to understand with examples and diagrams
- **Current**: Updated with each release
- **Accessible**: Multiple entry points for different audiences
- **Practical**: Focus on real-world usage scenarios

### 🔄 Maintenance

This documentation is:
- Automatically generated and updated
- Version controlled with the codebase
- Reviewed for accuracy with each release
- Open to community contributions

---

For questions, issues, or contributions, please refer to the specific documentation file or visit our repository.

*Last updated: $(date)*