7.5KB
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
{{PROJECT_NAME}}
Purpose
{{SHORT_DESCRIPTION_OF_WHAT_THE_PROJECT_DOES}}
Primary Users
{{USERS_OR_CONSUMERS}}
Repository Type
Choose one or more:
APPLICATION
SERVICE
LIBRARY
SCRIPT COLLECTION
DATA PIPELINE
INFRASTRUCTURE
DOCUMENTATION
MONOREPO
2. Source of Truth
When this profile conflicts with current project documentation or code:
VERIFY THE CURRENT PROJECT STATE
Do not blindly trust stale information in this file.
Important source-of-truth documents:
{{README_PATH}}
{{ARCHITECTURE_DOC}}
{{DEPLOYMENT_DOC}}
{{OTHER_IMPORTANT_DOCS}}
3. Technology
Primary Languages
{{LANGUAGE}}
{{LANGUAGE}}
Frameworks
{{FRAMEWORK}} — {{VERSION_IF_KNOWN}}
Runtime
{{RUNTIME}}
Operating Environment
{{WINDOWS/LINUX/CONTAINER/etc}}
Web/Application Server
{{IIS/NGINX/APACHE/etc}}
4. Important Directories
{{PATH}}
Purpose: {{PURPOSE}}
{{PATH}}
Purpose: {{PURPOSE}}
{{PATH}}
Purpose: {{PURPOSE}}
Example:
/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:
{{ENTRY_POINT}}
Purpose: {{DESCRIPTION}}
Examples:
/default.asp
Program.cs
index.php
main.py
deploy.ps1
scheduled-import.vbs
6. Architecture
Architecture Style
{{MVC / LAYERED / SCRIPT PIPELINE / MONOLITH / etc}}
Major Components
{{COMPONENT}}
Responsibility:
{{RESPONSIBILITY}}
Typical Request / Execution Flow
INPUT
↓
{{COMPONENT}}
↓
{{COMPONENT}}
↓
{{COMPONENT}}
↓
OUTPUT
7. Data
Primary Data Store
{{DATABASE_ENGINE_OR_STORAGE}}
Data Access
{{ADODB / EF CORE / RAW SQL / ODBC / etc}}
Schema Location
{{LOCATION}}
Migration Method
{{METHOD_OR_NONE}}
Important Data Constraints
- {{CONSTRAINT}}
- {{CONSTRAINT}}
Do not store passwords, connection secrets, or credentials here.
8. Authentication
Authentication Model
{{WINDOWS AUTH / FORMS / JWT / OAUTH / etc}}
Authorization Model
{{ROLES / CLAIMS / CUSTOM / etc}}
Important Trust Boundaries
- {{BOUNDARY}}
- {{BOUNDARY}}
9. External Integrations
{{INTEGRATION_NAME}}
Purpose:
{{PURPOSE}}
Interface:
{{API / SFTP / SMTP / WEBHOOK / FILE SHARE / etc}}
Relevant documentation:
{{PATH_OR_REFERENCE}}
10. Build
Standard Build
{{COMMAND}}
Dependency Restore
{{COMMAND_IF_NEEDED}}
Build Output
{{OUTPUT_LOCATION}}
Known Requirements
- {{REQUIREMENT}}
11. Tests
Fast Test
{{COMMAND}}
Full Test
{{COMMAND}}
Integration Tests
{{COMMAND_OR_NOT_APPLICABLE}}
Manual Smoke Test
{{STEPS}}
12. Deployment
Target
{{SERVER / PLATFORM / ENVIRONMENT}}
Deployment Method
{{DESCRIPTION}}
Deployment Command
{{COMMAND_IF_APPROPRIATE}}
Health Verification
{{HEALTH_CHECK}}
Rollback
{{ROLLBACK_METHOD}}
Detailed deployment documentation:
{{DOC_PATH}}
13. Configuration
Important configuration files:
{{FILE}}
Purpose:
{{PURPOSE}}
Environment-specific configuration:
{{DESCRIPTION}}
Do not store secrets here.
14. Coding Conventions
Observed project conventions:
- {{CONVENTION}}
- {{CONVENTION}}
- {{CONVENTION}}
Examples:
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:
{{DESCRIPTION}}
Relevant implementation example:
{{FILE_OR_COMPONENT}}
16. Logging
Logging mechanism:
{{MECHANISM}}
Log locations:
{{LOCATION}}
Important rules:
- do not log credentials
- {{RULE}}
17. Important Constraints
Durable project constraints:
- {{CONSTRAINT}}
- {{CONSTRAINT}}
Examples:
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:
{{FILE}}
{{FILE}}
Typical pattern:
{{SHORT_DESCRIPTION}}
19. High-Value Workflows
Recurring workflows include:
{{WORKFLOW}}
Frequency:
{{FREQUENCY}}
Current procedure:
{{REFERENCE}}
Skill:
{{SKILL_PATH_OR_CANDIDATE}}
20. Project-Specific Skills
Active skills:
.ai/skills/{{SKILL}}/SKILL.md
Purpose:
{{PURPOSE}}
Skill candidates:
{{CANDIDATE}}
Evidence:
{{EVIDENCE}}
21. Automation
Existing automation:
{{SCRIPT}}
Purpose:
{{PURPOSE}}
Automation candidates:
{{CANDIDATE}}
Reason:
{{REASON}}
22. Known Risks
Important known technical or operational risks:
{{RISK}}
Mitigation:
{{MITIGATION}}
Do not fill this with every theoretical risk.
Include only risks worth remembering.
23. Known Unknowns
Items agents should not assume:
- {{UNKNOWN}}
- {{UNKNOWN}}
Example:
Production database version has not yet been verified.
Remove items when resolved.
24. Useful Commands
Development
{{COMMAND}}
Testing
{{COMMAND}}
Build
{{COMMAND}}
Deployment
{{COMMAND}}
Diagnostics
{{COMMAND}}
Keep this section practical.
25. Agent Routing
When working on:
{{TASK}}
use:
.ai/skills/{{SKILL}}/SKILL.md
Example:
Production IIS deployment
→ .ai/skills/iis-deployment/SKILL.md
26. Project Evolution
Update this file when:
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:
{{DATE}}
Bootstrap confidence:
LOW / MEDIUM / HIGH
Areas needing deeper inspection:
- {{AREA}}
28. Maintenance Principle
This file should stay:
CURRENT
CONCISE
USEFUL
If a section becomes large:
move detailed content to project documentation
and reference it here
This profile is a map, not the entire territory.