Skip to main content

AI Gateway Documentation - Required Images

This file lists all images that need to be created for the AI Gateway documentation. Image Location: /images/ folder in the documentation root

Overview & Setup Images

Introduction Page (introduction.mdx)

ImageDescriptionPriority
ai-gateway-architecture.pngDiagram showing Your App -> LeanMCP Gateway -> AI Provider flow. Show logging, security, and analytics happening at the gateway level.HIGH

API Keys Page (api-keys.mdx)

ImageDescriptionPriority
ai-gateway-api-keys-page.pngScreenshot of ship.leanmcp.com/api-keys page showing the API keys listHIGH
ai-gateway-create-key.pngScreenshot of the “Create API Key” modal with name field and SDK permissions checkbox highlightedHIGH

Getting Started Page (getting-started.mdx)

ImageDescriptionPriority
ai-gateway-signup.pngScreenshot of ship.leanmcp.com signup/onboarding pageMEDIUM
ai-gateway-logs.pngScreenshot of the AI Gateway logs view showing a test requestHIGH

For Users - IDE Integration Images

Cursor Page (cursor.mdx)

ImageDescriptionPriority
ai-gateway-cursor-settings.pngScreenshot of Cursor Settings > Models showing: (1) API Key field with leanmcp_xxx entered, (2) “Override OpenAI Base URL” field with gateway URL. Highlight both fields with arrows or boxes.HIGH
ai-gateway-cursor-verify.pngScreenshot showing a successful AI request in Cursor AND the corresponding log entry in LeanMCP dashboard (side by side or before/after)HIGH

Windsurf Page (windsurf.mdx)

ImageDescriptionPriority
ai-gateway-windsurf-settings.pngScreenshot of Windsurf Settings showing where to enter Base URL and API Key. Highlight the relevant fields. Should show: (1) Base URL field, (2) API Key field.HIGH

Raycast Page (raycast.mdx)

ImageDescriptionPriority
ai-gateway-raycast-settings.pngScreenshot of Raycast Settings > AI section showing the Custom API Keys area. Show where to find it in the settings sidebar.HIGH
ai-gateway-raycast-models.pngScreenshot of Raycast model picker showing the key icon next to models using BYOKMEDIUM

OpenCode Page (opencode.mdx)

ImageDescriptionPriority
ai-gateway-opencode-models.pngScreenshot of OpenCode /models command output showing LeanMCP provider in the listMEDIUM

Clawdbot Page (clawdbot.mdx)

ImageDescriptionPriority
ai-gateway-clawdbot-logs.pngScreenshot of LeanMCP dashboard showing logged requests from Clawdbot Discord botLOW

For Users - Personal Use Images

For Personal Users Page (for-personal-users.mdx)

ImageDescriptionPriority
ai-gateway-personal-dashboard.pngScreenshot of personal user dashboard showing overview: recent requests, token usage, any detected sensitive dataHIGH
ai-gateway-request-log.pngScreenshot of detailed request log view showing: full request content, response, token usage, timestampHIGH
ai-gateway-cost-tracking.pngScreenshot of cost tracking graph showing daily/weekly usage with cost breakdownMEDIUM

For Developers Images

For Developers Page (for-developers.mdx)

ImageDescriptionPriority
ai-gateway-user-tracking.pngDashboard screenshot showing per-user tracking: list of users, their request counts, token usageHIGH
ai-gateway-block-user.pngScreenshot showing how to block a user: either the block button in UI or the blocked users listHIGH
ai-gateway-competitor-analysis.pngDashboard showing benchmarks/analytics comparing usage patternsLOW
ai-gateway-ab-testing.pngA/B test results view showing variant comparison: quality scores, token usage, cost per variantMEDIUM
ai-gateway-dev-analytics.pngDeveloper analytics dashboard: request volume graph, cost breakdown by feature, error ratesHIGH
ai-gateway-user-management.pngUser management interface: list of users with usage stats, ability to set limits or blockMEDIUM

Features Images

Observability Page (observability.mdx)

ImageDescriptionPriority
ai-gateway-request-detail.pngDetailed view of a single request: timestamp, full request body, full response, model, tokens, latencyHIGH
ai-gateway-log-filters.pngLog filtering UI: date range picker, model dropdown, user ID search, status filterMEDIUM
ai-gateway-code-context.pngExample showing code sent to AI: highlight the actual source code in the request, show filename and contextHIGH
ai-gateway-live-stream.pngReal-time log stream view with requests appearing liveMEDIUM
ai-gateway-metrics.pngMetrics dashboard: graphs for requests/minute, token usage, error rate, latencyHIGH

Security Page (security.mdx)

ImageDescriptionPriority
ai-gateway-sensitive-detection.pngExample of detected sensitive data: show a request with API key highlighted/flaggedHIGH
ai-gateway-block-user.png(Same as for-developers) User blocking interfaceHIGH
ai-gateway-audit-log.pngSecurity audit log: list of security events with timestamps and detailsMEDIUM
ai-gateway-security-alert.pngExample security alert notification (email or Slack format)LOW

Token Optimization Page (token-optimization.mdx)

ImageDescriptionPriority
ai-gateway-token-analytics.pngToken analytics dashboard: breakdown by model, by feature, by user, over timeHIGH
ai-gateway-ab-test-setup.pngA/B test creation UI: experiment name, variants, weights, metricsMEDIUM
ai-gateway-ab-results.png(Same as for-developers) A/B test results comparisonMEDIUM
ai-gateway-benchmarks.pngIndustry benchmarks view: compare your usage to averagesLOW
ai-gateway-model-routing.pngDiagram showing smart model routing: simple queries -> smaller model, complex -> larger modelMEDIUM
ai-gateway-cost-alert.pngCost alert notification exampleLOW
ai-gateway-roi-calculator.pngROI calculator showing cost savings from optimizationLOW

Summary by Priority

HIGH Priority (Must Have) - 16 images

These are essential for users to understand how to set up and use the gateway:
  1. ai-gateway-architecture.png - Core concept visualization
  2. ai-gateway-api-keys-page.png - Where to get API key
  3. ai-gateway-create-key.png - How to create API key
  4. ai-gateway-logs.png - Verify setup works
  5. ai-gateway-cursor-settings.png - Cursor setup
  6. ai-gateway-cursor-verify.png - Cursor verification
  7. ai-gateway-windsurf-settings.png - Windsurf setup
  8. ai-gateway-raycast-settings.png - Raycast setup
  9. ai-gateway-personal-dashboard.png - Personal user overview
  10. ai-gateway-request-log.png - How to read logs
  11. ai-gateway-user-tracking.png - Developer user tracking
  12. ai-gateway-block-user.png - Blocking users
  13. ai-gateway-dev-analytics.png - Developer analytics
  14. ai-gateway-request-detail.png - Request details
  15. ai-gateway-code-context.png - Code visibility
  16. ai-gateway-token-analytics.png - Token tracking
  17. ai-gateway-sensitive-detection.png - Security detection
  18. ai-gateway-metrics.png - Metrics overview

MEDIUM Priority (Should Have) - 11 images

These improve understanding but aren’t blocking:
  1. ai-gateway-signup.png
  2. ai-gateway-raycast-models.png
  3. ai-gateway-opencode-models.png
  4. ai-gateway-cost-tracking.png
  5. ai-gateway-ab-testing.png
  6. ai-gateway-user-management.png
  7. ai-gateway-log-filters.png
  8. ai-gateway-live-stream.png
  9. ai-gateway-audit-log.png
  10. ai-gateway-ab-test-setup.png
  11. ai-gateway-model-routing.png

LOW Priority (Nice to Have) - 6 images

These are supplementary:
  1. ai-gateway-clawdbot-logs.png
  2. ai-gateway-competitor-analysis.png
  3. ai-gateway-security-alert.png
  4. ai-gateway-benchmarks.png
  5. ai-gateway-cost-alert.png
  6. ai-gateway-roi-calculator.png

Image Guidelines

Format

  • Format: PNG or WebP
  • Max Width: 1200px (will be scaled down if larger)
  • Quality: High quality, no compression artifacts

Style

  • Clean UI: Use clean, uncluttered screenshots
  • Annotations: Add arrows, boxes, or numbers to highlight important areas
  • Consistency: Use the same browser/app window size for all screenshots
  • Dark Mode: Consider providing both light and dark mode versions if applicable

Content

  • Realistic Data: Use realistic but fake data (not real user data)
  • Blur Sensitive Info: Blur any real API keys, user IDs, or personal data
  • Current UI: Screenshots should match the current production UI

Naming Convention

All images should be prefixed with ai-gateway- and use lowercase with hyphens.

Checklist

  • Create /images/ folder structure if not exists
  • HIGH priority images (16 images)
  • MEDIUM priority images (11 images)
  • LOW priority images (6 images)
  • Review all images for consistency
  • Test images render correctly in documentation