fabric-rti-mcp: Instructions file for GitHub Copilot

Project Coding Guidelines

This document outlines the coding standards, architectural patterns, and best practices for this Project's codebase. It's designed to help new engineers quickly understand our approach and contribute effectively to the project.

Project Overview

Fabric RTI MCP is an MCP server that exposes Fabric RTI functionality as tools that can be used by agents.

Code Style and Formatting

Python Version

• Python 3.10 is required for this project

Formatting

• We use Black for code formatting with a line length of 120 characters
• Run black . before committing to ensure consistent formatting

Imports

• Group imports in the following order:
  1. Standard library imports
  2. Third-party library imports
  3. Project imports
• Within each group, use alphabetical ordering
• Use absolute imports for project modules

Example:

import abc
from dataclasses import dataclass
from typing import List, Optional, Dict

import numpy as np
from termcolor import colored

from fabric_rti_mcp.kusto import KustoService

Type Annotations

• Use type hints for all function parameters and return values
• Use generics (TypeVar) when appropriate
• Prefer composition of simple types over complex nested types

Example:

from typing import Dict, List, Optional, TypeVar

T = TypeVar("T")

def get_tasks_with_status(status_type: str, project_id: Optional[str] = None) -> List[int]:
    """Get tasks with a specific status type."""
    # Implementation

Naming Conventions

• Classes: PascalCase
• Functions/Methods: snake_case
• Variables: snake_case
• Constants: UPPER_SNAKE_CASE
• Private members: Prefix with underscore (_private_method)
• Type variables: Single uppercase letter or PascalCase with descriptive name

Comments and TODOs

• Use TODOs to mark areas that need improvement, but include specific details about what needs to be done
• For complex algorithms or non-obvious code, include explanatory comments
• Avoid commented-out code in the main branch