# Project Profile Version: 1.0.0 Status: ACTIVE ## Purpose This file gives agents a concise, current map of the project. It should answer: * what the project is * how it is structured * what technologies it uses * how to build it * how to test it * how data is stored * how it is deployed * what constraints matter * which project-specific skills exist This file is not intended to replace the README, architecture documentation, deployment guides, or detailed technical documentation. It is an **agent-readable index of project truth**. --- # 1. Project Summary ## Name ```text {{PROJECT_NAME}} ``` ## Purpose ```text {{SHORT_DESCRIPTION_OF_WHAT_THE_PROJECT_DOES}} ``` ## Primary Users ```text {{USERS_OR_CONSUMERS}} ``` ## Repository Type Choose one or more: ```text APPLICATION SERVICE LIBRARY SCRIPT COLLECTION DATA PIPELINE INFRASTRUCTURE DOCUMENTATION MONOREPO ``` --- # 2. Source of Truth When this profile conflicts with current project documentation or code: ```text VERIFY THE CURRENT PROJECT STATE ``` Do not blindly trust stale information in this file. Important source-of-truth documents: ```text {{README_PATH}} {{ARCHITECTURE_DOC}} {{DEPLOYMENT_DOC}} {{OTHER_IMPORTANT_DOCS}} ``` --- # 3. Technology ## Primary Languages ```text {{LANGUAGE}} {{LANGUAGE}} ``` ## Frameworks ```text {{FRAMEWORK}} — {{VERSION_IF_KNOWN}} ``` ## Runtime ```text {{RUNTIME}} ``` ## Operating Environment ```text {{WINDOWS/LINUX/CONTAINER/etc}} ``` ## Web/Application Server ```text {{IIS/NGINX/APACHE/etc}} ``` --- # 4. Important Directories ```text {{PATH}} Purpose: {{PURPOSE}} {{PATH}} Purpose: {{PURPOSE}} {{PATH}} Purpose: {{PURPOSE}} ``` Example: ```text /src Application source /tests Automated tests /scripts Build/deployment/maintenance scripts /docs Project documentation ``` Only include directories agents commonly need. --- # 5. Entry Points Important execution entry points: ```text {{ENTRY_POINT}} Purpose: {{DESCRIPTION}} ``` Examples: ```text /default.asp Program.cs index.php main.py deploy.ps1 scheduled-import.vbs ``` --- # 6. Architecture ## Architecture Style ```text {{MVC / LAYERED / SCRIPT PIPELINE / MONOLITH / etc}} ``` ## Major Components ```text {{COMPONENT}} Responsibility: {{RESPONSIBILITY}} ``` ## Typical Request / Execution Flow ```text INPUT ↓ {{COMPONENT}} ↓ {{COMPONENT}} ↓ {{COMPONENT}} ↓ OUTPUT ``` --- # 7. Data ## Primary Data Store ```text {{DATABASE_ENGINE_OR_STORAGE}} ``` ## Data Access ```text {{ADODB / EF CORE / RAW SQL / ODBC / etc}} ``` ## Schema Location ```text {{LOCATION}} ``` ## Migration Method ```text {{METHOD_OR_NONE}} ``` ## Important Data Constraints ```text - {{CONSTRAINT}} - {{CONSTRAINT}} ``` Do not store passwords, connection secrets, or credentials here. --- # 8. Authentication ## Authentication Model ```text {{WINDOWS AUTH / FORMS / JWT / OAUTH / etc}} ``` ## Authorization Model ```text {{ROLES / CLAIMS / CUSTOM / etc}} ``` ## Important Trust Boundaries ```text - {{BOUNDARY}} - {{BOUNDARY}} ``` --- # 9. External Integrations ## {{INTEGRATION_NAME}} Purpose: ```text {{PURPOSE}} ``` Interface: ```text {{API / SFTP / SMTP / WEBHOOK / FILE SHARE / etc}} ``` Relevant documentation: ```text {{PATH_OR_REFERENCE}} ``` --- # 10. Build ## Standard Build ```text {{COMMAND}} ``` ## Dependency Restore ```text {{COMMAND_IF_NEEDED}} ``` ## Build Output ```text {{OUTPUT_LOCATION}} ``` ## Known Requirements ```text - {{REQUIREMENT}} ``` --- # 11. Tests ## Fast Test ```text {{COMMAND}} ``` ## Full Test ```text {{COMMAND}} ``` ## Integration Tests ```text {{COMMAND_OR_NOT_APPLICABLE}} ``` ## Manual Smoke Test ```text {{STEPS}} ``` --- # 12. Deployment ## Target ```text {{SERVER / PLATFORM / ENVIRONMENT}} ``` ## Deployment Method ```text {{DESCRIPTION}} ``` ## Deployment Command ```text {{COMMAND_IF_APPROPRIATE}} ``` ## Health Verification ```text {{HEALTH_CHECK}} ``` ## Rollback ```text {{ROLLBACK_METHOD}} ``` Detailed deployment documentation: ```text {{DOC_PATH}} ``` --- # 13. Configuration Important configuration files: ```text {{FILE}} Purpose: {{PURPOSE}} ``` Environment-specific configuration: ```text {{DESCRIPTION}} ``` Do not store secrets here. --- # 14. Coding Conventions Observed project conventions: ```text - {{CONVENTION}} - {{CONVENTION}} - {{CONVENTION}} ``` Examples: ```text Controllers perform request coordination only. SQL commands use parameters. Public APIs use the existing JSON response wrapper. ``` Only record conventions supported by repeated project evidence or explicit project instruction. --- # 15. Error Handling Standard project behavior: ```text {{DESCRIPTION}} ``` Relevant implementation example: ```text {{FILE_OR_COMPONENT}} ``` --- # 16. Logging Logging mechanism: ```text {{MECHANISM}} ``` Log locations: ```text {{LOCATION}} ``` Important rules: ```text - do not log credentials - {{RULE}} ``` --- # 17. Important Constraints Durable project constraints: ```text - {{CONSTRAINT}} - {{CONSTRAINT}} ``` Examples: ```text Must remain compatible with Windows Server 2016. Do not introduce React. Application must continue using Microsoft Access. Public endpoint URLs must remain backward compatible. ``` Only add constraints supported by project requirements. --- # 18. Existing Patterns ## Creating a New {{COMPONENT}} Reference examples: ```text {{FILE}} {{FILE}} ``` Typical pattern: ```text {{SHORT_DESCRIPTION}} ``` --- # 19. High-Value Workflows Recurring workflows include: ```text {{WORKFLOW}} Frequency: {{FREQUENCY}} Current procedure: {{REFERENCE}} Skill: {{SKILL_PATH_OR_CANDIDATE}} ``` --- # 20. Project-Specific Skills Active skills: ```text .ai/skills/{{SKILL}}/SKILL.md Purpose: {{PURPOSE}} ``` Skill candidates: ```text {{CANDIDATE}} Evidence: {{EVIDENCE}} ``` --- # 21. Automation Existing automation: ```text {{SCRIPT}} Purpose: {{PURPOSE}} ``` Automation candidates: ```text {{CANDIDATE}} Reason: {{REASON}} ``` --- # 22. Known Risks Important known technical or operational risks: ```text {{RISK}} Mitigation: {{MITIGATION}} ``` Do not fill this with every theoretical risk. Include only risks worth remembering. --- # 23. Known Unknowns Items agents should not assume: ```text - {{UNKNOWN}} - {{UNKNOWN}} ``` Example: ```text Production database version has not yet been verified. ``` Remove items when resolved. --- # 24. Useful Commands ## Development ```text {{COMMAND}} ``` ## Testing ```text {{COMMAND}} ``` ## Build ```text {{COMMAND}} ``` ## Deployment ```text {{COMMAND}} ``` ## Diagnostics ```text {{COMMAND}} ``` Keep this section practical. --- # 25. Agent Routing When working on: ```text {{TASK}} ``` use: ```text .ai/skills/{{SKILL}}/SKILL.md ``` Example: ```text Production IIS deployment → .ai/skills/iis-deployment/SKILL.md ``` --- # 26. Project Evolution Update this file when: ```text framework changes architecture changes build changes test process changes deployment changes database changes authentication changes important project skills are added ``` Do not update it for normal implementation details. --- # 27. Bootstrap Information Last bootstrap review: ```text {{DATE}} ``` Bootstrap confidence: ```text LOW / MEDIUM / HIGH ``` Areas needing deeper inspection: ```text - {{AREA}} ``` --- # 28. Maintenance Principle This file should stay: ```text CURRENT CONCISE USEFUL ``` If a section becomes large: ```text move detailed content to project documentation and reference it here ``` This profile is a map, not the entire territory.