Skip to content

Developer Guide

Welcome to the KGraph-MCP Developer Guide! This section contains detailed information for contributors, advanced users, and developers who want to extend or modify KGraph-MCP.

🛠️ Development Sections

  • Setup

    Complete development environment setup with all tools and dependencies.

    Development Setup

  • Contributing

    Guidelines for contributing code, documentation, and reporting issues.

    Contributing Guide

  • Code Style

    Coding standards, linting rules, and best practices for the project.

    Code Style

  • Testing

    Testing strategies, frameworks, and guidelines for maintaining quality.

    Testing Guide

🏗️ Development Workflow

For contributors and maintainers, follow this development workflow:

  1. Setup - Configure your development environment
  2. Code Style - Follow project coding standards
  3. Testing - Write and run comprehensive tests
  4. Contributing - Submit your contributions

🔧 Quick Development Commands

# Setup development environment
just setup

# Run in development mode  
just dev

# Run all quality checks
just check

# Run tests with coverage
just test-cov

# Run pre-commit checks
just pre-commit

📋 Development Standards

  • Python 3.11.8+ - Required Python version
  • Test-Driven Development - Write tests first
  • Type Safety - Full type annotations with mypy
  • Code Quality - Black formatting + Ruff linting
  • Documentation - Comprehensive docstrings and guides