Development Guidelines

This section collects project-wide guidance to keep contributions consistent, safe, and easy for humans and LLMs to use.

What's inside

• Requirements — Set up your environment (Python, tooling, pre-commit)
• Coding Styles and Rules — Code conventions, typing standards, and quality tools
• Testing Strategy — Test pyramid, how to run tests, and coverage map
• Test Configuration & Settings — Configure test environment, manage API tokens and resource IDs, use pytest fixtures
• MCP Tool Development Guidelines — LLM-first tool design, naming, input/output models, and unified ToolResponse envelope
• How to create a new mapper — Step-by-step guide for DTO ↔ Domain ↔ Output mappers with examples and a Mermaid flowchart

When to use these

• You are preparing your dev environment or CI locally
• You are implementing a new feature or MCP tool
• You are adding or refactoring tests
• You are aligning tool inputs/outputs for LLM comprehension and token efficiency

Next steps

• New contributor? Start with Requirements and Coding Styles and Rules
• Building/adjusting tools? Refer to the MCP Tool development doc for best practices.
• For model layering and mapping patterns (DTO → Domain → Output), see Architecture: Models.
• For a step-by-step guide to creating a new mapper, see How to create a new mapper.
• Verifying behavior? Follow the Testing Strategy