Skip to content

Commit 42c7122

Browse files
committed
updated instructions
1 parent be648b3 commit 42c7122

File tree

2 files changed

+88
-0
lines changed

2 files changed

+88
-0
lines changed

templates/ai/agents/agent-flat-instructions.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,50 @@ box testbox run
118118

119119
<!-- List external services, APIs, or integrations -->
120120

121+
## AI Integration
122+
123+
This project includes AI-powered development assistance with guidelines, skills, and MCP documentation servers.
124+
125+
### Directory Structure
126+
127+
```
128+
/.ai/
129+
/manifest.json - AI configuration (language, agents, guidelines, skills, MCP servers)
130+
/guidelines/ - Framework documentation and best practices
131+
/core/ - Core ColdBox/BoxLang guidelines
132+
/modules/ - Module-specific guidelines
133+
/custom/ - Your custom guidelines
134+
/overrides/ - Override core guidelines
135+
/skills/ - Implementation cookbooks (how-to guides)
136+
/core/ - Core development patterns
137+
/modules/ - Module-specific patterns
138+
/custom/ - Your custom skills
139+
/overrides/ - Override core skills
140+
/mcp-servers/ - MCP server configurations
141+
```
142+
143+
### Manifest
144+
145+
The `.ai/manifest.json` file contains the complete AI integration configuration:
146+
147+
- **language**: Project language mode (boxlang, cfml, hybrid)
148+
- **templateType**: Application template (modern, flat)
149+
- **guidelines**: Array of installed guideline names
150+
- **skills**: Array of installed skill names
151+
- **agents**: Array of configured AI agents
152+
- **mcpServers**: Configured MCP documentation servers (core, module, custom)
153+
- **activeAgent**: Currently active AI agent (if set)
154+
- **lastSync**: Last synchronization timestamp
155+
156+
**Reading the manifest** helps you understand available resources and project configuration.
157+
158+
### Using Guidelines & Skills
159+
160+
- **Guidelines** provide framework documentation, conventions, and best practices
161+
- **Skills** offer step-by-step implementation patterns for common tasks
162+
- Consult relevant guidelines before implementing features
163+
- Load applicable skills when you need detailed how-to instructions
164+
121165
## Important Notes
122166

123167
- Framework reinit: Use `?fwreinit=true` or configure `reinitPassword` for production

templates/ai/agents/agent-modern-instructions.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,6 +159,50 @@ docker-compose logs -f
159159

160160
<!-- List external services, APIs, or integrations -->
161161

162+
## AI Integration
163+
164+
This project includes AI-powered development assistance with guidelines, skills, and MCP documentation servers.
165+
166+
### Directory Structure
167+
168+
```
169+
/.ai/
170+
/manifest.json - AI configuration (language, agents, guidelines, skills, MCP servers)
171+
/guidelines/ - Framework documentation and best practices
172+
/core/ - Core ColdBox/BoxLang guidelines
173+
/modules/ - Module-specific guidelines
174+
/custom/ - Your custom guidelines
175+
/overrides/ - Override core guidelines
176+
/skills/ - Implementation cookbooks (how-to guides)
177+
/core/ - Core development patterns
178+
/modules/ - Module-specific patterns
179+
/custom/ - Your custom skills
180+
/overrides/ - Override core skills
181+
/mcp-servers/ - MCP server configurations
182+
```
183+
184+
### Manifest
185+
186+
The `.ai/manifest.json` file contains the complete AI integration configuration:
187+
188+
- **language**: Project language mode (boxlang, cfml, hybrid)
189+
- **templateType**: Application template (modern, flat)
190+
- **guidelines**: Array of installed guideline names
191+
- **skills**: Array of installed skill names
192+
- **agents**: Array of configured AI agents
193+
- **mcpServers**: Configured MCP documentation servers (core, module, custom)
194+
- **activeAgent**: Currently active AI agent (if set)
195+
- **lastSync**: Last synchronization timestamp
196+
197+
**Reading the manifest** helps you understand available resources and project configuration.
198+
199+
### Using Guidelines & Skills
200+
201+
- **Guidelines** provide framework documentation, conventions, and best practices
202+
- **Skills** offer step-by-step implementation patterns for common tasks
203+
- Consult relevant guidelines before implementing features
204+
- Load applicable skills when you need detailed how-to instructions
205+
162206
## MCP Documentation Servers
163207

164208
This project has access to the following Model Context Protocol (MCP) documentation servers for live, up-to-date information:

0 commit comments

Comments
 (0)