@totaland/create-starter-kit 1.0.0 → 2.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +130 -18
- package/bin/index.js +109 -21
- package/package.json +2 -2
- package/templates/backend/.github/agents/ /360/237/216/255 planner.agent.md" +92 -0
- package/templates/backend/.github/agents/api-architect.agent.md +41 -0
- package/templates/backend/.github/agents/code-reviewer.agent.md +26 -0
- package/templates/backend/.github/agents/code-simplifier.agent.md +41 -0
- package/templates/backend/.github/agents/code-skeptic.agent.md +74 -0
- package/templates/backend/.github/agents/docs-specialist.agent.md +25 -0
- package/templates/backend/.github/agents/implementation-plan.agent.md +160 -0
- package/templates/backend/.github/agents/janitor.agent.md +90 -0
- package/templates/backend/.github/agents/ms-sql-dba.agent.md +25 -0
- package/templates/backend/.github/agents/plan.agent.md +115 -0
- package/templates/backend/.github/agents/planner.agent.md +15 -0
- package/templates/backend/.github/agents/playwright-tester.agent.md +13 -0
- package/templates/backend/.github/agents/postgresql-dba.agent.md +18 -0
- package/templates/backend/.github/agents/prd.agent.md +202 -0
- package/templates/backend/.github/agents/research-technical-spike.agent.md +170 -0
- package/templates/backend/.github/agents/software-engineer-agent-v1.agent.md +165 -0
- package/templates/backend/.github/agents/task-planner.agent.md +375 -0
- package/templates/backend/.github/agents/task-researcher.agent.md +255 -0
- package/templates/backend/.github/agents/tdd-green.agent.md +60 -0
- package/templates/backend/.github/agents/tdd-red.agent.md +60 -0
- package/templates/backend/.github/agents/tdd-refactor.agent.md +85 -0
- package/templates/backend/.github/agents/tech-debt-remediation-plan.agent.md +50 -0
- package/templates/backend/.github/agents/typescript-mcp-expert.agent.md +91 -0
- package/templates/backend/.github/agents/ultimate-thinking-beastmode.agent.md +644 -0
- package/templates/backend/.github/agents//360/237/216/255 generator.agent.md" +264 -0
- package/templates/backend/.github/agents//360/237/216/255 healer.agent.md" +44 -0
- package/templates/backend/.github/agents//360/237/216/255 pom.agent.md" +308 -0
- package/templates/backend/.github/instructions/a11y.instructions.md +369 -0
- package/templates/backend/.github/instructions/ms-sql-dba.instructions.md +25 -0
- package/templates/backend/.github/instructions/object-calisthenics.instructions.md +302 -0
- package/templates/backend/.github/instructions/performance-optimization.instructions.md +420 -0
- package/templates/backend/.github/instructions/playwright-python.instructions.md +62 -0
- package/templates/backend/.github/instructions/playwright-typescript.instructions.md +86 -0
- package/templates/backend/.github/instructions/security-and-owasp.instructions.md +51 -0
- package/templates/backend/.github/instructions/self-explanatory-code-commenting.instructions.md +162 -0
- package/templates/backend/.github/instructions/spec-driven-workflow-v1.instructions.md +323 -0
- package/templates/backend/.github/instructions/sql-sp-generation.instructions.md +74 -0
- package/templates/backend/.github/instructions/task-implementation.instructions.md +190 -0
- package/templates/backend/.github/instructions/typescript-mcp-server.instructions.md +228 -0
- package/templates/backend/.github/prompts/ai-prompt-engineering-safety-review.prompt.md +229 -0
- package/templates/backend/.github/prompts/architecture-blueprint-generator.prompt.md +321 -0
- package/templates/backend/.github/prompts/breakdown-epic-arch.prompt.md +65 -0
- package/templates/backend/.github/prompts/breakdown-epic-pm.prompt.md +57 -0
- package/templates/backend/.github/prompts/breakdown-feature-implementation.prompt.md +127 -0
- package/templates/backend/.github/prompts/breakdown-feature-prd.prompt.md +60 -0
- package/templates/backend/.github/prompts/breakdown-plan.prompt.md +508 -0
- package/templates/backend/.github/prompts/copilot-instructions-blueprint-generator.prompt.md +293 -0
- package/templates/backend/.github/prompts/create-agentsmd.prompt.md +248 -0
- package/templates/backend/.github/prompts/create-github-issue-feature-from-specification.prompt.md +27 -0
- package/templates/backend/.github/prompts/create-github-issues-feature-from-implementation-plan.prompt.md +27 -0
- package/templates/backend/.github/prompts/create-github-issues-for-unmet-specification-requirements.prompt.md +35 -0
- package/templates/backend/.github/prompts/create-implementation-plan.prompt.md +156 -0
- package/templates/backend/.github/prompts/create-llms.prompt.md +209 -0
- package/templates/backend/.github/prompts/create-specification.prompt.md +126 -0
- package/templates/backend/.github/prompts/create-technical-spike.prompt.md +230 -0
- package/templates/backend/.github/prompts/csharp-nunit.prompt.md +71 -0
- package/templates/backend/.github/prompts/ef-core.prompt.md +76 -0
- package/templates/backend/.github/prompts/folder-structure-blueprint-generator.prompt.md +404 -0
- package/templates/backend/.github/prompts/gen-specs-as-issues.prompt.md +165 -0
- package/templates/backend/.github/prompts/generate-custom-instructions-from-codebase.prompt.md +239 -0
- package/templates/backend/.github/prompts/java-junit.prompt.md +64 -0
- package/templates/backend/.github/prompts/memory-merger.prompt.md +107 -0
- package/templates/backend/.github/prompts/multi-stage-dockerfile.prompt.md +46 -0
- package/templates/backend/.github/prompts/playwright-automation-fill-in-form.prompt.md +29 -0
- package/templates/backend/.github/prompts/playwright-explore-website.prompt.md +19 -0
- package/templates/backend/.github/prompts/playwright-generate-test.prompt.md +19 -0
- package/templates/backend/.github/prompts/postgresql-code-review.prompt.md +214 -0
- package/templates/backend/.github/prompts/postgresql-optimization.prompt.md +406 -0
- package/templates/backend/.github/prompts/project-workflow-analysis-blueprint-generator.prompt.md +294 -0
- package/templates/backend/.github/prompts/prompt-builder.prompt.md +142 -0
- package/templates/backend/.github/prompts/remember.prompt.md +125 -0
- package/templates/backend/.github/prompts/review-and-refactor.prompt.md +15 -0
- package/templates/backend/.github/prompts/sql-code-review.prompt.md +303 -0
- package/templates/backend/.github/prompts/sql-optimization.prompt.md +298 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md +72 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +71 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-collections.prompt.md +149 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-instructions.prompt.md +88 -0
- package/templates/backend/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md +71 -0
- package/templates/backend/.github/prompts/technology-stack-blueprint-generator.prompt.md +242 -0
- package/templates/backend/.github/prompts/typescript-mcp-server-generator.prompt.md +90 -0
- package/templates/backend/.github/prompts/update-implementation-plan.prompt.md +157 -0
- package/templates/backend/.github/prompts/update-markdown-file-index.prompt.md +76 -0
- package/templates/backend/Project_Folders_Structure_Blueprint.md +529 -0
- package/templates/backend/README.md +99 -0
- package/templates/backend/biome.json +45 -0
- package/{template → templates/backend}/drizzle.config.ts +1 -1
- package/{template → templates/backend}/package.json +9 -4
- package/templates/backend/pnpm-lock.yaml +4240 -0
- package/templates/backend/src/features/health/health.test.ts +23 -0
- package/{template → templates/backend}/src/features/health/index.ts +1 -0
- package/templates/backend/src/features/health/schemas.ts +29 -0
- package/templates/backend/src/features/orders/controller.ts +18 -0
- package/templates/backend/src/features/orders/index.ts +10 -0
- package/templates/backend/src/features/orders/schemas.ts +62 -0
- package/{template → templates/backend}/src/index.ts +3 -36
- package/templates/backend/src/lib/openapi.ts +25 -0
- package/templates/backend/src/lib/validateRequest.test.ts +84 -0
- package/templates/backend/src/lib/validateRequest.ts +72 -0
- package/{template → templates/backend}/tsconfig.json +2 -2
- package/{template → templates/backend}/vitest.config.ts +8 -1
- package/templates/frontend/.env.example +7 -0
- package/templates/frontend/.github/agents/ /360/237/216/255 planner.agent.md" +92 -0
- package/templates/frontend/.github/agents/api-architect.agent.md +41 -0
- package/templates/frontend/.github/agents/code-reviewer.agent.md +26 -0
- package/templates/frontend/.github/agents/code-simplifier.agent.md +41 -0
- package/templates/frontend/.github/agents/code-skeptic.agent.md +74 -0
- package/templates/frontend/.github/agents/docs-specialist.agent.md +25 -0
- package/templates/frontend/.github/agents/implementation-plan.agent.md +160 -0
- package/templates/frontend/.github/agents/janitor.agent.md +90 -0
- package/templates/frontend/.github/agents/ms-sql-dba.agent.md +25 -0
- package/templates/frontend/.github/agents/plan.agent.md +115 -0
- package/templates/frontend/.github/agents/planner.agent.md +15 -0
- package/templates/frontend/.github/agents/playwright-tester.agent.md +13 -0
- package/templates/frontend/.github/agents/postgresql-dba.agent.md +18 -0
- package/templates/frontend/.github/agents/prd.agent.md +202 -0
- package/templates/frontend/.github/agents/research-technical-spike.agent.md +170 -0
- package/templates/frontend/.github/agents/software-engineer-agent-v1.agent.md +165 -0
- package/templates/frontend/.github/agents/task-planner.agent.md +375 -0
- package/templates/frontend/.github/agents/task-researcher.agent.md +255 -0
- package/templates/frontend/.github/agents/tdd-green.agent.md +60 -0
- package/templates/frontend/.github/agents/tdd-red.agent.md +60 -0
- package/templates/frontend/.github/agents/tdd-refactor.agent.md +85 -0
- package/templates/frontend/.github/agents/tech-debt-remediation-plan.agent.md +50 -0
- package/templates/frontend/.github/agents/typescript-mcp-expert.agent.md +91 -0
- package/templates/frontend/.github/agents/ultimate-thinking-beastmode.agent.md +644 -0
- package/templates/frontend/.github/agents//360/237/216/255 generator.agent.md" +264 -0
- package/templates/frontend/.github/agents//360/237/216/255 healer.agent.md" +44 -0
- package/templates/frontend/.github/agents//360/237/216/255 pom.agent.md" +308 -0
- package/templates/frontend/.github/instructions/a11y.instructions.md +369 -0
- package/templates/frontend/.github/instructions/ms-sql-dba.instructions.md +25 -0
- package/templates/frontend/.github/instructions/object-calisthenics.instructions.md +302 -0
- package/templates/frontend/.github/instructions/performance-optimization.instructions.md +420 -0
- package/templates/frontend/.github/instructions/playwright-python.instructions.md +62 -0
- package/templates/frontend/.github/instructions/playwright-typescript.instructions.md +86 -0
- package/templates/frontend/.github/instructions/security-and-owasp.instructions.md +51 -0
- package/templates/frontend/.github/instructions/self-explanatory-code-commenting.instructions.md +162 -0
- package/templates/frontend/.github/instructions/spec-driven-workflow-v1.instructions.md +323 -0
- package/templates/frontend/.github/instructions/sql-sp-generation.instructions.md +74 -0
- package/templates/frontend/.github/instructions/task-implementation.instructions.md +190 -0
- package/templates/frontend/.github/instructions/typescript-mcp-server.instructions.md +228 -0
- package/templates/frontend/.github/prompts/ai-prompt-engineering-safety-review.prompt.md +229 -0
- package/templates/frontend/.github/prompts/architecture-blueprint-generator.prompt.md +321 -0
- package/templates/frontend/.github/prompts/breakdown-epic-arch.prompt.md +65 -0
- package/templates/frontend/.github/prompts/breakdown-epic-pm.prompt.md +57 -0
- package/templates/frontend/.github/prompts/breakdown-feature-implementation.prompt.md +127 -0
- package/templates/frontend/.github/prompts/breakdown-feature-prd.prompt.md +60 -0
- package/templates/frontend/.github/prompts/breakdown-plan.prompt.md +508 -0
- package/templates/frontend/.github/prompts/copilot-instructions-blueprint-generator.prompt.md +293 -0
- package/templates/frontend/.github/prompts/create-agentsmd.prompt.md +248 -0
- package/templates/frontend/.github/prompts/create-github-issue-feature-from-specification.prompt.md +27 -0
- package/templates/frontend/.github/prompts/create-github-issues-feature-from-implementation-plan.prompt.md +27 -0
- package/templates/frontend/.github/prompts/create-github-issues-for-unmet-specification-requirements.prompt.md +35 -0
- package/templates/frontend/.github/prompts/create-implementation-plan.prompt.md +156 -0
- package/templates/frontend/.github/prompts/create-llms.prompt.md +209 -0
- package/templates/frontend/.github/prompts/create-specification.prompt.md +126 -0
- package/templates/frontend/.github/prompts/create-technical-spike.prompt.md +230 -0
- package/templates/frontend/.github/prompts/csharp-nunit.prompt.md +71 -0
- package/templates/frontend/.github/prompts/ef-core.prompt.md +76 -0
- package/templates/frontend/.github/prompts/folder-structure-blueprint-generator.prompt.md +404 -0
- package/templates/frontend/.github/prompts/gen-specs-as-issues.prompt.md +165 -0
- package/templates/frontend/.github/prompts/generate-custom-instructions-from-codebase.prompt.md +239 -0
- package/templates/frontend/.github/prompts/java-junit.prompt.md +64 -0
- package/templates/frontend/.github/prompts/memory-merger.prompt.md +107 -0
- package/templates/frontend/.github/prompts/multi-stage-dockerfile.prompt.md +46 -0
- package/templates/frontend/.github/prompts/playwright-automation-fill-in-form.prompt.md +29 -0
- package/templates/frontend/.github/prompts/playwright-explore-website.prompt.md +19 -0
- package/templates/frontend/.github/prompts/playwright-generate-test.prompt.md +19 -0
- package/templates/frontend/.github/prompts/postgresql-code-review.prompt.md +214 -0
- package/templates/frontend/.github/prompts/postgresql-optimization.prompt.md +406 -0
- package/templates/frontend/.github/prompts/project-workflow-analysis-blueprint-generator.prompt.md +294 -0
- package/templates/frontend/.github/prompts/prompt-builder.prompt.md +142 -0
- package/templates/frontend/.github/prompts/remember.prompt.md +125 -0
- package/templates/frontend/.github/prompts/review-and-refactor.prompt.md +15 -0
- package/templates/frontend/.github/prompts/sql-code-review.prompt.md +303 -0
- package/templates/frontend/.github/prompts/sql-optimization.prompt.md +298 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-agents.prompt.md +72 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-chatmodes.prompt.md +71 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-collections.prompt.md +149 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-instructions.prompt.md +88 -0
- package/templates/frontend/.github/prompts/suggest-awesome-github-copilot-prompts.prompt.md +71 -0
- package/templates/frontend/.github/prompts/technology-stack-blueprint-generator.prompt.md +242 -0
- package/templates/frontend/.github/prompts/typescript-mcp-server-generator.prompt.md +90 -0
- package/templates/frontend/.github/prompts/update-implementation-plan.prompt.md +157 -0
- package/templates/frontend/.github/prompts/update-markdown-file-index.prompt.md +76 -0
- package/templates/frontend/README.md +199 -0
- package/templates/frontend/biome.json +45 -0
- package/templates/frontend/components.json +22 -0
- package/templates/frontend/index.html +13 -0
- package/templates/frontend/package.json +44 -0
- package/templates/frontend/pnpm-lock.yaml +2011 -0
- package/templates/frontend/postcss.config.js +6 -0
- package/templates/frontend/public/vite.svg +1 -0
- package/templates/frontend/src/App.css +42 -0
- package/templates/frontend/src/App.tsx +17 -0
- package/templates/frontend/src/assets/react.svg +1 -0
- package/templates/frontend/src/components/layout/layout.component.tsx +31 -0
- package/templates/frontend/src/components/menu-toggle-icon.tsx +53 -0
- package/templates/frontend/src/components/ui/button.tsx +57 -0
- package/templates/frontend/src/docs/RECOMMENDED_LIBRARIES.md +226 -0
- package/templates/frontend/src/docs/SETUP_SUMMARY.md +162 -0
- package/templates/frontend/src/hooks/use-scroll.ts +21 -0
- package/templates/frontend/src/index.css +121 -0
- package/templates/frontend/src/lib/api-client.ts +46 -0
- package/templates/frontend/src/lib/utils.ts +6 -0
- package/templates/frontend/src/main.tsx +30 -0
- package/templates/frontend/src/pages/about/about.page.tsx +50 -0
- package/templates/frontend/src/pages/home/home.page.tsx +43 -0
- package/templates/frontend/tailwind.config.js +59 -0
- package/templates/frontend/tsconfig.app.json +41 -0
- package/templates/frontend/tsconfig.json +13 -0
- package/templates/frontend/tsconfig.node.json +26 -0
- package/templates/frontend/vite.config.ts +14 -0
- package/template/.env.example +0 -8
- package/template/AGENTS.md +0 -23
- package/template/ARCHITECTURE.md +0 -53
- package/template/ORDER_SYSTEM.md +0 -93
- package/template/biome.json +0 -3
- package/template/src/features/orders/controller.ts +0 -13
- package/template/src/features/orders/index.ts +0 -7
- /package/{template → templates/backend}/knip.json +0 -0
- /package/{template → templates/backend}/playwright.config.ts +0 -0
- /package/{template → templates/backend}/pnpm-workspace.yaml +0 -0
- /package/{template → templates/backend}/src/features/health/controller.ts +0 -0
- /package/{template → templates/backend}/tsconfig.build.json +0 -0
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Generate a complete MCP server project in TypeScript with tools, resources, and proper configuration'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Generate TypeScript MCP Server
|
|
7
|
+
|
|
8
|
+
Create a complete Model Context Protocol (MCP) server in TypeScript with the following specifications:
|
|
9
|
+
|
|
10
|
+
## Requirements
|
|
11
|
+
|
|
12
|
+
1. **Project Structure**: Create a new TypeScript/Node.js project with proper directory structure
|
|
13
|
+
2. **NPM Packages**: Include @modelcontextprotocol/sdk, zod@3, and either express (for HTTP) or stdio support
|
|
14
|
+
3. **TypeScript Configuration**: Proper tsconfig.json with ES modules support
|
|
15
|
+
4. **Server Type**: Choose between HTTP (with Streamable HTTP transport) or stdio-based server
|
|
16
|
+
5. **Tools**: Create at least one useful tool with proper schema validation
|
|
17
|
+
6. **Error Handling**: Include comprehensive error handling and validation
|
|
18
|
+
|
|
19
|
+
## Implementation Details
|
|
20
|
+
|
|
21
|
+
### Project Setup
|
|
22
|
+
- Initialize with `npm init` and create package.json
|
|
23
|
+
- Install dependencies: `@modelcontextprotocol/sdk`, `zod@3`, and transport-specific packages
|
|
24
|
+
- Configure TypeScript with ES modules: `"type": "module"` in package.json
|
|
25
|
+
- Add dev dependencies: `tsx` or `ts-node` for development
|
|
26
|
+
- Create proper .gitignore file
|
|
27
|
+
|
|
28
|
+
### Server Configuration
|
|
29
|
+
- Use `McpServer` class for high-level implementation
|
|
30
|
+
- Set server name and version
|
|
31
|
+
- Choose appropriate transport (StreamableHTTPServerTransport or StdioServerTransport)
|
|
32
|
+
- For HTTP: set up Express with proper middleware and error handling
|
|
33
|
+
- For stdio: use StdioServerTransport directly
|
|
34
|
+
|
|
35
|
+
### Tool Implementation
|
|
36
|
+
- Use `registerTool()` method with descriptive names
|
|
37
|
+
- Define schemas using zod for input and output validation
|
|
38
|
+
- Provide clear `title` and `description` fields
|
|
39
|
+
- Return both `content` and `structuredContent` in results
|
|
40
|
+
- Implement proper error handling with try-catch blocks
|
|
41
|
+
- Support async operations where appropriate
|
|
42
|
+
|
|
43
|
+
### Resource/Prompt Setup (Optional)
|
|
44
|
+
- Add resources using `registerResource()` with ResourceTemplate for dynamic URIs
|
|
45
|
+
- Add prompts using `registerPrompt()` with argument schemas
|
|
46
|
+
- Consider adding completion support for better UX
|
|
47
|
+
|
|
48
|
+
### Code Quality
|
|
49
|
+
- Use TypeScript for type safety
|
|
50
|
+
- Follow async/await patterns consistently
|
|
51
|
+
- Implement proper cleanup on transport close events
|
|
52
|
+
- Use environment variables for configuration
|
|
53
|
+
- Add inline comments for complex logic
|
|
54
|
+
- Structure code with clear separation of concerns
|
|
55
|
+
|
|
56
|
+
## Example Tool Types to Consider
|
|
57
|
+
- Data processing and transformation
|
|
58
|
+
- External API integrations
|
|
59
|
+
- File system operations (read, search, analyze)
|
|
60
|
+
- Database queries
|
|
61
|
+
- Text analysis or summarization (with sampling)
|
|
62
|
+
- System information retrieval
|
|
63
|
+
|
|
64
|
+
## Configuration Options
|
|
65
|
+
- **For HTTP Servers**:
|
|
66
|
+
- Port configuration via environment variables
|
|
67
|
+
- CORS setup for browser clients
|
|
68
|
+
- Session management (stateless vs stateful)
|
|
69
|
+
- DNS rebinding protection for local servers
|
|
70
|
+
|
|
71
|
+
- **For stdio Servers**:
|
|
72
|
+
- Proper stdin/stdout handling
|
|
73
|
+
- Environment-based configuration
|
|
74
|
+
- Process lifecycle management
|
|
75
|
+
|
|
76
|
+
## Testing Guidance
|
|
77
|
+
- Explain how to run the server (`npm start` or `npx tsx server.ts`)
|
|
78
|
+
- Provide MCP Inspector command: `npx @modelcontextprotocol/inspector`
|
|
79
|
+
- For HTTP servers, include connection URL: `http://localhost:PORT/mcp`
|
|
80
|
+
- Include example tool invocations
|
|
81
|
+
- Add troubleshooting tips for common issues
|
|
82
|
+
|
|
83
|
+
## Additional Features to Consider
|
|
84
|
+
- Sampling support for LLM-powered tools
|
|
85
|
+
- User input elicitation for interactive workflows
|
|
86
|
+
- Dynamic tool registration with enable/disable capabilities
|
|
87
|
+
- Notification debouncing for bulk updates
|
|
88
|
+
- Resource links for efficient data references
|
|
89
|
+
|
|
90
|
+
Generate a complete, production-ready MCP server with comprehensive documentation, type safety, and error handling.
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Update an existing implementation plan file with new or update requirements to provide new features, refactoring existing code or upgrading packages, design, architecture or infrastructure.'
|
|
4
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'githubRepo', 'openSimpleBrowser', 'problems', 'runTasks', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
5
|
+
---
|
|
6
|
+
# Update Implementation Plan
|
|
7
|
+
|
|
8
|
+
## Primary Directive
|
|
9
|
+
|
|
10
|
+
You are an AI agent tasked with updating the implementation plan file `${file}` based on new or updated requirements. Your output must be machine-readable, deterministic, and structured for autonomous execution by other AI systems or humans.
|
|
11
|
+
|
|
12
|
+
## Execution Context
|
|
13
|
+
|
|
14
|
+
This prompt is designed for AI-to-AI communication and automated processing. All instructions must be interpreted literally and executed systematically without human interpretation or clarification.
|
|
15
|
+
|
|
16
|
+
## Core Requirements
|
|
17
|
+
|
|
18
|
+
- Generate implementation plans that are fully executable by AI agents or humans
|
|
19
|
+
- Use deterministic language with zero ambiguity
|
|
20
|
+
- Structure all content for automated parsing and execution
|
|
21
|
+
- Ensure complete self-containment with no external dependencies for understanding
|
|
22
|
+
|
|
23
|
+
## Plan Structure Requirements
|
|
24
|
+
|
|
25
|
+
Plans must consist of discrete, atomic phases containing executable tasks. Each phase must be independently processable by AI agents or humans without cross-phase dependencies unless explicitly declared.
|
|
26
|
+
|
|
27
|
+
## Phase Architecture
|
|
28
|
+
|
|
29
|
+
- Each phase must have measurable completion criteria
|
|
30
|
+
- Tasks within phases must be executable in parallel unless dependencies are specified
|
|
31
|
+
- All task descriptions must include specific file paths, function names, and exact implementation details
|
|
32
|
+
- No task should require human interpretation or decision-making
|
|
33
|
+
|
|
34
|
+
## AI-Optimized Implementation Standards
|
|
35
|
+
|
|
36
|
+
- Use explicit, unambiguous language with zero interpretation required
|
|
37
|
+
- Structure all content as machine-parseable formats (tables, lists, structured data)
|
|
38
|
+
- Include specific file paths, line numbers, and exact code references where applicable
|
|
39
|
+
- Define all variables, constants, and configuration values explicitly
|
|
40
|
+
- Provide complete context within each task description
|
|
41
|
+
- Use standardized prefixes for all identifiers (REQ-, TASK-, etc.)
|
|
42
|
+
- Include validation criteria that can be automatically verified
|
|
43
|
+
|
|
44
|
+
## Output File Specifications
|
|
45
|
+
|
|
46
|
+
- Save implementation plan files in `/plan/` directory
|
|
47
|
+
- Use naming convention: `[purpose]-[component]-[version].md`
|
|
48
|
+
- Purpose prefixes: `upgrade|refactor|feature|data|infrastructure|process|architecture|design`
|
|
49
|
+
- Example: `upgrade-system-command-4.md`, `feature-auth-module-1.md`
|
|
50
|
+
- File must be valid Markdown with proper front matter structure
|
|
51
|
+
|
|
52
|
+
## Mandatory Template Structure
|
|
53
|
+
|
|
54
|
+
All implementation plans must strictly adhere to the following template. Each section is required and must be populated with specific, actionable content. AI agents must validate template compliance before execution.
|
|
55
|
+
|
|
56
|
+
## Template Validation Rules
|
|
57
|
+
|
|
58
|
+
- All front matter fields must be present and properly formatted
|
|
59
|
+
- All section headers must match exactly (case-sensitive)
|
|
60
|
+
- All identifier prefixes must follow the specified format
|
|
61
|
+
- Tables must include all required columns
|
|
62
|
+
- No placeholder text may remain in the final output
|
|
63
|
+
|
|
64
|
+
## Status
|
|
65
|
+
|
|
66
|
+
The status of the implementation plan must be clearly defined in the front matter and must reflect the current state of the plan. The status can be one of the following (status_color in brackets): `Completed` (bright green badge), `In progress` (yellow badge), `Planned` (blue badge), `Deprecated` (red badge), or `On Hold` (orange badge). It should also be displayed as a badge in the introduction section.
|
|
67
|
+
|
|
68
|
+
```md
|
|
69
|
+
---
|
|
70
|
+
goal: [Concise Title Describing the Package Implementation Plan's Goal]
|
|
71
|
+
version: [Optional: e.g., 1.0, Date]
|
|
72
|
+
date_created: [YYYY-MM-DD]
|
|
73
|
+
last_updated: [Optional: YYYY-MM-DD]
|
|
74
|
+
owner: [Optional: Team/Individual responsible for this spec]
|
|
75
|
+
status: 'Completed'|'In progress'|'Planned'|'Deprecated'|'On Hold'
|
|
76
|
+
tags: [Optional: List of relevant tags or categories, e.g., `feature`, `upgrade`, `chore`, `architecture`, `migration`, `bug` etc]
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
# Introduction
|
|
80
|
+
|
|
81
|
+

|
|
82
|
+
|
|
83
|
+
[A short concise introduction to the plan and the goal it is intended to achieve.]
|
|
84
|
+
|
|
85
|
+
## 1. Requirements & Constraints
|
|
86
|
+
|
|
87
|
+
[Explicitly list all requirements & constraints that affect the plan and constrain how it is implemented. Use bullet points or tables for clarity.]
|
|
88
|
+
|
|
89
|
+
- **REQ-001**: Requirement 1
|
|
90
|
+
- **SEC-001**: Security Requirement 1
|
|
91
|
+
- **[3 LETTERS]-001**: Other Requirement 1
|
|
92
|
+
- **CON-001**: Constraint 1
|
|
93
|
+
- **GUD-001**: Guideline 1
|
|
94
|
+
- **PAT-001**: Pattern to follow 1
|
|
95
|
+
|
|
96
|
+
## 2. Implementation Steps
|
|
97
|
+
|
|
98
|
+
### Implementation Phase 1
|
|
99
|
+
|
|
100
|
+
- GOAL-001: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
101
|
+
|
|
102
|
+
| Task | Description | Completed | Date |
|
|
103
|
+
|------|-------------|-----------|------|
|
|
104
|
+
| TASK-001 | Description of task 1 | ✅ | 2025-04-25 |
|
|
105
|
+
| TASK-002 | Description of task 2 | | |
|
|
106
|
+
| TASK-003 | Description of task 3 | | |
|
|
107
|
+
|
|
108
|
+
### Implementation Phase 2
|
|
109
|
+
|
|
110
|
+
- GOAL-002: [Describe the goal of this phase, e.g., "Implement feature X", "Refactor module Y", etc.]
|
|
111
|
+
|
|
112
|
+
| Task | Description | Completed | Date |
|
|
113
|
+
|------|-------------|-----------|------|
|
|
114
|
+
| TASK-004 | Description of task 4 | | |
|
|
115
|
+
| TASK-005 | Description of task 5 | | |
|
|
116
|
+
| TASK-006 | Description of task 6 | | |
|
|
117
|
+
|
|
118
|
+
## 3. Alternatives
|
|
119
|
+
|
|
120
|
+
[A bullet point list of any alternative approaches that were considered and why they were not chosen. This helps to provide context and rationale for the chosen approach.]
|
|
121
|
+
|
|
122
|
+
- **ALT-001**: Alternative approach 1
|
|
123
|
+
- **ALT-002**: Alternative approach 2
|
|
124
|
+
|
|
125
|
+
## 4. Dependencies
|
|
126
|
+
|
|
127
|
+
[List any dependencies that need to be addressed, such as libraries, frameworks, or other components that the plan relies on.]
|
|
128
|
+
|
|
129
|
+
- **DEP-001**: Dependency 1
|
|
130
|
+
- **DEP-002**: Dependency 2
|
|
131
|
+
|
|
132
|
+
## 5. Files
|
|
133
|
+
|
|
134
|
+
[List the files that will be affected by the feature or refactoring task.]
|
|
135
|
+
|
|
136
|
+
- **FILE-001**: Description of file 1
|
|
137
|
+
- **FILE-002**: Description of file 2
|
|
138
|
+
|
|
139
|
+
## 6. Testing
|
|
140
|
+
|
|
141
|
+
[List the tests that need to be implemented to verify the feature or refactoring task.]
|
|
142
|
+
|
|
143
|
+
- **TEST-001**: Description of test 1
|
|
144
|
+
- **TEST-002**: Description of test 2
|
|
145
|
+
|
|
146
|
+
## 7. Risks & Assumptions
|
|
147
|
+
|
|
148
|
+
[List any risks or assumptions related to the implementation of the plan.]
|
|
149
|
+
|
|
150
|
+
- **RISK-001**: Risk 1
|
|
151
|
+
- **ASSUMPTION-001**: Assumption 1
|
|
152
|
+
|
|
153
|
+
## 8. Related Specifications / Further Reading
|
|
154
|
+
|
|
155
|
+
[Link to related spec 1]
|
|
156
|
+
[Link to relevant external documentation]
|
|
157
|
+
```
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
---
|
|
2
|
+
mode: 'agent'
|
|
3
|
+
description: 'Update a markdown file section with an index/table of files from a specified folder.'
|
|
4
|
+
tools: ['changes', 'search/codebase', 'edit/editFiles', 'extensions', 'fetch', 'findTestFiles', 'githubRepo', 'openSimpleBrowser', 'problems', 'runCommands', 'runTasks', 'runTests', 'search', 'search/searchResults', 'runCommands/terminalLastCommand', 'runCommands/terminalSelection', 'testFailure', 'usages', 'vscodeAPI']
|
|
5
|
+
---
|
|
6
|
+
# Update Markdown File Index
|
|
7
|
+
|
|
8
|
+
Update markdown file `${file}` with an index/table of files from folder `${input:folder}`.
|
|
9
|
+
|
|
10
|
+
## Process
|
|
11
|
+
|
|
12
|
+
1. **Scan**: Read the target markdown file `${file}` to understand existing structure
|
|
13
|
+
2. **Discover**: List all files in the specified folder `${input:folder}` matching pattern `${input:pattern}`
|
|
14
|
+
3. **Analyze**: Identify if an existing table/index section exists to update, or create new structure
|
|
15
|
+
4. **Structure**: Generate appropriate table/list format based on file types and existing content
|
|
16
|
+
5. **Update**: Replace existing section or add new section with file index
|
|
17
|
+
6. **Validate**: Ensure markdown syntax is valid and formatting is consistent
|
|
18
|
+
|
|
19
|
+
## File Analysis
|
|
20
|
+
|
|
21
|
+
For each discovered file, extract:
|
|
22
|
+
|
|
23
|
+
- **Name**: Filename with or without extension based on context
|
|
24
|
+
- **Type**: File extension and category (e.g., `.md`, `.js`, `.py`)
|
|
25
|
+
- **Description**: First line comment, header, or inferred purpose
|
|
26
|
+
- **Size**: File size for reference (optional)
|
|
27
|
+
- **Modified**: Last modified date (optional)
|
|
28
|
+
|
|
29
|
+
## Table Structure Options
|
|
30
|
+
|
|
31
|
+
Choose format based on file types and existing content:
|
|
32
|
+
|
|
33
|
+
### Option 1: Simple List
|
|
34
|
+
|
|
35
|
+
```markdown
|
|
36
|
+
## Files in ${folder}
|
|
37
|
+
|
|
38
|
+
- [filename.ext](path/to/filename.ext) - Description
|
|
39
|
+
- [filename2.ext](path/to/filename2.ext) - Description
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
### Option 2: Detailed Table
|
|
43
|
+
|
|
44
|
+
| File | Type | Description |
|
|
45
|
+
|------|------|-------------|
|
|
46
|
+
| [filename.ext](path/to/filename.ext) | Extension | Description |
|
|
47
|
+
| [filename2.ext](path/to/filename2.ext) | Extension | Description |
|
|
48
|
+
|
|
49
|
+
### Option 3: Categorized Sections
|
|
50
|
+
|
|
51
|
+
Group files by type/category with separate sections or sub-tables.
|
|
52
|
+
|
|
53
|
+
## Update Strategy
|
|
54
|
+
|
|
55
|
+
- 🔄 **Update existing**: If table/index section exists, replace content while preserving structure
|
|
56
|
+
- ➕ **Add new**: If no existing section, create new section using best-fit format
|
|
57
|
+
- 📋 **Preserve**: Maintain existing markdown formatting, heading levels, and document flow
|
|
58
|
+
- 🔗 **Links**: Use relative paths for file links within the repository
|
|
59
|
+
|
|
60
|
+
## Section Identification
|
|
61
|
+
|
|
62
|
+
Look for existing sections with these patterns:
|
|
63
|
+
|
|
64
|
+
- Headings containing: "index", "files", "contents", "directory", "list"
|
|
65
|
+
- Tables with file-related columns
|
|
66
|
+
- Lists with file links
|
|
67
|
+
- HTML comments marking file index sections
|
|
68
|
+
|
|
69
|
+
## Requirements
|
|
70
|
+
|
|
71
|
+
- Preserve existing markdown structure and formatting
|
|
72
|
+
- Use relative paths for file links
|
|
73
|
+
- Include file descriptions when available
|
|
74
|
+
- Sort files alphabetically by default
|
|
75
|
+
- Handle special characters in filenames
|
|
76
|
+
- Validate all generated markdown syntax
|