Skip to content
ProxyWhirl
Getting Started Guides Reference Project
  • Getting Started
    • What You’ll Build
    • Installation
    • Quick Start
      • Basic Usage (sync)
      • Async Usage
      • Context Manager Pattern
      • Authenticated Proxies
      • Using Free Proxy Lists
      • Fetching Proxies Programmatically
    • Choosing a Rotation Strategy
    • Configuring Retry and Circuit Breakers
    • Monitoring Your Pool
    • Troubleshooting
    • Next Steps
    • For Contributors
      • Rotation Strategies
        • Bootstrap a Rotator
        • Decision Matrix
        • Quick-Pick Guide
        • Strategy Reference
        • Comparison At a Glance
        • Hot-Swapping Strategies
        • Observe the Pool
        • Building a Custom Strategy
        • Further Reading
  • Guides
    • Choosing a Guide
    • Client & Concurrency
    • Resilience & Caching
    • Operations & Deployment
    • Automation & AI
    • Troubleshooting
      • Async Client Guide
        • When to Use Async vs Sync
        • Initialization
        • Context Manager Usage
        • HTTP Request Methods
        • Proxy Management
        • Hot-Swapping Strategies
        • Error Handling
        • Concurrent Requests with asyncio.gather
        • Performance Considerations
        • Asyncio Integration Patterns
        • Comparison: Async vs Sync
        • Best Practices and Common Patterns
        • See Also
      • Advanced Rotation Strategies
        • Overview
        • Performance-Based Strategy
        • Session Persistence Strategy
        • Geo-Targeted Strategy
        • Cost-Aware Strategy
        • Composite Strategy
        • Strategy Registry
        • SelectionContext
        • StrategyConfig
        • Custom Strategy Implementation
        • StrategyRegistry Usage
        • Best Practices
        • Troubleshooting
        • Testing Strategies
        • Performance Benchmarks
        • See Also
      • Caching Subsystem Guide
        • Architecture Overview
        • Core Components
        • Credential Encryption
        • TTL and Expiration
        • Health Invalidation
        • Migration from JSONL L2 Cache
        • Cache Warming
        • Performance Tuning
        • CLI Integration
        • Best Practices
        • Example: Complete Cache Setup
        • Troubleshooting
        • See Also
      • Retry & Failover Guide
        • Architecture Overview
        • When to Use Retry vs Failover
        • RetryPolicy Configuration
        • Circuit Breaker Configuration
        • Intelligent Proxy Selection
        • RetryMetrics and Observability
        • RetryExecutor Deep Dive
        • Integration with ProxyWhirl
        • Advanced Patterns
        • Best Practices
        • Troubleshooting
        • Performance Impact
        • See Also
        • Summary
      • Deployment Security & Reverse Proxy Configuration
        • Overview
        • X-Forwarded-For Security
        • Reverse Proxy Configurations
        • ProxyWhirl Configuration
        • Security Checklist
        • Troubleshooting
        • References
      • CLI Reference
        • Installation
        • Global Options
        • Commands
        • Output Formats
        • Configuration File
        • Advanced Usage
        • Troubleshooting
        • Environment Variables
        • Exit Codes
        • See Also
      • Automation & CI/CD Runbook
        • Pre-flight Checks
        • GitHub Actions CI Pipeline
        • Cron-Based Proxy Fetching
        • Docker Deployment
        • Integration Testing Patterns
        • Smoke Tests for Docs Examples
        • Automating Releases
        • DocSearch Credentials
        • CI Stage Summary
        • See Also
      • MCP Server Guide
        • Overview
        • Quick Start
        • The proxywhirl Tool
        • Resources
        • Prompts
        • Authentication
        • Progress Reporting
        • Transport Options
        • Integration with Claude Desktop
        • Programmatic Usage
        • Lifecycle Management
        • Error Handling
        • Best Practices
        • Troubleshooting
        • See Also
      • Troubleshooting Guide
        • Table of Contents
        • Error Codes Reference
        • Common Issues
        • Debugging Tips
        • FAQ
        • Getting Help
        • Environment
        • Logs
        • Expected Behavior
        • Actual Behavior
  • Concepts
    • Rotation Strategies
      • Why a Protocol, Not an Abstract Base Class?
      • The Registry Pattern
      • The 9 Built-In Strategies
        • Simple Selection (Stateless)
        • Adaptive Selection (Stateful)
        • Context-Aware Selection
        • Composition
      • Why record_result()?
      • Thread Safety
      • Further Reading
    • Cache Architecture
      • Why Three Tiers?
        • Alternatives Considered
      • Promotion and Demotion
      • Credential Security Across Tiers
      • Graceful Degradation
      • TTL Management
      • Thread Safety
      • Further Reading
    • Circuit Breakers
      • The Problem
      • Three-State Machine
      • Why Not Just Blacklist?
      • Rolling Time Window
      • Half-Open Gating
      • State Persistence
      • Configuration Tuning
      • Further Reading
    • Proxy Lifecycle
      • The Six Stages
        • 1. Fetch
        • 2. Validate
        • 3. Enrich
        • 4. Rotate
        • 5. Monitor
        • 6. Eject (and Recover)
      • Persistence Across Restarts
      • Data Flow Summary
      • Further Reading
    • Security Model
      • Credential Handling
        • In Memory (Runtime)
        • At Rest (L2/L3 Cache)
        • In Transit (Logs and Errors)
      • SSRF Protection
      • Encryption Architecture
      • ReDoS Protection
      • API Authentication
      • Summary of Defenses
      • Further Reading
  • Reference
    • Quick Lookup
    • API Surfaces
    • Configuration & Error Handling
    • Subsystem APIs
    • Database & Migrations
      • ProxyWhirl REST API Usage Guide
        • Table of Contents
        • Getting Started
        • Authentication
        • Middleware
        • Endpoint Reference
        • Rate Limiting
        • Error Handling
        • Performance Tips
        • Security Best Practices
        • Deployment Examples
        • X-Forwarded-For Security Checklist
        • Security References
        • Troubleshooting
        • See Also
        • Support
      • Python API
        • Rotators
        • Rotation Strategies
        • Models
        • Fetchers and Validators
        • Cache
        • Circuit Breaker and Retry
        • Browser Renderer
        • Utilities
        • Exceptions
        • See Also
      • Configuration Reference
        • Configuration Discovery
        • TOML Configuration Format
        • Environment Variables
        • Configuration Classes
        • Programmatic Configuration
        • Validation Rules
        • Security Best Practices
        • Configuration Examples
        • Migration from Legacy Config
        • Troubleshooting
        • See Also
      • Exceptions Reference
        • Table of Contents
        • Exception Hierarchy
        • ProxyErrorCode Enum
        • Utility Functions
        • Error Codes
        • Exception Reference
        • Error Handling Patterns
        • Best Practices
        • Summary
        • See Also
      • Cache API Reference
        • Overview
        • Data Models
        • Tier Implementations
        • Utilities
        • Usage Examples
        • Performance Considerations
        • Thread Safety
        • Error Handling
        • See Also
      • Rate Limiting API Reference
        • Overview
        • Core Classes
        • Data Models
        • Usage Examples
        • Thread Safety
        • Performance Considerations
        • Integration with Monitoring
        • Sphinx Integration
        • Common Patterns
        • FAQ
        • See Also
      • Database Migrations Guide
        • Overview
        • Quick Start
        • Migration API Reference
        • Creating New Migrations
        • Best Practices
        • Application Integration
        • Troubleshooting
        • Directory Structure
        • Configuration
        • See Also
  • Project
    • Development Setup
      • Prerequisites
      • Clone & Install
      • Verify Installation
      • Make Commands
    • Contributing
      • Workflow
      • Branch Naming
      • Commit Convention
      • Code Style
      • Pre-commit Hooks
      • Testing Guidelines
      • Extending with Custom Strategies
    • CI/CD Pipelines
      • Quality Gate Pipeline
    • Architecture
      • Module Map
      • Key Exports
    • Environment Variables
    • Current Health
    • Changelog Highlights
      • Recent
      • Phase Completion Status
    • License
      • Changelog
        • Unreleased
        • 0.3.0 (2026-02-16)
        • 0.1.2 (2026-02-14)
        • 0.1.1 (2026-01-14)
        • 0.1.0 (2026-01-10)
  • API Reference
    • proxywhirl
      • Submodules
        • proxywhirl.api
        • proxywhirl.browser
        • proxywhirl.cache
        • proxywhirl.circuit_breaker
        • proxywhirl.cli
        • proxywhirl.config
        • proxywhirl.enrichment
        • proxywhirl.exceptions
        • proxywhirl.exports
        • proxywhirl.fetchers
        • proxywhirl.geo
        • proxywhirl.logging_config
        • proxywhirl.mcp
        • proxywhirl.metrics_collector
        • proxywhirl.migrations
        • proxywhirl.models
        • proxywhirl.premium_sources
        • proxywhirl.rate_limiting
        • proxywhirl.retry
        • proxywhirl.rotator
        • proxywhirl.rwlock
        • proxywhirl.safe_regex
        • proxywhirl.sources
        • proxywhirl.storage
        • proxywhirl.strategies
        • proxywhirl.tui
        • proxywhirl.utils

On this page

  • Submodules
  1. ProxyWhirl /
  2. API Reference /
  3. proxywhirl /
  4. proxywhirl.mcp
View Source Open in ChatGPT Open in Claude

proxywhirl.mcp¶

Model Context Protocol server for ProxyWhirl.

Submodules¶

  • proxywhirl.mcp.auth
  • proxywhirl.mcp.server
Previous
proxywhirl.logging_config
Next
proxywhirl.mcp.auth

2026, Wyatt Walsh

Made with Shibuya theme.