Skip to content

Latest commit

 

History

History
106 lines (81 loc) · 3.68 KB

README.md

File metadata and controls

106 lines (81 loc) · 3.68 KB

TelemetryFlow Python MCP Server Documentation

  • Version: 1.1.2
  • MCP Protocol: 2024-11-05
  • Last Updated: January 2025
  • Status: Production Ready

Documentation Index

Document Description
ARCHITECTURE.md System architecture, DDD patterns, component overview
ERD.md Entity Relationship Diagrams, domain models
DFD.md Data Flow Diagrams, state machines, sequence diagrams
CONFIGURATION.md Complete configuration reference
COMMANDS.md CLI commands and MCP protocol usage
DEVELOPMENT.md Development guide, coding standards, testing
INSTALLATION.md Installation and deployment guide
TROUBLESHOOTING.md Common issues and solutions
GIT-WORKFLOW.md Git workflow and branching strategy

Quick Links

Getting Started

Architecture

Diagrams

Development

Component Overview

graph TB
    subgraph "Documentation Structure"
        README[README.md<br/>Project Overview]
        ARCH[ARCHITECTURE.md<br/>System Design]
        ERD[ERD.md<br/>Entity Diagrams]
        DFD[DFD.md<br/>Data Flow]
        CONFIG[CONFIGURATION.md<br/>Config Reference]
        CMD[COMMANDS.md<br/>CLI Usage]
        DEV[DEVELOPMENT.md<br/>Dev Guide]
        INSTALL[INSTALLATION.md<br/>Setup Guide]
        TROUBLE[TROUBLESHOOTING.md<br/>Problem Solving]
    end

    README --> INSTALL
    INSTALL --> CONFIG
    CONFIG --> CMD
    README --> ARCH
    ARCH --> ERD
    ARCH --> DFD
    ERD --> DEV
    DFD --> DEV
    DEV --> TROUBLE

    style README fill:#E1BEE7,stroke:#7B1FA2,stroke-width:2px
    style ARCH fill:#C8E6C9,stroke:#388E3C
    style ERD fill:#FFF3E0,stroke:#FF9800
    style DFD fill:#FCE4EC,stroke:#E91E63
    style CONFIG fill:#BBDEFB,stroke:#1976D2
Loading

Version History

Version Date Changes
1.1.2 January 2025 Initial release with TelemetryFlow SDK integration

Additional Resources