iOS SDK

Installation

Swift Package Manager (local)

Unzip the download, then add as a local package in Xcode.

CocoaPods (local)

For projects that use CocoaPods as the dependency manager.

Minimum iOS deployment target: 13.0  •  Xcode: 15+

Quick Start

Get your first feedback submission in under 5 minutes.

// Download the SDK zip from the iOS docs page, then:
// Xcode: File > Add Package Dependencies > Add Local...
// Select the unzipped mcpfeedback-ios-sdk/ folder

// Or in Package.swift:
.package(path: "../mcpfeedback-ios-sdk")

import McpFeedback

// UIKit — AppDelegate.swift
func application(_ application: UIApplication,
    didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
    McpFeedback.shared.initialize(
        siteKey: "your-site-key",
        config: McpFeedbackConfig(shakeEnabled: true)
    )
    return true
}

// SwiftUI — MyApp.swift
@main
struct MyApp: App {
    init() {
        McpFeedback.shared.initialize(
            siteKey: "your-site-key",
            config: McpFeedbackConfig()
        )
    }
    var body: some Scene { WindowGroup { ContentView() } }
}

API Key Setup

Your site key is available in Dashboard > Settings > API Keys. Store it in your app's configuration — never in source control.

Configuration

Pass a McpFeedbackConfig to McpFeedback.shared.initialize().

Screenshot Capture

The SDK uses UIGraphicsImageRenderer to capture the key window hierarchy as a PNG at the moment feedback is triggered. The SDK overlay is rendered after capture so it is never included in the screenshot.

Annotation Tools

The annotation editor renders via Core Graphics on a UIView overlay. Three tools:

• Pen — freehand drawing with configurable color and stroke width
• Highlight — translucent rectangle to draw attention to a region
• Blur — blurs a rectangular region for privacy before upload

Invocation Methods

Seven ways to open the feedback form on iOS:

// shakeEnabled: true in McpFeedbackConfig (default)

floatingButtonEnabled: true // default

screenshotDetectEnabled: true // default

McpFeedback.shared.show()
// or from a specific view controller:
McpFeedback.shared.show(from: self)

twoFingerSwipeEnabled: true

McpFeedbackConfig(
  edgePanEnabled: true,
  edgePanEdge: .right // .left | .right
)

Network Logging

The SDK swizzles URLSession via a custom URLProtocol subclass to intercept all HTTP traffic. The last N log entries are attached to each feedback report.

Crash Reporting

The SDK installs signal handlers and an NSUncaughtExceptionHandler to capture crashes. On next launch, queued crash reports are uploaded automatically. App Hang detection uses MetricKit on iOS 14+.

Each crash report includes: exception type, reason, call stack, device model, OS version, app version, free memory, disk space, and the last 20 network log entries.

Screen Recording

The SDK uses ReplayKit (RPScreenRecorder) for in-app screen recording. Recordings are MP4 (H.264), capped at 30 seconds by default.

ReplayKit requires the user to grant screen recording permission on first use via a system dialog. The SDK presents this dialog automatically when recording is initiated.

Session Replay

Session Replay captures lightweight UI-change screenshots assembled into a scrubable timeline in the dashboard.

Feature Requests

Present the in-app feature request board or submit requests programmatically.

Privacy Masking

Use McpFeedbackMask (SwiftUI) or view.mcpMask() (UIKit) to prevent views from appearing in screenshots, recordings, and replays.

Offline Queue

All submissions are persisted to a local SQLite database (via GRDB.swift) before upload. The SDK retries with exponential backoff when connectivity is restored.

API Reference

The full API reference is auto-generated from Swift doc comments using swift-docc (DocC).