# WormaCeptor

> Modular Android debugging toolkit: network inspector for OkHttp and Ktor, crash reports, logs, performance monitors, storage inspectors, and an MCP server so AI coding agents can query a running debug app. Debug code ships only via debugImplementation; the client API is a no-op in release builds.

- Install: `implementation("com.azikar24.wormaceptor:wormaceptor-client:3.5.0")` plus `debugImplementation("com.azikar24.wormaceptor:wormaceptor-persistence:3.5.0")` (Room storage) or `wormaceptor-imdb` (in-memory storage)
- Published to Maven Central. Min SDK 23.
- AI agents setting up the MCP server: follow https://wormaceptor.com/docs/mcp.md (section "Setup for AI agents"); it covers the Gradle dependency, `claude mcp add` via `npx -y wormaceptor-mcp` or the release jar, and Java/adb discovery.
- Every docs page is available as Markdown by appending `.md` to its URL. All pages in one file: https://wormaceptor.com/llms-full.txt

## Getting Started

- [Introduction](https://wormaceptor.com/docs/index.md): WormaCeptor is an on-device debugging toolkit for Android apps, added to debug builds only.
- [Installation](https://wormaceptor.com/docs/installation.md): Prerequisites and dependency setup for WormaCeptor V2.
- [Quick Start](https://wormaceptor.com/docs/quick-start.md): Minimal setup to get WormaCeptor running in your Android app.

## Guides

- [OkHttp Interceptor](https://wormaceptor.com/docs/okhttp.md): Capture HTTP/HTTPS traffic with the WormaCeptor OkHttp interceptor.
- [Ktor Client Plugin](https://wormaceptor.com/docs/ktor.md): Native Ktor client plugin for capturing HTTP traffic without OkHttp.
- [WebSocket Monitoring](https://wormaceptor.com/docs/websocket.md): Monitor WebSocket connections and messages with WormaCeptor.
- [WebView Monitoring](https://wormaceptor.com/docs/webview.md): Monitor network requests made by WebView instances.
- [MCP Server](https://wormaceptor.com/docs/mcp.md): Let AI coding agents read network traffic, crashes, logs, performance, and storage from a running debug build over the Model Context Protocol.

## Configuration

- [Feature Toggles](https://wormaceptor.com/docs/feature-toggles.md): Control which tools are available in WormaCeptor using the Feature enum.
- [Performance Overlay](https://wormaceptor.com/docs/performance-overlay.md): Display real-time FPS, Memory, and CPU metrics as a draggable overlay.
- [Recomposition Tracking](https://wormaceptor.com/docs/recomposition.md): Track Jetpack Compose recompositions per composable in real time.
- [Data Redaction](https://wormaceptor.com/docs/data-redaction.md): Configure header, body, JSON, and XML redaction for captured network traffic.
- [Extension Providers](https://wormaceptor.com/docs/extension-providers.md): Register custom metadata extractors to enrich network transactions.
- [Deep Links](https://wormaceptor.com/docs/deep-links.md): Navigate directly to any WormaCeptor tab or tool using deep links.
- [Launching the UI](https://wormaceptor.com/docs/launching-ui.md): Different ways to open the WormaCeptor UI in your app.

## Reference

- [No-Op Behavior](https://wormaceptor.com/docs/no-op-behavior.md): How WormaCeptor safely becomes a no-op in release builds.
- [Permissions](https://wormaceptor.com/docs/permissions.md): Android permissions required by WormaCeptor features.
- [Troubleshooting](https://wormaceptor.com/docs/troubleshooting.md): Common issues and solutions when integrating WormaCeptor.
- [Best Practices](https://wormaceptor.com/docs/best-practices.md): Recommended patterns for integrating WormaCeptor in your Android project.

## Migration

- [Migrating from Chucker](https://wormaceptor.com/docs/migration/from-chucker.md): Step-by-step guide to move an existing Chucker setup to WormaCeptor V2.

## Optional

- [GitHub repository](https://github.com/wormaceptor/WormaCeptor): source code, issues, releases
- [Changelog](https://github.com/wormaceptor/WormaCeptor/blob/master/CHANGELOG.md): release history
- [Migration guides](https://github.com/wormaceptor/WormaCeptor/tree/master/docs/migration): move an existing debug setup to WormaCeptor
- [MCP reference](https://github.com/wormaceptor/WormaCeptor/blob/master/docs/MCP.md): REST endpoints, streaming, module layout of the MCP server