Description

This Pull Request (PR) delivers the OpenDigger MCP Server with complete integration of OpenDigger metrics and full MCP support, enabling seamless interaction between LLM clients and OpenDigger’s analytics ecosystem.

The implementation focuses on robustness, real-time streaming, and developer usability. It introduces a caching layer, supports Server-Sent Events (SSE), and provides advanced prompts for improved output quality. Documentation, setup guides, and performance validation have been added to ensure smooth adoption across different MCP clients (Cursor, VS Code, Claude, MCP Inspector, etc.).

💡 This work is done as a part of OSPP '25.

✅ Expected Deliverables (Completed)

• 🟢 Enhanced MCP Server with most (if not all) OpenDigger metrics support.
• 🟢 Server-Sent Events (SSE) support for real-time data streaming
• 🟢 Advanced Prompts for robust and context-aware outputs
• 🟢 Complete Documentation (API reference, tutorials, usage examples)

🔄 Future Work (TBD)

Once the check is complete by @birdflyi, we can start working on setting up a test suite (if required), and for the same, it needs some discussion with @frank-zsy. Besides, the same shall also allow us to perform a marketplace publication on major MCP platforms (specifically on npm and modelcontextprotocol/servers), but that has to be done via creating a PR from the main repository by the code-owner i.e. @frank-zsy once this PR gets merged with main.

High-Level System Architecture

flowchart LR
    LLMClient["LLM Client"] --> MCPServer["OpenDigger<br>MCP Server"]
    MCPServer <--> OpenDigger["OpenDigger<br>(API Layer)"]
    MCPServer --> CacheLayer["Cache Layer<br>(In-Memory)"]

🟦 Data Flow Diagram (Cache)

flowchart TD
    subgraph Client
        LLMClient["👨‍💻 LLM Client<br>(e.g., Cursor IDE)"]
    end

    subgraph "OpenDigger MCP Server"
        direction LR
        
        subgraph "1. Request Handling"
            Validate["✅ Validate Input"]
            CheckCache{"💾 Check Cache?"}
        end

        subgraph "2. Data Fetching"
            FetchAPI["📡 Fetch from API"]
            UpdateCache["📝 Update Cache"]
        end
        
        subgraph "3. Response Generation"
            ProcessData["⚙️ Process & Format Data"]
            SendResponse["📤 Stream (SSE) or<br>Return Complete Response"]
        end
        
        Validate --> CheckCache
        CheckCache -- Cache Miss --> FetchAPI
        FetchAPI --> UpdateCache
        UpdateCache --> ProcessData
        CheckCache -- Cache Hit --> ProcessData
        ProcessData --> SendResponse
    end

    subgraph "External Services"
        OpenDigger["🌐 OpenDigger API"]
        Cache["💾 In-Memory Cache"]
    end

    LLMClient -- "1. MCP Request" --> Validate
    FetchAPI <--> OpenDigger
    CheckCache <--> Cache
    UpdateCache --> Cache
    SendResponse -- "4. Formatted Data" --> LLMClient

    class LLMClient client;
    class OpenDigger,Cache external;
    class Validate,CheckCache,FetchAPI,UpdateCache,ProcessData,SendResponse server;

📌 Resolves #1698
🦄 Tested on local, build running successfully!

cc: @birdflyi, @frank-zsy

Before submitting the PR, please take the following into consideration

• It's really useful if your PR references an issue where it is discussed ahead of time. In many cases, features are absent for a reason. If you don't have an issue, please create one.
• The description should clearly illustrate what problems it solves.
• Ensure that the commit messages follow our guidelines.
• Resolve merge conflicts (if any).