Library Insight 🔍¶

JVM API Explorer & MCP Server for AI IDEs¶

AI coding assistants often guess Java/Kotlin library APIs from old docs, latest web examples, or a different version than the one installed in your project. That leads to missing methods, deprecated usage, wrong signatures, and wasted debugging time.

Library Insight fixes that by scanning the exact JAR/AAR, Gradle output, or Maven version you use. It reads compiled .class structures (using ASM) and Kotlin @Metadata annotations (using kotlin-metadata-jvm) to build a searchable, version-correct public API index.

Why Library Insight?¶

When you add a dependency, the first question is simple: "How do I use this version correctly?"

In real projects, that answer is often messy:

Outdated AI Context: AI may write code for the latest release while your project uses an older version.
Incorrect Web Examples: AI may copy an old blog post where the method name no longer exists.
Incomplete Docs: Official docs may be incomplete or not updated for the release you installed.
Hidden Replacements: Deprecated methods may still appear in examples, while the replacement is hidden in release notes or source comments.
Context Waste: Huge generated docs waste AI context and make one class hard to find.

Library Insight turns the compiled library itself into the source of truth. Scan the dependency, then use search, explain, diff, or ai-export to give humans and AI agents exact, version-aware API information.

Architecture & Modular Design¶

Library Insight follows Clean Architecture principles. Below is the modular dependency flow:

graph TD
    subgraph CLI Layer
        CLI[library-insight-cli]
    end

    subgraph Orchestration Layer
        CORE[library-insight-core]
    end

    subgraph Processing Modules
        PARSER[library-insight-parser]
        KOTLIN[library-insight-kotlin]
        SEARCH[library-insight-search]
        EXPORT[library-insight-export]
    end

    subgraph Data & Common Utility Base
        MODEL[library-insight-model]
        COMMON[library-insight-common]
    end

    CLI --> CORE
    CORE --> PARSER
    CORE --> KOTLIN
    CORE --> SEARCH
    CORE --> EXPORT

    PARSER --> MODEL
    KOTLIN --> MODEL
    SEARCH --> MODEL
    EXPORT --> MODEL

    MODEL --> COMMON
    COMMON --> ASM[ASM Bytecode Reader]
    COMMON --> KTOR[Ktor HTTP Client]

Core Modules¶

library-insight-common: Utility classes for ZIP/JAR/AAR extraction, Ktor async HTTP engine, and filesystem operations.
library-insight-model: Immutable Kotlin serialization structures representing the API index schema.
library-insight-parser: Raw bytecode structure extraction using ASM and JVM signature parsing.
library-insight-kotlin: Kotlin metadata parsing (kotlin-metadata-jvm) and JVM bytecode enrichment.
library-insight-search: Index search and query matching logic.
library-insight-export: JSON, Markdown, and AI context formatters.
library-insight-core: Orchestrates scan flows and implements the semantic API diffing engine.
library-insight-cli: Command Line Interface definitions using Clikt.