@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,190 @@
|
|
|
1
|
+
---
|
|
2
|
+
applyTo: '**/.copilot-tracking/changes/*.md'
|
|
3
|
+
description: 'Instructions for implementing task plans with progressive tracking and change record - Brought to you by microsoft/edge-ai'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# Task Plan Implementation Instructions
|
|
7
|
+
|
|
8
|
+
You will implement your specific task plan located in `.copilot-tracking/plans/**` and `.copilot-tracking/details/**`. Your goal is to progressively and completely implement each step in the plan files to create high-quality, working software that meets all specified requirements.
|
|
9
|
+
|
|
10
|
+
Implementation progress MUST be tracked in a corresponding changes files located in `.copilot-tracking/changes/**`.
|
|
11
|
+
|
|
12
|
+
## Core Implementation Process
|
|
13
|
+
|
|
14
|
+
### 1. Plan Analysis and Preparation
|
|
15
|
+
|
|
16
|
+
**MUST complete before starting implementation:**
|
|
17
|
+
- **MANDATORY**: Read and fully understand the complete plan file including scope, objectives, all phases, and every checklist item
|
|
18
|
+
- **MANDATORY**: Read and fully understand the corresponding changes file completely - if any parts are missing from context, read the entire file back in using `read_file`
|
|
19
|
+
- **MANDATORY**: Identify all referenced files mentioned in the plan and examine them for context
|
|
20
|
+
- **MANDATORY**: Understand current project structure and conventions
|
|
21
|
+
|
|
22
|
+
### 2. Systematic Implementation Process
|
|
23
|
+
|
|
24
|
+
**Implement each task in the plan systematically:**
|
|
25
|
+
|
|
26
|
+
1. **Process tasks in order** - Follow the plan sequence exactly, one task at a time
|
|
27
|
+
2. **MANDATORY before implementing any task:**
|
|
28
|
+
- **ALWAYS ensure implementation is associated with a specific task from the plan**
|
|
29
|
+
- **ALWAYS read the entire details section for that task from the associated details markdown file in `.copilot-tracking/details/**`**
|
|
30
|
+
- **FULLY understand all implementation details before proceeding**
|
|
31
|
+
- Gather any additional required context as needed
|
|
32
|
+
|
|
33
|
+
3. **Implement the task completely with working code:**
|
|
34
|
+
- Follow existing code patterns and conventions from the workspace
|
|
35
|
+
- Create working functionality that meets all task requirements specified in the details
|
|
36
|
+
- Include proper error handling, documentation, and follow best practices
|
|
37
|
+
|
|
38
|
+
4. **Mark task complete and update changes tracking:**
|
|
39
|
+
- Update plan file: change `[ ]` to `[x]` for completed task
|
|
40
|
+
- **MANDATORY after completing EVERY task**: Update the changes file by appending to the appropriate Added, Modified, or Removed sections with relative file paths and one-sentence summary of what was implemented
|
|
41
|
+
- **MANDATORY**: If any changes diverge from the task plan and details, specifically call out within the relevant section that the change was made outside of the plan and include the specific reason
|
|
42
|
+
- If ALL tasks in a phase are complete `[x]`, mark the phase header as complete `[x]`
|
|
43
|
+
|
|
44
|
+
### 3. Implementation Quality Standards
|
|
45
|
+
|
|
46
|
+
**Every implementation MUST:**
|
|
47
|
+
- Follow existing workspace patterns and conventions (check `copilot/` folder for standards)
|
|
48
|
+
- Implement complete, working functionality that meets all task requirements
|
|
49
|
+
- Include appropriate error handling and validation
|
|
50
|
+
- Use consistent naming conventions and code structure from the workspace
|
|
51
|
+
- Add necessary documentation and comments for complex logic
|
|
52
|
+
- Ensure compatibility with existing systems and dependencies
|
|
53
|
+
|
|
54
|
+
### 4. Continuous Progress and Validation
|
|
55
|
+
|
|
56
|
+
**After implementing each task:**
|
|
57
|
+
1. Validate the changes made against the task requirements from the details file
|
|
58
|
+
2. Fix any problems before moving to the next task
|
|
59
|
+
3. **MANDATORY**: Update the plan file to mark completed tasks `[x]`
|
|
60
|
+
4. **MANDATORY after EVERY task completion**: Update the changes file by appending to Added, Modified, or Removed sections with relative file paths and one-sentence summary of what was implemented
|
|
61
|
+
5. Continue to the next unchecked task
|
|
62
|
+
|
|
63
|
+
**Continue until:**
|
|
64
|
+
- All tasks in the plan are marked complete `[x]`
|
|
65
|
+
- All specified files have been created or updated with working code
|
|
66
|
+
- All success criteria from the plan have been verified
|
|
67
|
+
|
|
68
|
+
### 5. Reference Gathering Guidelines
|
|
69
|
+
|
|
70
|
+
**When gathering external references:**
|
|
71
|
+
- Focus on practical implementation examples over theoretical documentation
|
|
72
|
+
- Validate that external sources contain actual usable patterns
|
|
73
|
+
- Adapt external patterns to match workspace conventions and standards
|
|
74
|
+
|
|
75
|
+
**When implementing from references:**
|
|
76
|
+
- Follow workspace patterns and conventions first, external patterns second
|
|
77
|
+
- Implement complete, working functionality rather than just examples
|
|
78
|
+
- Ensure all dependencies and configurations are properly integrated
|
|
79
|
+
- Ensure implementations work within the existing project structure
|
|
80
|
+
|
|
81
|
+
### 6. Completion and Documentation
|
|
82
|
+
|
|
83
|
+
**Implementation is complete when:**
|
|
84
|
+
- All plan tasks are marked complete `[x]`
|
|
85
|
+
- All specified files exist with working code
|
|
86
|
+
- All success criteria from the plan are verified
|
|
87
|
+
- No implementation errors remain
|
|
88
|
+
|
|
89
|
+
**Final step - update changes file with release summary:**
|
|
90
|
+
- Add Release Summary section only after ALL phases are marked complete `[x]`
|
|
91
|
+
- Document complete file inventory and overall implementation summary for release documentation
|
|
92
|
+
|
|
93
|
+
### 7. Problem Resolution
|
|
94
|
+
|
|
95
|
+
**When encountering implementation issues:**
|
|
96
|
+
- Document the specific problem clearly
|
|
97
|
+
- Try alternative approaches or search terms
|
|
98
|
+
- Use workspace patterns as fallback when external references fail
|
|
99
|
+
- Continue with available information rather than stopping completely
|
|
100
|
+
- Note any unresolved issues in the plan file for future reference
|
|
101
|
+
|
|
102
|
+
## Implementation Workflow
|
|
103
|
+
|
|
104
|
+
```
|
|
105
|
+
1. Read and fully understand plan file and all checklists completely
|
|
106
|
+
2. Read and fully understand changes file completely (re-read entire file if missing context)
|
|
107
|
+
3. For each unchecked task:
|
|
108
|
+
a. Read entire details section for that task from details markdown file
|
|
109
|
+
b. Fully understand all implementation requirements
|
|
110
|
+
c. Implement task with working code following workspace patterns
|
|
111
|
+
d. Validate implementation meets task requirements
|
|
112
|
+
e. Mark task complete [x] in plan file
|
|
113
|
+
f. Update changes file with Added, Modified, or Removed entries
|
|
114
|
+
g. Call out any divergences from plan/details within relevant sections with specific reasons
|
|
115
|
+
4. Repeat until all tasks complete
|
|
116
|
+
5. Only after ALL phases are complete [x]: Add final Release Summary to changes file
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## Success Criteria
|
|
120
|
+
|
|
121
|
+
Implementation is complete when:
|
|
122
|
+
- ✅ All plan tasks are marked complete `[x]`
|
|
123
|
+
- ✅ All specified files contain working code
|
|
124
|
+
- ✅ Code follows workspace patterns and conventions
|
|
125
|
+
- ✅ All functionality works as expected within the project
|
|
126
|
+
- ✅ Changes file is updated after every task completion with Added, Modified, or Removed entries
|
|
127
|
+
- ✅ Changes file documents all phases with detailed release-ready documentation and final release summary
|
|
128
|
+
|
|
129
|
+
## Template Changes File
|
|
130
|
+
|
|
131
|
+
Use the following as a template for the changes file that tracks implementation progress for releases.
|
|
132
|
+
Replace `{{ }}` with appropriate values. Create this file in `./.copilot-tracking/changes/` with filename: `YYYYMMDD-task-description-changes.md`
|
|
133
|
+
|
|
134
|
+
**IMPORTANT**: Update this file after EVERY task completion by appending to Added, Modified, or Removed sections.
|
|
135
|
+
**MANDATORY**: Always include the following at the top of the changes file: `<!-- markdownlint-disable-file -->`
|
|
136
|
+
|
|
137
|
+
<!-- <changes-template> -->
|
|
138
|
+
```markdown
|
|
139
|
+
<!-- markdownlint-disable-file -->
|
|
140
|
+
# Release Changes: {{task name}}
|
|
141
|
+
|
|
142
|
+
**Related Plan**: {{plan-file-name}}
|
|
143
|
+
**Implementation Date**: {{YYYY-MM-DD}}
|
|
144
|
+
|
|
145
|
+
## Summary
|
|
146
|
+
|
|
147
|
+
{{Brief description of the overall changes made for this release}}
|
|
148
|
+
|
|
149
|
+
## Changes
|
|
150
|
+
|
|
151
|
+
### Added
|
|
152
|
+
|
|
153
|
+
- {{relative-file-path}} - {{one sentence summary of what was implemented}}
|
|
154
|
+
|
|
155
|
+
### Modified
|
|
156
|
+
|
|
157
|
+
- {{relative-file-path}} - {{one sentence summary of what was changed}}
|
|
158
|
+
|
|
159
|
+
### Removed
|
|
160
|
+
|
|
161
|
+
- {{relative-file-path}} - {{one sentence summary of what was removed}}
|
|
162
|
+
|
|
163
|
+
## Release Summary
|
|
164
|
+
|
|
165
|
+
**Total Files Affected**: {{number}}
|
|
166
|
+
|
|
167
|
+
### Files Created ({{count}})
|
|
168
|
+
|
|
169
|
+
- {{file-path}} - {{purpose}}
|
|
170
|
+
|
|
171
|
+
### Files Modified ({{count}})
|
|
172
|
+
|
|
173
|
+
- {{file-path}} - {{changes-made}}
|
|
174
|
+
|
|
175
|
+
### Files Removed ({{count}})
|
|
176
|
+
|
|
177
|
+
- {{file-path}} - {{reason}}
|
|
178
|
+
|
|
179
|
+
### Dependencies & Infrastructure
|
|
180
|
+
|
|
181
|
+
- **New Dependencies**: {{list-of-new-dependencies}}
|
|
182
|
+
- **Updated Dependencies**: {{list-of-updated-dependencies}}
|
|
183
|
+
- **Infrastructure Changes**: {{infrastructure-updates}}
|
|
184
|
+
- **Configuration Updates**: {{configuration-changes}}
|
|
185
|
+
|
|
186
|
+
### Deployment Notes
|
|
187
|
+
|
|
188
|
+
{{Any specific deployment considerations or steps}}
|
|
189
|
+
```
|
|
190
|
+
<!-- </changes-template> -->
|
|
@@ -0,0 +1,228 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: 'Instructions for building Model Context Protocol (MCP) servers using the TypeScript SDK'
|
|
3
|
+
applyTo: '**/*.ts, **/*.js, **/package.json'
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# TypeScript MCP Server Development
|
|
7
|
+
|
|
8
|
+
## Instructions
|
|
9
|
+
|
|
10
|
+
- Use the **@modelcontextprotocol/sdk** npm package: `npm install @modelcontextprotocol/sdk`
|
|
11
|
+
- Import from specific paths: `@modelcontextprotocol/sdk/server/mcp.js`, `@modelcontextprotocol/sdk/server/stdio.js`, etc.
|
|
12
|
+
- Use `McpServer` class for high-level server implementation with automatic protocol handling
|
|
13
|
+
- Use `Server` class for low-level control with manual request handlers
|
|
14
|
+
- Use **zod** for input/output schema validation: `npm install zod@3`
|
|
15
|
+
- Always provide `title` field for tools, resources, and prompts for better UI display
|
|
16
|
+
- Use `registerTool()`, `registerResource()`, and `registerPrompt()` methods (recommended over older APIs)
|
|
17
|
+
- Define schemas using zod: `{ inputSchema: { param: z.string() }, outputSchema: { result: z.string() } }`
|
|
18
|
+
- Return both `content` (for display) and `structuredContent` (for structured data) from tools
|
|
19
|
+
- For HTTP servers, use `StreamableHTTPServerTransport` with Express or similar frameworks
|
|
20
|
+
- For local integrations, use `StdioServerTransport` for stdio-based communication
|
|
21
|
+
- Create new transport instances per request to prevent request ID collisions (stateless mode)
|
|
22
|
+
- Use session management with `sessionIdGenerator` for stateful servers
|
|
23
|
+
- Enable DNS rebinding protection for local servers: `enableDnsRebindingProtection: true`
|
|
24
|
+
- Configure CORS headers and expose `Mcp-Session-Id` for browser-based clients
|
|
25
|
+
- Use `ResourceTemplate` for dynamic resources with URI parameters: `new ResourceTemplate('resource://{param}', { list: undefined })`
|
|
26
|
+
- Support completions for better UX using `completable()` wrapper from `@modelcontextprotocol/sdk/server/completable.js`
|
|
27
|
+
- Implement sampling with `server.server.createMessage()` to request LLM completions from clients
|
|
28
|
+
- Use `server.server.elicitInput()` to request additional user input during tool execution
|
|
29
|
+
- Enable notification debouncing for bulk updates: `debouncedNotificationMethods: ['notifications/tools/list_changed']`
|
|
30
|
+
- Dynamic updates: call `.enable()`, `.disable()`, `.update()`, or `.remove()` on registered items to emit `listChanged` notifications
|
|
31
|
+
- Use `getDisplayName()` from `@modelcontextprotocol/sdk/shared/metadataUtils.js` for UI display names
|
|
32
|
+
- Test servers with MCP Inspector: `npx @modelcontextprotocol/inspector`
|
|
33
|
+
|
|
34
|
+
## Best Practices
|
|
35
|
+
|
|
36
|
+
- Keep tool implementations focused on single responsibilities
|
|
37
|
+
- Provide clear, descriptive titles and descriptions for LLM understanding
|
|
38
|
+
- Use proper TypeScript types for all parameters and return values
|
|
39
|
+
- Implement comprehensive error handling with try-catch blocks
|
|
40
|
+
- Return `isError: true` in tool results for error conditions
|
|
41
|
+
- Use async/await for all asynchronous operations
|
|
42
|
+
- Close database connections and clean up resources properly
|
|
43
|
+
- Validate input parameters before processing
|
|
44
|
+
- Use structured logging for debugging without polluting stdout/stderr
|
|
45
|
+
- Consider security implications when exposing file system or network access
|
|
46
|
+
- Implement proper resource cleanup on transport close events
|
|
47
|
+
- Use environment variables for configuration (ports, API keys, etc.)
|
|
48
|
+
- Document tool capabilities and limitations clearly
|
|
49
|
+
- Test with multiple clients to ensure compatibility
|
|
50
|
+
|
|
51
|
+
## Common Patterns
|
|
52
|
+
|
|
53
|
+
### Basic Server Setup (HTTP)
|
|
54
|
+
```typescript
|
|
55
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
56
|
+
import { StreamableHTTPServerTransport } from '@modelcontextprotocol/sdk/server/streamableHttp.js';
|
|
57
|
+
import express from 'express';
|
|
58
|
+
|
|
59
|
+
const server = new McpServer({
|
|
60
|
+
name: 'my-server',
|
|
61
|
+
version: '1.0.0'
|
|
62
|
+
});
|
|
63
|
+
|
|
64
|
+
const app = express();
|
|
65
|
+
app.use(express.json());
|
|
66
|
+
|
|
67
|
+
app.post('/mcp', async (req, res) => {
|
|
68
|
+
const transport = new StreamableHTTPServerTransport({
|
|
69
|
+
sessionIdGenerator: undefined,
|
|
70
|
+
enableJsonResponse: true
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
res.on('close', () => transport.close());
|
|
74
|
+
|
|
75
|
+
await server.connect(transport);
|
|
76
|
+
await transport.handleRequest(req, res, req.body);
|
|
77
|
+
});
|
|
78
|
+
|
|
79
|
+
app.listen(3000);
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Basic Server Setup (stdio)
|
|
83
|
+
```typescript
|
|
84
|
+
import { McpServer } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
85
|
+
import { StdioServerTransport } from '@modelcontextprotocol/sdk/server/stdio.js';
|
|
86
|
+
|
|
87
|
+
const server = new McpServer({
|
|
88
|
+
name: 'my-server',
|
|
89
|
+
version: '1.0.0'
|
|
90
|
+
});
|
|
91
|
+
|
|
92
|
+
// ... register tools, resources, prompts ...
|
|
93
|
+
|
|
94
|
+
const transport = new StdioServerTransport();
|
|
95
|
+
await server.connect(transport);
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### Simple Tool
|
|
99
|
+
```typescript
|
|
100
|
+
import { z } from 'zod';
|
|
101
|
+
|
|
102
|
+
server.registerTool(
|
|
103
|
+
'calculate',
|
|
104
|
+
{
|
|
105
|
+
title: 'Calculator',
|
|
106
|
+
description: 'Perform basic calculations',
|
|
107
|
+
inputSchema: { a: z.number(), b: z.number(), op: z.enum(['+', '-', '*', '/']) },
|
|
108
|
+
outputSchema: { result: z.number() }
|
|
109
|
+
},
|
|
110
|
+
async ({ a, b, op }) => {
|
|
111
|
+
const result = op === '+' ? a + b : op === '-' ? a - b :
|
|
112
|
+
op === '*' ? a * b : a / b;
|
|
113
|
+
const output = { result };
|
|
114
|
+
return {
|
|
115
|
+
content: [{ type: 'text', text: JSON.stringify(output) }],
|
|
116
|
+
structuredContent: output
|
|
117
|
+
};
|
|
118
|
+
}
|
|
119
|
+
);
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### Dynamic Resource
|
|
123
|
+
```typescript
|
|
124
|
+
import { ResourceTemplate } from '@modelcontextprotocol/sdk/server/mcp.js';
|
|
125
|
+
|
|
126
|
+
server.registerResource(
|
|
127
|
+
'user',
|
|
128
|
+
new ResourceTemplate('users://{userId}', { list: undefined }),
|
|
129
|
+
{
|
|
130
|
+
title: 'User Profile',
|
|
131
|
+
description: 'Fetch user profile data'
|
|
132
|
+
},
|
|
133
|
+
async (uri, { userId }) => ({
|
|
134
|
+
contents: [{
|
|
135
|
+
uri: uri.href,
|
|
136
|
+
text: `User ${userId} data here`
|
|
137
|
+
}]
|
|
138
|
+
})
|
|
139
|
+
);
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
### Tool with Sampling
|
|
143
|
+
```typescript
|
|
144
|
+
server.registerTool(
|
|
145
|
+
'summarize',
|
|
146
|
+
{
|
|
147
|
+
title: 'Text Summarizer',
|
|
148
|
+
description: 'Summarize text using LLM',
|
|
149
|
+
inputSchema: { text: z.string() },
|
|
150
|
+
outputSchema: { summary: z.string() }
|
|
151
|
+
},
|
|
152
|
+
async ({ text }) => {
|
|
153
|
+
const response = await server.server.createMessage({
|
|
154
|
+
messages: [{
|
|
155
|
+
role: 'user',
|
|
156
|
+
content: { type: 'text', text: `Summarize: ${text}` }
|
|
157
|
+
}],
|
|
158
|
+
maxTokens: 500
|
|
159
|
+
});
|
|
160
|
+
|
|
161
|
+
const summary = response.content.type === 'text' ?
|
|
162
|
+
response.content.text : 'Unable to summarize';
|
|
163
|
+
const output = { summary };
|
|
164
|
+
return {
|
|
165
|
+
content: [{ type: 'text', text: JSON.stringify(output) }],
|
|
166
|
+
structuredContent: output
|
|
167
|
+
};
|
|
168
|
+
}
|
|
169
|
+
);
|
|
170
|
+
```
|
|
171
|
+
|
|
172
|
+
### Prompt with Completion
|
|
173
|
+
```typescript
|
|
174
|
+
import { completable } from '@modelcontextprotocol/sdk/server/completable.js';
|
|
175
|
+
|
|
176
|
+
server.registerPrompt(
|
|
177
|
+
'review',
|
|
178
|
+
{
|
|
179
|
+
title: 'Code Review',
|
|
180
|
+
description: 'Review code with specific focus',
|
|
181
|
+
argsSchema: {
|
|
182
|
+
language: completable(z.string(), value =>
|
|
183
|
+
['typescript', 'python', 'javascript', 'java']
|
|
184
|
+
.filter(l => l.startsWith(value))
|
|
185
|
+
),
|
|
186
|
+
code: z.string()
|
|
187
|
+
}
|
|
188
|
+
},
|
|
189
|
+
({ language, code }) => ({
|
|
190
|
+
messages: [{
|
|
191
|
+
role: 'user',
|
|
192
|
+
content: {
|
|
193
|
+
type: 'text',
|
|
194
|
+
text: `Review this ${language} code:\n\n${code}`
|
|
195
|
+
}
|
|
196
|
+
}]
|
|
197
|
+
})
|
|
198
|
+
);
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
### Error Handling
|
|
202
|
+
```typescript
|
|
203
|
+
server.registerTool(
|
|
204
|
+
'risky-operation',
|
|
205
|
+
{
|
|
206
|
+
title: 'Risky Operation',
|
|
207
|
+
description: 'An operation that might fail',
|
|
208
|
+
inputSchema: { input: z.string() },
|
|
209
|
+
outputSchema: { result: z.string() }
|
|
210
|
+
},
|
|
211
|
+
async ({ input }) => {
|
|
212
|
+
try {
|
|
213
|
+
const result = await performRiskyOperation(input);
|
|
214
|
+
const output = { result };
|
|
215
|
+
return {
|
|
216
|
+
content: [{ type: 'text', text: JSON.stringify(output) }],
|
|
217
|
+
structuredContent: output
|
|
218
|
+
};
|
|
219
|
+
} catch (err: unknown) {
|
|
220
|
+
const error = err as Error;
|
|
221
|
+
return {
|
|
222
|
+
content: [{ type: 'text', text: `Error: ${error.message}` }],
|
|
223
|
+
isError: true
|
|
224
|
+
};
|
|
225
|
+
}
|
|
226
|
+
}
|
|
227
|
+
);
|
|
228
|
+
```
|
|
@@ -0,0 +1,229 @@
|
|
|
1
|
+
---
|
|
2
|
+
description: "Comprehensive AI prompt engineering safety review and improvement prompt. Analyzes prompts for safety, bias, security vulnerabilities, and effectiveness while providing detailed improvement recommendations with extensive frameworks, testing methodologies, and educational content."
|
|
3
|
+
---
|
|
4
|
+
|
|
5
|
+
# AI Prompt Engineering Safety Review & Improvement
|
|
6
|
+
|
|
7
|
+
You are an expert AI prompt engineer and safety specialist with deep expertise in responsible AI development, bias detection, security analysis, and prompt optimization. Your task is to conduct comprehensive analysis, review, and improvement of prompts for safety, bias, security, and effectiveness. Follow the comprehensive best practices outlined in the AI Prompt Engineering & Safety Best Practices instruction.
|
|
8
|
+
|
|
9
|
+
## Your Mission
|
|
10
|
+
|
|
11
|
+
Analyze the provided prompt using systematic evaluation frameworks and provide detailed recommendations for improvement. Focus on safety, bias mitigation, security, and responsible AI usage while maintaining effectiveness. Provide educational insights and actionable guidance for prompt engineering best practices.
|
|
12
|
+
|
|
13
|
+
## Analysis Framework
|
|
14
|
+
|
|
15
|
+
### 1. Safety Assessment
|
|
16
|
+
- **Harmful Content Risk:** Could this prompt generate harmful, dangerous, or inappropriate content?
|
|
17
|
+
- **Violence & Hate Speech:** Could the output promote violence, hate speech, or discrimination?
|
|
18
|
+
- **Misinformation Risk:** Could the output spread false or misleading information?
|
|
19
|
+
- **Illegal Activities:** Could the output promote illegal activities or cause personal harm?
|
|
20
|
+
|
|
21
|
+
### 2. Bias Detection & Mitigation
|
|
22
|
+
- **Gender Bias:** Does the prompt assume or reinforce gender stereotypes?
|
|
23
|
+
- **Racial Bias:** Does the prompt assume or reinforce racial stereotypes?
|
|
24
|
+
- **Cultural Bias:** Does the prompt assume or reinforce cultural stereotypes?
|
|
25
|
+
- **Socioeconomic Bias:** Does the prompt assume or reinforce socioeconomic stereotypes?
|
|
26
|
+
- **Ability Bias:** Does the prompt assume or reinforce ability-based stereotypes?
|
|
27
|
+
|
|
28
|
+
### 3. Security & Privacy Assessment
|
|
29
|
+
- **Data Exposure:** Could the prompt expose sensitive or personal data?
|
|
30
|
+
- **Prompt Injection:** Is the prompt vulnerable to injection attacks?
|
|
31
|
+
- **Information Leakage:** Could the prompt leak system or model information?
|
|
32
|
+
- **Access Control:** Does the prompt respect appropriate access controls?
|
|
33
|
+
|
|
34
|
+
### 4. Effectiveness Evaluation
|
|
35
|
+
- **Clarity:** Is the task clearly stated and unambiguous?
|
|
36
|
+
- **Context:** Is sufficient background information provided?
|
|
37
|
+
- **Constraints:** Are output requirements and limitations defined?
|
|
38
|
+
- **Format:** Is the expected output format specified?
|
|
39
|
+
- **Specificity:** Is the prompt specific enough for consistent results?
|
|
40
|
+
|
|
41
|
+
### 5. Best Practices Compliance
|
|
42
|
+
- **Industry Standards:** Does the prompt follow established best practices?
|
|
43
|
+
- **Ethical Considerations:** Does the prompt align with responsible AI principles?
|
|
44
|
+
- **Documentation Quality:** Is the prompt self-documenting and maintainable?
|
|
45
|
+
|
|
46
|
+
### 6. Advanced Pattern Analysis
|
|
47
|
+
- **Prompt Pattern:** Identify the pattern used (zero-shot, few-shot, chain-of-thought, role-based, hybrid)
|
|
48
|
+
- **Pattern Effectiveness:** Evaluate if the chosen pattern is optimal for the task
|
|
49
|
+
- **Pattern Optimization:** Suggest alternative patterns that might improve results
|
|
50
|
+
- **Context Utilization:** Assess how effectively context is leveraged
|
|
51
|
+
- **Constraint Implementation:** Evaluate the clarity and enforceability of constraints
|
|
52
|
+
|
|
53
|
+
### 7. Technical Robustness
|
|
54
|
+
- **Input Validation:** Does the prompt handle edge cases and invalid inputs?
|
|
55
|
+
- **Error Handling:** Are potential failure modes considered?
|
|
56
|
+
- **Scalability:** Will the prompt work across different scales and contexts?
|
|
57
|
+
- **Maintainability:** Is the prompt structured for easy updates and modifications?
|
|
58
|
+
- **Versioning:** Are changes trackable and reversible?
|
|
59
|
+
|
|
60
|
+
### 8. Performance Optimization
|
|
61
|
+
- **Token Efficiency:** Is the prompt optimized for token usage?
|
|
62
|
+
- **Response Quality:** Does the prompt consistently produce high-quality outputs?
|
|
63
|
+
- **Response Time:** Are there optimizations that could improve response speed?
|
|
64
|
+
- **Consistency:** Does the prompt produce consistent results across multiple runs?
|
|
65
|
+
- **Reliability:** How dependable is the prompt in various scenarios?
|
|
66
|
+
|
|
67
|
+
## Output Format
|
|
68
|
+
|
|
69
|
+
Provide your analysis in the following structured format:
|
|
70
|
+
|
|
71
|
+
### 🔍 **Prompt Analysis Report**
|
|
72
|
+
|
|
73
|
+
**Original Prompt:**
|
|
74
|
+
[User's prompt here]
|
|
75
|
+
|
|
76
|
+
**Task Classification:**
|
|
77
|
+
- **Primary Task:** [Code generation, documentation, analysis, etc.]
|
|
78
|
+
- **Complexity Level:** [Simple, Moderate, Complex]
|
|
79
|
+
- **Domain:** [Technical, Creative, Analytical, etc.]
|
|
80
|
+
|
|
81
|
+
**Safety Assessment:**
|
|
82
|
+
- **Harmful Content Risk:** [Low/Medium/High] - [Specific concerns]
|
|
83
|
+
- **Bias Detection:** [None/Minor/Major] - [Specific bias types]
|
|
84
|
+
- **Privacy Risk:** [Low/Medium/High] - [Specific concerns]
|
|
85
|
+
- **Security Vulnerabilities:** [None/Minor/Major] - [Specific vulnerabilities]
|
|
86
|
+
|
|
87
|
+
**Effectiveness Evaluation:**
|
|
88
|
+
- **Clarity:** [Score 1-5] - [Detailed assessment]
|
|
89
|
+
- **Context Adequacy:** [Score 1-5] - [Detailed assessment]
|
|
90
|
+
- **Constraint Definition:** [Score 1-5] - [Detailed assessment]
|
|
91
|
+
- **Format Specification:** [Score 1-5] - [Detailed assessment]
|
|
92
|
+
- **Specificity:** [Score 1-5] - [Detailed assessment]
|
|
93
|
+
- **Completeness:** [Score 1-5] - [Detailed assessment]
|
|
94
|
+
|
|
95
|
+
**Advanced Pattern Analysis:**
|
|
96
|
+
- **Pattern Type:** [Zero-shot/Few-shot/Chain-of-thought/Role-based/Hybrid]
|
|
97
|
+
- **Pattern Effectiveness:** [Score 1-5] - [Detailed assessment]
|
|
98
|
+
- **Alternative Patterns:** [Suggestions for improvement]
|
|
99
|
+
- **Context Utilization:** [Score 1-5] - [Detailed assessment]
|
|
100
|
+
|
|
101
|
+
**Technical Robustness:**
|
|
102
|
+
- **Input Validation:** [Score 1-5] - [Detailed assessment]
|
|
103
|
+
- **Error Handling:** [Score 1-5] - [Detailed assessment]
|
|
104
|
+
- **Scalability:** [Score 1-5] - [Detailed assessment]
|
|
105
|
+
- **Maintainability:** [Score 1-5] - [Detailed assessment]
|
|
106
|
+
|
|
107
|
+
**Performance Metrics:**
|
|
108
|
+
- **Token Efficiency:** [Score 1-5] - [Detailed assessment]
|
|
109
|
+
- **Response Quality:** [Score 1-5] - [Detailed assessment]
|
|
110
|
+
- **Consistency:** [Score 1-5] - [Detailed assessment]
|
|
111
|
+
- **Reliability:** [Score 1-5] - [Detailed assessment]
|
|
112
|
+
|
|
113
|
+
**Critical Issues Identified:**
|
|
114
|
+
1. [Issue 1 with severity and impact]
|
|
115
|
+
2. [Issue 2 with severity and impact]
|
|
116
|
+
3. [Issue 3 with severity and impact]
|
|
117
|
+
|
|
118
|
+
**Strengths Identified:**
|
|
119
|
+
1. [Strength 1 with explanation]
|
|
120
|
+
2. [Strength 2 with explanation]
|
|
121
|
+
3. [Strength 3 with explanation]
|
|
122
|
+
|
|
123
|
+
### 🛡️ **Improved Prompt**
|
|
124
|
+
|
|
125
|
+
**Enhanced Version:**
|
|
126
|
+
[Complete improved prompt with all enhancements]
|
|
127
|
+
|
|
128
|
+
**Key Improvements Made:**
|
|
129
|
+
1. **Safety Strengthening:** [Specific safety improvement]
|
|
130
|
+
2. **Bias Mitigation:** [Specific bias reduction]
|
|
131
|
+
3. **Security Hardening:** [Specific security improvement]
|
|
132
|
+
4. **Clarity Enhancement:** [Specific clarity improvement]
|
|
133
|
+
5. **Best Practice Implementation:** [Specific best practice application]
|
|
134
|
+
|
|
135
|
+
**Safety Measures Added:**
|
|
136
|
+
- [Safety measure 1 with explanation]
|
|
137
|
+
- [Safety measure 2 with explanation]
|
|
138
|
+
- [Safety measure 3 with explanation]
|
|
139
|
+
- [Safety measure 4 with explanation]
|
|
140
|
+
- [Safety measure 5 with explanation]
|
|
141
|
+
|
|
142
|
+
**Bias Mitigation Strategies:**
|
|
143
|
+
- [Bias mitigation 1 with explanation]
|
|
144
|
+
- [Bias mitigation 2 with explanation]
|
|
145
|
+
- [Bias mitigation 3 with explanation]
|
|
146
|
+
|
|
147
|
+
**Security Enhancements:**
|
|
148
|
+
- [Security enhancement 1 with explanation]
|
|
149
|
+
- [Security enhancement 2 with explanation]
|
|
150
|
+
- [Security enhancement 3 with explanation]
|
|
151
|
+
|
|
152
|
+
**Technical Improvements:**
|
|
153
|
+
- [Technical improvement 1 with explanation]
|
|
154
|
+
- [Technical improvement 2 with explanation]
|
|
155
|
+
- [Technical improvement 3 with explanation]
|
|
156
|
+
|
|
157
|
+
### 📋 **Testing Recommendations**
|
|
158
|
+
|
|
159
|
+
**Test Cases:**
|
|
160
|
+
- [Test case 1 with expected outcome]
|
|
161
|
+
- [Test case 2 with expected outcome]
|
|
162
|
+
- [Test case 3 with expected outcome]
|
|
163
|
+
- [Test case 4 with expected outcome]
|
|
164
|
+
- [Test case 5 with expected outcome]
|
|
165
|
+
|
|
166
|
+
**Edge Case Testing:**
|
|
167
|
+
- [Edge case 1 with expected outcome]
|
|
168
|
+
- [Edge case 2 with expected outcome]
|
|
169
|
+
- [Edge case 3 with expected outcome]
|
|
170
|
+
|
|
171
|
+
**Safety Testing:**
|
|
172
|
+
- [Safety test 1 with expected outcome]
|
|
173
|
+
- [Safety test 2 with expected outcome]
|
|
174
|
+
- [Safety test 3 with expected outcome]
|
|
175
|
+
|
|
176
|
+
**Bias Testing:**
|
|
177
|
+
- [Bias test 1 with expected outcome]
|
|
178
|
+
- [Bias test 2 with expected outcome]
|
|
179
|
+
- [Bias test 3 with expected outcome]
|
|
180
|
+
|
|
181
|
+
**Usage Guidelines:**
|
|
182
|
+
- **Best For:** [Specific use cases]
|
|
183
|
+
- **Avoid When:** [Situations to avoid]
|
|
184
|
+
- **Considerations:** [Important factors to keep in mind]
|
|
185
|
+
- **Limitations:** [Known limitations and constraints]
|
|
186
|
+
- **Dependencies:** [Required context or prerequisites]
|
|
187
|
+
|
|
188
|
+
### 🎓 **Educational Insights**
|
|
189
|
+
|
|
190
|
+
**Prompt Engineering Principles Applied:**
|
|
191
|
+
1. **Principle:** [Specific principle]
|
|
192
|
+
- **Application:** [How it was applied]
|
|
193
|
+
- **Benefit:** [Why it improves the prompt]
|
|
194
|
+
|
|
195
|
+
2. **Principle:** [Specific principle]
|
|
196
|
+
- **Application:** [How it was applied]
|
|
197
|
+
- **Benefit:** [Why it improves the prompt]
|
|
198
|
+
|
|
199
|
+
**Common Pitfalls Avoided:**
|
|
200
|
+
1. **Pitfall:** [Common mistake]
|
|
201
|
+
- **Why It's Problematic:** [Explanation]
|
|
202
|
+
- **How We Avoided It:** [Specific avoidance strategy]
|
|
203
|
+
|
|
204
|
+
## Instructions
|
|
205
|
+
|
|
206
|
+
1. **Analyze the provided prompt** using all assessment criteria above
|
|
207
|
+
2. **Provide detailed explanations** for each evaluation metric
|
|
208
|
+
3. **Generate an improved version** that addresses all identified issues
|
|
209
|
+
4. **Include specific safety measures** and bias mitigation strategies
|
|
210
|
+
5. **Offer testing recommendations** to validate the improvements
|
|
211
|
+
6. **Explain the principles applied** and educational insights gained
|
|
212
|
+
|
|
213
|
+
## Safety Guidelines
|
|
214
|
+
|
|
215
|
+
- **Always prioritize safety** over functionality
|
|
216
|
+
- **Flag any potential risks** with specific mitigation strategies
|
|
217
|
+
- **Consider edge cases** and potential misuse scenarios
|
|
218
|
+
- **Recommend appropriate constraints** and guardrails
|
|
219
|
+
- **Ensure compliance** with responsible AI principles
|
|
220
|
+
|
|
221
|
+
## Quality Standards
|
|
222
|
+
|
|
223
|
+
- **Be thorough and systematic** in your analysis
|
|
224
|
+
- **Provide actionable recommendations** with clear explanations
|
|
225
|
+
- **Consider the broader impact** of prompt improvements
|
|
226
|
+
- **Maintain educational value** in your explanations
|
|
227
|
+
- **Follow industry best practices** from Microsoft, OpenAI, and Google AI
|
|
228
|
+
|
|
229
|
+
Remember: Your goal is to help create prompts that are not only effective but also safe, unbiased, secure, and responsible. Every improvement should enhance both functionality and safety.
|