Skip to main content

Model Context Protocol (MCP) wrapper for ChatAds Affiliate API with async support

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

ChatAds MCP Wrapper

Python 3.10+ License: MIT Code style: black Ruff Checked with mypy

This directory houses the Model Context Protocol (MCP) wrapper that exposes the ChatAds Affiliate API to Claude (or any MCP-aware client). The wrapper normalizes responses, hides backend-specific errors, and provides consistent metadata so Claude always receives a predictable envelope.

Requirements

  • Python 3.10+
  • uv or standard pip
  • Environment variables:
    • CHATADS_API_KEY – your ChatAds API key (required)
    • Optional overrides:
      • CHATADS_API_BASE_URL (default: Modal deployment URL)
      • CHATADS_API_ENDPOINT (default: /v1/chatads/messages)
      • CHATADS_MCP_TIMEOUT (default: 15 seconds)
      • CHATADS_MCP_MAX_RETRIES (default: 3)
      • CHATADS_MCP_BACKOFF (default: 0.6 seconds)
      • CHATADS_MAX_REQUEST_SIZE (default: 10240 bytes / 10KB)
      • CHATADS_CIRCUIT_BREAKER_THRESHOLD (default: 5 failures before opening)
      • CHATADS_CIRCUIT_BREAKER_TIMEOUT (default: 60 seconds)
      • CHATADS_QUOTA_WARNING_THRESHOLD (default: 0.9 / 90%)
      • LOGLEVEL (default: INFO, options: DEBUG, INFO, WARNING, ERROR)
      • CHATADS_LOG_FORMAT (default: text, options: text, json)

Installation

From PyPI (recommended)

pip install chatads-mcp-wrapper

From source (development)

git clone https://github.com/chatads/chatads-mcp-wrapper.git
cd chatads-mcp-wrapper
python3 -m venv .venv && source .venv/bin/activate
pip install -r requirements-dev.txt

Set your API key:

export CHATADS_API_KEY=sk_live_...

Running the MCP Server

chatads-mcp
# or: python -m chatads_mcp_wrapper

The server provides two MCP tools:

  • chatads_affiliate_lookup - Main tool for fetching affiliate recommendations
  • chatads_health_check - Health check tool for API status verification

Claude Desktop integration

Add a server entry to claude_desktop_config.json (path varies per OS):

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json Linux: ~/.config/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "chatads-affiliate": {
      "command": "chatads-mcp",
      "args": [],
      "env": {
        "CHATADS_API_KEY": "sk_live_your_key_here"
      }
    }
  }
}

Restart Claude Desktop and the tool will be available.

Tool Signature

chatads_affiliate_lookup(
    message: str,
    ip?: str,
    user_agent?: str,
    country?: str,
    language?: str,
    api_key?: str
) -> {
    status: "success" | "no_match" | "error",
    matched: bool,
    product?: str,
    affiliate_link?: str,
    category?: str,
    affiliate_message?: str,
    reason?: str,
    error_code?: str,
    error_message?: str,
    metadata: {
        request_id: str,
        timestamp: str,
        latency_ms: float,
        status_code: int,
        source: str,
        country?: str,
        language?: str,
        usage_summary?: {...},
        notes?: str
    }
}

Features

Circuit Breaker

Prevents retry storms when the API is experiencing issues. After N consecutive failures (default: 5), the circuit breaker "opens" and fails fast for a cooldown period (default: 60 seconds) instead of wasting resources.

States:

  • CLOSED: Normal operation
  • OPEN: Failing fast, not attempting requests
  • HALF_OPEN: Testing if service recovered

Configuration:

export CHATADS_CIRCUIT_BREAKER_THRESHOLD=5
export CHATADS_CIRCUIT_BREAKER_TIMEOUT=60

Health Check Tool

Use chatads_health_check() to verify API connectivity without consuming quota:

result = chatads_health_check()
# Returns: status (healthy/degraded/unhealthy), latency, circuit breaker state

Useful for:

  • Deployment verification
  • Monitoring dashboards
  • Pre-flight checks

Quota Warnings

The wrapper automatically checks usage metadata and warns when approaching limits:

  • Monthly quota < 10 requests remaining
  • Daily quota ≥ 90% used (configurable via CHATADS_QUOTA_WARNING_THRESHOLD)
  • Minute quota near limit

Warnings appear in metadata.notes and logs. No client-side state management needed - uses real-time data from backend.

Monitoring Hooks

Integrate with your monitoring system:

from chatads_mcp_wrapper import set_metric_callback
import datadog

# Configure callback for metrics
set_metric_callback(datadog.statsd.gauge)

Emitted metrics:

  • chatads.request.latency_ms - Request latency
  • chatads.circuit_breaker.state_change - Circuit breaker transitions

Best Practices

  • Validate prompts: ensure message is non-empty and under 100 words to avoid upstream validation errors.
  • Monitor quota warnings: Check metadata.notes for quota warnings to avoid hitting limits.
  • Use health checks: Verify API availability before critical operations.
  • Honor circuit breaker: When circuit is open, wait for cooldown period before retrying.
  • Log metadata: persist metadata.request_id and metadata.usage_summary for debugging and analytics.
  • Handle no_match: treat status="no_match" as a graceful fallback—use reason to explain why no ad was returned.
  • Override cautiously: only pass country/language when you have high-confidence signals; otherwise let ChatAds infer them.
  • Secure API keys: prefer environment variables; only use the api_key argument for per-request overrides inside trusted contexts.

Troubleshooting

Symptom Likely Cause Resolution
CONFIGURATION_ERROR Missing CHATADS_API_KEY Export the key or pass api_key argument.
FORBIDDEN / UNAUTHORIZED Invalid or revoked key Verify the key in Supabase / dashboard; rotate if needed.
MINUTE_QUOTA_EXCEEDED / DAILY_QUOTA_EXCEEDED / QUOTA_EXCEEDED Hitting rate or hard caps Respect metadata.notes and retry after the implied window or upgrade the plan.
CIRCUIT_BREAKER_OPEN Too many consecutive failures Circuit breaker is protecting against failed requests. Wait 60 seconds or check API health with chatads_health_check().
UPSTREAM_UNAVAILABLE Network outage or repeated 5xx Wait/backoff; confirm Modal deployment health; consider raising CHATADS_MCP_MAX_RETRIES.
INVALID_INPUT Empty message or <2 words Provide more descriptive user text; sanitize before sending.
REQUEST_TOO_LARGE Payload exceeds size limit Reduce message length or increase CHATADS_MAX_REQUEST_SIZE.

Enable debug logging if deeper insight is needed:

# Text logging (default)
LOGLEVEL=DEBUG chatads-mcp

# JSON structured logging (recommended for production)
CHATADS_LOG_FORMAT=json LOGLEVEL=INFO chatads-mcp

JSON logging outputs structured logs compatible with log aggregation systems (CloudWatch, Datadog, etc.).

Logs include upstream latency, retry attempts, and normalized error payloads without exposing internal stack traces or API keys to Claude.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

chatads_mcp_wrapper-0.1.0.tar.gz (16.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chatads_mcp_wrapper-0.1.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file chatads_mcp_wrapper-0.1.0.tar.gz.

File metadata

  • Download URL: chatads_mcp_wrapper-0.1.0.tar.gz
  • Upload date:
  • Size: 16.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.11

File hashes

Hashes for chatads_mcp_wrapper-0.1.0.tar.gz
Algorithm Hash digest
SHA256 050a95d4931b3a5122c94ecc0e9331d415fb09a10ab02013d08a38399319a7ef
MD5 9fcc95d780173c5746ced7e7a0372caf
BLAKE2b-256 a4c8148b8b19e0315366a9ab1ad1a8cc6b3a2ed224496c0ced7a79894dc629bd

See more details on using hashes here.

File details

Details for the file chatads_mcp_wrapper-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for chatads_mcp_wrapper-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 96c311987a47f0c43fe8bca1cd85ff7baa6a91e57c23670f53e218361b20a5af
MD5 853ad7cd56a5b9edb08c389ee500cf8e
BLAKE2b-256 75c7d9ef5e7ea0947d2ac65ddca67ea2d474f4c6f3c8f878474efd81c374c50c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page