Skip to main content

An AI-powered onboarding intelligence layer on top of Graphify for MCP

Project description

OnboardAI: AI-Powered Onboarding Intelligence Layer

OnboardAI Use Case & Features

OnboardAI is a developer onboarding intelligence system that integrates with Claude Code and other MCP-compatible clients. It is designed to dramatically reduce the time it takes a new developer, intern, or employee to understand a codebase by converting raw repository data and Graphify knowledge graphs into interactive, onboarding-oriented insights.


1. Vision & Architecture

Rather than generating raw repository diagrams or acting as another codebase crawler, OnboardAI acts as a structured guidance layer on top of Graphify. It parses Graphify’s extraction data, maps relationships with NetworkX, groups code modules by directory structure, and answers questions relative to what tasks a developer has been assigned.

Core Architecture Flow

flowchart TD
    subgraph Client Layer
        ClaudeCode[Claude Code / MCP Client]
    end

    subgraph OnboardAI MCP Server
        Server[FastMCP Server]
        Scanner[Project Scanner & Tech Detector]
        Adapter[Graphify Adapter]
        Roadmap[Roadmap Generator]
        QA[Q&A & Context Engine]
        Dependency[Dependency Analyzer]
        Viz[Mermaid Visualizer]
    end

    subgraph Intelligence Engine
        Graphify[Graphify extraction]
        NX[NetworkX Directed Graph]
    end

    ClaudeCode <-->|JSON-RPC via Stdio/SSE| Server
    Server <--> Scanner
    Server <--> Adapter
    Adapter <-->|Reads graphify-out/| Graphify
    Adapter <-->|Builds| NX
    Roadmap <--> Adapter
    QA <--> Adapter
    Dependency <--> Adapter
    Viz <--> Adapter

2. Directory Layout & Components

Here is the file structure of the OnboardAI project:

OnboardAI/
├── .graphifyignore        # Ignore rules to bypass LLM extraction for non-code files
├── requirements.txt       # Project dependencies
├── pyproject.toml         # Packaging metadata, lists graphifyy package as dependency
├── main.py                # Launcher: starts MCP server in stdio or sse mode
├── test_integration.py    # Offline self-check verification test script
├── test_client.py         # Standard python MCP client session simulation script
├── scanner/
│   ├── __init__.py
│   ├── project_scanner.py     # Counts files and crawls folders
│   └── architecture_detector.py # Detects tech stacks (FastAPI, React, etc.)
├── knowledge/
│   ├── __init__.py
│   ├── graphify_adapter.py    # Integrates Graphify output, builds graphs, handles executable discovery
│   ├── dependency_analyzer.py # Traverses graph for upstream/downstream impact and risk analysis
│   ├── onboarding_plan.py     # Generates day-by-day study paths
│   ├── repository_inventory.py# Structured module/class/function catalogs
│   └── qa_assistant.py        # Performs graph-based Q&A and task instructions
└── graph/
    ├── __init__.py
    └── graph_generator.py     # Generates Mermaid mindmaps, dependencies, and call-flows

3. The 4 Core Product Features

Feature 1: Repository Intelligence Summary

  • MCP Tool: get_repository_summary(repo_path: str)
  • Description: Combines scanner statistics, directory structure trees, technology detection, config files list, module inventory, and critical abstractions (high-degree centrality components) into a structured high-level overview.
  • Output: Project type, architecture style, technologies, core modules, entry points, major dependencies, and high-level system flow.

Feature 2: Task-Aware Onboarding

  • MCP Tool: get_task_onboarding_guide(repo_path, task_description, role, team, target_module, question)
  • Description: Generates a tailored learning progression plan. If task_description is provided, it extracts relevant files, suggested study order, prerequisites, and estimated ramp-up time. Also answers repository Q&A queries.
  • Roadmap Structure:
    • Day 1: Environment setup, tech summary, configs.
    • Day 2: Foundational modules (utilities, schemas, database clients).
    • Day 3: Mid-level business logic.
    • Day 4: API controllers, routers, and entry points.
    • Day 5: Automated tests and first contribution.

Feature 3: Dependency Impact Analyzer

  • MCP Tool: analyze_dependency_impact(repo_path, target_component)
  • Description: Analyzes the consequences of modifying a target component or code file. Traces upstream (incoming) and downstream (outgoing) relationships, determines a Risk Level (High/Medium/Low), and suggests recommended tests.

Feature 4: Graphify Visual Knowledge Graph

  • MCP Tool: get_visual_knowledge_graph(repo_path, visualization_type)
  • Description: Translates the NetworkX graph nodes into beautiful Mermaid syntax for direct rendering:
    • mindmap: Folder layout and core modules.
    • callflow: Functional method-to-method call flow chart.
    • dependency: High-level module import connections.

4. MCP Server & Protocols

The MCP Server is implemented in mcp_server/server.py using the FastMCP SDK.

It exposes exactly 4 consolidated tools to any connected client:

  1. get_repository_summary(repo_path): Overall tech stack, folders, stats, flow.
  2. get_task_onboarding_guide(repo_path, task_description, role, team, target_module, question): Customized roadmap, task analysis, and codebase Q&A.
  3. analyze_dependency_impact(repo_path, target_component): Upstream/downstream impact analysis, risk level, test recommendations.
  4. get_visual_knowledge_graph(repo_path, visualization_type): Generates Mermaid mindmap, dependency, or callflow diagrams.

5. Setup & Integration Guide

Installation

OnboardAI depends on the PyPI package graphifyy (with two 'y's). Installing onboardai automatically resolves and installs it:

pip install onboardai

Local Verification

Verify the server runs successfully on your machine by running the test client session simulation:

python test_client.py

This script acts as a local client session, connects to the server, retrieves the tools list, and invokes them locally.

Integrating with Claude Code

To register the server with the Claude Code CLI, run:

claude mcp add onboard-ai python -m mcp_server.server
# OR if calling main.py launcher
claude mcp add onboard-ai python "<path-to-onboardai-repo>\main.py"

Once registered, launch Claude Code:

claude

6. How to Ask Questions

Once integrated into Claude, the model will automatically pick the right tool based on your natural language prompt. Here are some examples:

Question you ask Claude Tool Claude calls under the hood
"Summarise this project" get_repository_summary
"Explain the module GraphifyAdapter" get_task_onboarding_guide(target_module='GraphifyAdapter')
"How should I build the visualizer? What files are relevant?" get_task_onboarding_guide(task_description='visualizer')
"Show me the dependency mindmap" get_visual_knowledge_graph(visualization_type='mindmap')
"If I modify GraphifyAdapter, what will break?" analyze_dependency_impact(target_component='GraphifyAdapter')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

onboardai-0.1.13.tar.gz (26.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

onboardai-0.1.13-py3-none-any.whl (27.5 kB view details)

Uploaded Python 3

File details

Details for the file onboardai-0.1.13.tar.gz.

File metadata

  • Download URL: onboardai-0.1.13.tar.gz
  • Upload date:
  • Size: 26.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for onboardai-0.1.13.tar.gz
Algorithm Hash digest
SHA256 3e67ae31540a9483220d0d7b0828a92d3dddaf8fa13da60278c5d9a6f7ab0f5f
MD5 9a3f1d99db280a847822f4a104bdd0c3
BLAKE2b-256 dbeafff8593e8f1f8cd5236f11bf678b287cf890e40ffc74b051c16c9e69d2df

See more details on using hashes here.

File details

Details for the file onboardai-0.1.13-py3-none-any.whl.

File metadata

  • Download URL: onboardai-0.1.13-py3-none-any.whl
  • Upload date:
  • Size: 27.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for onboardai-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 de09b3df4cbef106c1c94924da4b8cd12320ea3d7025b0c7eb36eeb85f6e09b9
MD5 ed25b3131b6ff582bc30f5d0ac10737c
BLAKE2b-256 6a9b4a5d0700027ff642146dd513474cedc6e31f2aaff41acdd6ad8533066743

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page