binance-mcp-server copilot-instructions.md

Copilot Instructions - Best Development Practices

This guide establishes development standards and best practices for our tech stack: Python, FastAPI, FastMCP. Following these practices ensures maintainable, sustainable, and high-quality systems. when building the mcp server follow the guidelines available at https://modelcontextprotocol.io/quickstart/server using the #fetch tool

General Instructions

• Always prioritize readability and clarity.
• For algorithm-related code, include explanations of the approach used.
• Write code with good maintainability practices, including comments on why certain design decisions were made.
• Handle edge cases and write clear exception handling.
• For libraries or external dependencies, mention their usage and purpose in comments.
• If possible use available tools to search libary documentation to write and suggestion updated code.
• Use consistent naming conventions and follow language-specific best practices.
• Write concise, efficient, and idiomatic code that is also easily understandable.

Python Development

Code Style & Structure

• Structure projects using a clear module hierarchy
• Use the typing module for type annotations (e.g., List[str], Dict[str, int]).
• Create meaningful docstrings (Google style recommended)
• Break down complex functions into smaller, more manageable functions.
• Maintain proper indentation (use 4 spaces for each level of indentation).
• Place function and class docstrings immediately after the def or class keyword.
• Use blank lines to separate functions, classes, and code blocks where appropriate.

Python Best Practices

• Prefer explicit code over implicit
• Use virtual environments venv
• Use uv as a package manager for Python projects
• Implement comprehensive error handling with specific exception types
• Follow SOLID principles for OOP code
• Leverage dataclasses for data containers
• Use enums for related constants

Testing and Edge Cases

• Write unit tests with pytest (aim for >80% coverage)
• Implement integration and end-to-end tests
• Use test fixtures for reusable test components
• Mock external dependencies and services
• Practice TDD where applicable
• Always include test cases for critical paths of the application.
• Account for common edge cases like empty inputs, invalid data types, and large datasets.
• Include comments for edge cases and the expected behavior in those cases.
• Write unit tests for functions and document them with docstrings explaining the test cases.