superkit-mcp-server 1.2.2 → 1.2.3

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.
Files changed (170) hide show
  1. package/ARCHITECTURE.md +102 -102
  2. package/README.md +71 -71
  3. package/SUPERKIT.md +168 -168
  4. package/agents/code-archaeologist.md +106 -106
  5. package/agents/coder.md +90 -90
  6. package/agents/data-engineer.md +28 -28
  7. package/agents/devops-engineer.md +242 -242
  8. package/agents/git-manager.md +203 -203
  9. package/agents/orchestrator.md +420 -420
  10. package/agents/penetration-tester.md +188 -188
  11. package/agents/performance-optimizer.md +187 -187
  12. package/agents/planner.md +270 -270
  13. package/agents/qa-automation-engineer.md +103 -103
  14. package/agents/quant-developer.md +32 -32
  15. package/agents/reviewer.md +100 -100
  16. package/agents/scout.md +222 -222
  17. package/agents/security-auditor.md +3 -2
  18. package/agents/tester.md +274 -274
  19. package/agents/ui-designer.md +208 -208
  20. package/build/index.js +18 -9
  21. package/build/tools/__tests__/loggerTools.test.js +5 -5
  22. package/build/tools/archTools.js +2 -19
  23. package/build/tools/autoPreview.js +2 -2
  24. package/build/tools/compoundTools.js +4 -4
  25. package/build/tools/docsTools.js +5 -10
  26. package/build/tools/loggerTools.js +1 -1
  27. package/build/tools/todoTools.js +39 -39
  28. package/build/tools/validators/__tests__/apiSchema.test.js +23 -23
  29. package/build/tools/validators/__tests__/convertRules.test.js +5 -5
  30. package/build/tools/validators/__tests__/frontendDesign.test.js +12 -12
  31. package/build/tools/validators/__tests__/geoChecker.test.js +19 -19
  32. package/build/tools/validators/__tests__/mobileAudit.test.js +12 -12
  33. package/build/tools/validators/__tests__/reactPerformanceChecker.test.js +17 -17
  34. package/build/tools/validators/__tests__/securityScan.test.js +6 -6
  35. package/build/tools/validators/__tests__/seoChecker.test.js +16 -16
  36. package/build/tools/validators/__tests__/typeCoverage.test.js +14 -14
  37. package/build/tools/validators/convertRules.js +2 -2
  38. package/commands/README.md +122 -122
  39. package/commands/ask.toml +72 -72
  40. package/commands/brainstorm.toml +119 -119
  41. package/commands/chat.toml +77 -77
  42. package/commands/code-preview.toml +37 -37
  43. package/commands/code.toml +28 -28
  44. package/commands/content.toml +200 -200
  45. package/commands/cook.toml +77 -77
  46. package/commands/copywrite.toml +131 -131
  47. package/commands/db.toml +192 -192
  48. package/commands/debug.toml +166 -166
  49. package/commands/design.toml +158 -158
  50. package/commands/dev-rules.toml +14 -14
  51. package/commands/do.toml +117 -117
  52. package/commands/doc-rules.toml +14 -14
  53. package/commands/docs.toml +148 -148
  54. package/commands/fix.toml +440 -440
  55. package/commands/fullstack.toml +175 -175
  56. package/commands/git.toml +235 -235
  57. package/commands/help.toml +84 -84
  58. package/commands/integrate.toml +127 -127
  59. package/commands/journal.toml +136 -136
  60. package/commands/kit-setup.toml +40 -40
  61. package/commands/mcp.toml +183 -183
  62. package/commands/orchestration.toml +15 -15
  63. package/commands/plan.toml +171 -171
  64. package/commands/pm.toml +148 -148
  65. package/commands/pr.toml +50 -50
  66. package/commands/project.toml +32 -32
  67. package/commands/research.toml +117 -117
  68. package/commands/review-pr.toml +63 -63
  69. package/commands/review.toml +190 -190
  70. package/commands/scout-ext.toml +97 -97
  71. package/commands/scout.toml +79 -79
  72. package/commands/screenshot.toml +65 -65
  73. package/commands/session.toml +102 -102
  74. package/commands/skill.toml +384 -384
  75. package/commands/status.toml +22 -22
  76. package/commands/team.toml +56 -56
  77. package/commands/test.toml +164 -164
  78. package/commands/ticket.toml +70 -70
  79. package/commands/use.toml +106 -106
  80. package/commands/video.toml +83 -83
  81. package/commands/watzup.toml +71 -71
  82. package/commands/workflow.toml +14 -14
  83. package/package.json +35 -35
  84. package/skills/meta/README.md +30 -30
  85. package/skills/meta/api-design/SKILL.md +134 -134
  86. package/skills/meta/code-review/SKILL.md +44 -44
  87. package/skills/meta/code-review/checklists/pre-merge.md +25 -25
  88. package/skills/meta/code-review/workflows/architecture-pass.md +26 -26
  89. package/skills/meta/code-review/workflows/performance-pass.md +27 -27
  90. package/skills/meta/code-review/workflows/security-pass.md +29 -29
  91. package/skills/meta/compound-docs/SKILL.md +133 -133
  92. package/skills/meta/debug/SKILL.md +40 -40
  93. package/skills/meta/debug/templates/bug-report.template.md +31 -31
  94. package/skills/meta/debug/workflows/reproduce-issue.md +20 -20
  95. package/skills/meta/docker/SKILL.md +126 -126
  96. package/skills/meta/examples/supabase/SKILL.md +46 -46
  97. package/skills/meta/examples/supabase/references/best-practices.md +319 -319
  98. package/skills/meta/examples/supabase/references/common-patterns.md +373 -373
  99. package/skills/meta/examples/supabase/templates/migration-template.sql +49 -49
  100. package/skills/meta/examples/supabase/templates/rls-policy-template.sql +77 -77
  101. package/skills/meta/examples/supabase/workflows/debugging.md +260 -260
  102. package/skills/meta/examples/supabase/workflows/migration-workflow.md +211 -211
  103. package/skills/meta/examples/supabase/workflows/rls-policies.md +244 -244
  104. package/skills/meta/examples/supabase/workflows/schema-design.md +321 -321
  105. package/skills/meta/file-todos/SKILL.md +88 -88
  106. package/skills/meta/mobile/SKILL.md +140 -140
  107. package/skills/meta/nextjs/SKILL.md +101 -101
  108. package/skills/meta/performance/SKILL.md +130 -130
  109. package/skills/meta/react-patterns/SKILL.md +83 -83
  110. package/skills/meta/security/SKILL.md +114 -114
  111. package/skills/meta/session-resume/SKILL.md +96 -96
  112. package/skills/meta/tailwind/SKILL.md +139 -139
  113. package/skills/meta/testing/SKILL.md +43 -43
  114. package/skills/meta/testing/references/vitest-patterns.md +45 -45
  115. package/skills/meta/testing/templates/component-test.template.tsx +37 -37
  116. package/skills/tech/alpha-vantage/SKILL.md +142 -142
  117. package/skills/tech/alpha-vantage/references/commodities.md +153 -153
  118. package/skills/tech/alpha-vantage/references/economic-indicators.md +158 -158
  119. package/skills/tech/alpha-vantage/references/forex-crypto.md +154 -154
  120. package/skills/tech/alpha-vantage/references/fundamentals.md +223 -223
  121. package/skills/tech/alpha-vantage/references/intelligence.md +138 -138
  122. package/skills/tech/alpha-vantage/references/options.md +93 -93
  123. package/skills/tech/alpha-vantage/references/technical-indicators.md +374 -374
  124. package/skills/tech/alpha-vantage/references/time-series.md +157 -157
  125. package/skills/tech/doc.md +6 -6
  126. package/skills/tech/financial-modeling/SKILL.md +18 -18
  127. package/skills/tech/financial-modeling/skills/3-statements/SKILL.md +368 -368
  128. package/skills/tech/financial-modeling/skills/3-statements/references/formatting.md +118 -118
  129. package/skills/tech/financial-modeling/skills/3-statements/references/formulas.md +292 -292
  130. package/skills/tech/financial-modeling/skills/3-statements/references/sec-filings.md +125 -125
  131. package/skills/tech/financial-modeling/skills/dcf-model/SKILL.md +1210 -1210
  132. package/skills/tech/financial-modeling/skills/dcf-model/TROUBLESHOOTING.md +40 -40
  133. package/skills/tech/financial-modeling/skills/dcf-model/requirements.txt +8 -8
  134. package/skills/tech/financial-modeling/skills/dcf-model/scripts/validate_dcf.py +292 -292
  135. package/skills/tech/financial-modeling/skills/lbo-model/SKILL.md +236 -236
  136. package/skills/tech/financial-modeling/skills/merger-model/SKILL.md +108 -108
  137. package/skills/workflows/README.md +203 -203
  138. package/skills/workflows/adr.md +174 -174
  139. package/skills/workflows/changelog.md +74 -74
  140. package/skills/workflows/compound.md +323 -323
  141. package/skills/workflows/compound_health.md +74 -74
  142. package/skills/workflows/create-agent-skill.md +138 -139
  143. package/skills/workflows/cycle.md +144 -144
  144. package/skills/workflows/deploy-docs.md +84 -84
  145. package/skills/workflows/development-rules.md +42 -42
  146. package/skills/workflows/doc.md +95 -95
  147. package/skills/workflows/documentation-management.md +34 -34
  148. package/skills/workflows/explore.md +146 -146
  149. package/skills/workflows/generate_command.md +106 -106
  150. package/skills/workflows/heal-skill.md +97 -97
  151. package/skills/workflows/housekeeping.md +229 -229
  152. package/skills/workflows/kit-setup.md +102 -102
  153. package/skills/workflows/map-codebase.md +78 -78
  154. package/skills/workflows/orchestration-protocol.md +43 -43
  155. package/skills/workflows/plan-compound.md +439 -439
  156. package/skills/workflows/plan_review.md +269 -269
  157. package/skills/workflows/primary-workflow.md +37 -37
  158. package/skills/workflows/promote_pattern.md +86 -86
  159. package/skills/workflows/release-docs.md +82 -82
  160. package/skills/workflows/report-bug.md +135 -135
  161. package/skills/workflows/reproduce-bug.md +118 -118
  162. package/skills/workflows/resolve_pr.md +133 -133
  163. package/skills/workflows/resolve_todo.md +128 -128
  164. package/skills/workflows/review-compound.md +376 -376
  165. package/skills/workflows/skill-review.md +127 -127
  166. package/skills/workflows/specs.md +257 -257
  167. package/skills/workflows/triage-sprint.md +102 -102
  168. package/skills/workflows/triage.md +152 -152
  169. package/skills/workflows/work.md +399 -399
  170. package/skills/workflows/xcode-test.md +93 -93
package/ARCHITECTURE.md CHANGED
@@ -1,102 +1,102 @@
1
- # Super-Kit Architecture
2
-
3
- > Comprehensive AI Agent Capability Expansion Toolkit
4
-
5
- ---
6
-
7
- ## 📋 Overview
8
-
9
- Super-Kit is a model-agnostic and agent-agnostic toolkit designed to provide a highly structured engineering loop alongside granular domain expertise.
10
-
11
- - **Super Engineers & Domain Specialists** - A T-shaped team of AI personas.
12
- - **Categorized Skills** - Technical knowledge, meta-engineering, and workflow instructions.
13
- - **Unified Workflows** - Slash command procedures driving the Compound Engineering Loop.
14
-
15
- ---
16
-
17
- ## 🏗️ Directory Structure
18
-
19
- ```plaintext
20
- super-kit/
21
- ├── ARCHITECTURE.md # This file
22
- ├── SUPERKIT.md # Global rules and activation protocol
23
- ├── .core/ # Core engine-independent logic
24
- │ ├── rules/ # Universal mandates (e.g., clean-code, security-first)
25
- ├── agents/ # The T-Shaped AI Team Personas
26
- ├── skills/ # The Knowledge Modules
27
- │ ├── meta/ # Session-resume, compound-docs, file-todos
28
- │ ├── tech/ # Node.js, React, Python, Prisma
29
- │ └── workflows/ # TDD, CI/CD, Code Review checklists
30
- └── workflows/ # Slash commands and lifecycle loops
31
- ```
32
-
33
- ---
34
-
35
- ## 🤖 Agents
36
-
37
- Super-Kit provides a T-Shaped AI team: a core engineering team focused on process, supported by deep domain specialists.
38
-
39
- ### Core Team (Process Execution)
40
- - `planner`: Creates detailed implementation plans.
41
- - `scout`: Explores the codebase and resolves dependencies.
42
- - `coder`: Writes clean, efficient code following patterns.
43
- - `tester`: Writes unit tests and ensures quality.
44
- - `reviewer`: Suggests improvements and ensures security.
45
- - `git-manager`: Manages version control operations.
46
- - `orchestrator`: Coordinates complex, multi-agent tasks.
47
-
48
- ### Domain Specialists (Context & Logic)
49
- - `database-architect`: Database schema, scaling, and ORM usage (Prisma, SQL).
50
- - `security-auditor`: Comprehensive security audits, OWASP checks.
51
- - `frontend-specialist`: React, Next.js, and complex UI/UX architectures.
52
- - `backend-specialist`: API layers, microservices, and Node.js/Python servers.
53
- - `ui-designer`: Visual layouts, animations, and Tailwind integrations.
54
-
55
- ### Fintech Specialists
56
- - `data-engineer`: ETL pipelines, data scaling, idempotency.
57
- - `quant-developer`: Financial modeling, backtesting engines, and low-latency systems.
58
-
59
- *(Note: Generic tasks invoke the `coder`, who leverages `database-architect` and `quant-developer` knowledge contextually.)*
60
-
61
- ---
62
-
63
- ## 🧩 Skills
64
-
65
- Skills are context blocks loaded by Agents based on the active task.
66
-
67
- ### Tech Skills (`skills/tech/`)
68
- Contains granular knowledge bases for specific tools (e.g., `react-best-practices`, `api-patterns`, `python-patterns`, `docker-expert`).
69
-
70
- ### Meta Skills (`skills/meta/`)
71
- Contains lifecycle operation patterns (e.g., `session-resume`, `compound-docs`, `file-todos`) to ensure knowledge is carried across sessions.
72
-
73
- ---
74
-
75
- ## 🔄 Workflows
76
-
77
- Workflows are standard operating procedures invoked via slash commands (e.g. `/plan`, `/work`, `/compound`, `/explore`).
78
-
79
- ### The Compound Loop
80
- The primary operating directive for building sustainable software:
81
- `/explore` → `/plan` → `/work` → `/review` → `/compound`
82
-
83
- 1. **Explore**: Investigate the codebase and gather requirements.
84
- 2. **Plan**: Write the task boundaries and solution architecture.
85
- 3. **Work**: The Core Team executes code generation.
86
- 4. **Review**: Automated auditing via `src/tools/checklist.ts`.
87
- 5. **Compound**: Output reusable solutions to `docs/solutions/`.
88
-
89
- ## ⚙️ Usage & Agnosticism
90
-
91
- Super-Kit is designed to be injected into any agentic platform (Cline, Cursor, Gemini, Aider, GitHub Copilot).
92
- The entry point is reading `SUPERKIT.md` to establish global rules.
93
-
94
- ### How to Point Changing Agents to the Entrypoint:
95
-
96
- - **Standard Agents**: Reference `@SUPERKIT.md` in your prompt, or set its content as your persistent user rules for the project.
97
- - **Cursor/Windsurf**: Reference `@SUPERKIT.md` in your Composer/Chat, or set the content of `SUPERKIT.md` as your project's `.cursorrules` / `.windsurfrules`.
98
- - **Cline (VS Code)**: Set the content of `SUPERKIT.md` as your custom instructions in the Cline settings, or add an `@SUPERKIT.md` command in your prompt.
99
- - **Gemini / Google AI Studio**: Supply `SUPERKIT.md` as your System Prompt instructions.
100
- - **Aider**: Run aider with the message `aider --message "Read SUPERKIT.md for your system instructions before doing anything else."`
101
-
102
- Once the agent has loaded `SUPERKIT.md`, it will follow the instructions to activate the appropriate `@agent` which dynamically reads `SKILL.md` from the relevant directories.
1
+ # Super-Kit Architecture
2
+
3
+ > Comprehensive AI Agent Capability Expansion Toolkit
4
+
5
+ ---
6
+
7
+ ## 📋 Overview
8
+
9
+ Super-Kit is a model-agnostic and agent-agnostic toolkit designed to provide a highly structured engineering loop alongside granular domain expertise.
10
+
11
+ - **Super Engineers & Domain Specialists** - A T-shaped team of AI personas.
12
+ - **Categorized Skills** - Technical knowledge, meta-engineering, and workflow instructions.
13
+ - **Unified Workflows** - Slash command procedures driving the Compound Engineering Loop.
14
+
15
+ ---
16
+
17
+ ## 🏗️ Directory Structure
18
+
19
+ ```plaintext
20
+ super-kit/
21
+ ├── ARCHITECTURE.md # This file
22
+ ├── SUPERKIT.md # Global rules and activation protocol
23
+ ├── .core/ # Core engine-independent logic
24
+ │ ├── rules/ # Universal mandates (e.g., clean-code, security-first)
25
+ ├── agents/ # The T-Shaped AI Team Personas
26
+ ├── skills/ # The Knowledge Modules
27
+ │ ├── meta/ # Session-resume, compound-docs, file-todos
28
+ │ ├── tech/ # Node.js, React, Python, Prisma
29
+ │ └── workflows/ # TDD, CI/CD, Code Review checklists
30
+ └── workflows/ # Slash commands and lifecycle loops
31
+ ```
32
+
33
+ ---
34
+
35
+ ## 🤖 Agents
36
+
37
+ Super-Kit provides a T-Shaped AI team: a core engineering team focused on process, supported by deep domain specialists.
38
+
39
+ ### Core Team (Process Execution)
40
+ - `planner`: Creates detailed implementation plans.
41
+ - `scout`: Explores the codebase and resolves dependencies.
42
+ - `coder`: Writes clean, efficient code following patterns.
43
+ - `tester`: Writes unit tests and ensures quality.
44
+ - `reviewer`: Suggests improvements and ensures security.
45
+ - `git-manager`: Manages version control operations.
46
+ - `orchestrator`: Coordinates complex, multi-agent tasks.
47
+
48
+ ### Domain Specialists (Context & Logic)
49
+ - `database-architect`: Database schema, scaling, and ORM usage (Prisma, SQL).
50
+ - `security-auditor`: Comprehensive security audits, OWASP checks.
51
+ - `frontend-specialist`: React, Next.js, and complex UI/UX architectures.
52
+ - `backend-specialist`: API layers, microservices, and Node.js/Python servers.
53
+ - `ui-designer`: Visual layouts, animations, and Tailwind integrations.
54
+
55
+ ### Fintech Specialists
56
+ - `data-engineer`: ETL pipelines, data scaling, idempotency.
57
+ - `quant-developer`: Financial modeling, backtesting engines, and low-latency systems.
58
+
59
+ *(Note: Generic tasks invoke the `coder`, who leverages `database-architect` and `quant-developer` knowledge contextually.)*
60
+
61
+ ---
62
+
63
+ ## 🧩 Skills
64
+
65
+ Skills are context blocks loaded by Agents based on the active task.
66
+
67
+ ### Tech Skills (`skills/tech/`)
68
+ Contains granular knowledge bases for specific tools (e.g., `react-best-practices`, `api-patterns`, `python-patterns`, `docker-expert`).
69
+
70
+ ### Meta Skills (`skills/meta/`)
71
+ Contains lifecycle operation patterns (e.g., `session-resume`, `compound-docs`, `file-todos`) to ensure knowledge is carried across sessions.
72
+
73
+ ---
74
+
75
+ ## 🔄 Workflows
76
+
77
+ Workflows are standard operating procedures invoked via slash commands (e.g. `/plan`, `/work`, `/compound`, `/explore`).
78
+
79
+ ### The Compound Loop
80
+ The primary operating directive for building sustainable software:
81
+ `/explore` → `/plan` → `/work` → `/review` → `/compound`
82
+
83
+ 1. **Explore**: Investigate the codebase and gather requirements.
84
+ 2. **Plan**: Write the task boundaries and solution architecture.
85
+ 3. **Work**: The Core Team executes code generation.
86
+ 4. **Review**: Automated auditing via `src/tools/checklist.ts`.
87
+ 5. **Compound**: Output reusable solutions to `docs/solutions/`.
88
+
89
+ ## ⚙️ Usage & Agnosticism
90
+
91
+ Super-Kit is designed to be injected into any agentic platform (Cline, Cursor, Gemini, Aider, GitHub Copilot).
92
+ The entry point is reading `SUPERKIT.md` to establish global rules.
93
+
94
+ ### How to Point Changing Agents to the Entrypoint:
95
+
96
+ - **Standard Agents**: Reference `@SUPERKIT.md` in your prompt, or set its content as your persistent user rules for the project.
97
+ - **Cursor/Windsurf**: Reference `@SUPERKIT.md` in your Composer/Chat, or set the content of `SUPERKIT.md` as your project's `.cursorrules` / `.windsurfrules`.
98
+ - **Cline (VS Code)**: Set the content of `SUPERKIT.md` as your custom instructions in the Cline settings, or add an `@SUPERKIT.md` command in your prompt.
99
+ - **Gemini / Google AI Studio**: Supply `SUPERKIT.md` as your System Prompt instructions.
100
+ - **Aider**: Run aider with the message `aider --message "Read SUPERKIT.md for your system instructions before doing anything else."`
101
+
102
+ Once the agent has loaded `SUPERKIT.md`, it will follow the instructions to activate the appropriate `@agent` which dynamically reads `SKILL.md` from the relevant directories.
package/README.md CHANGED
@@ -1,71 +1,71 @@
1
- # Super-Kit
2
-
3
- Super-Kit is a modular repository containing instructions, workflows, skills, and specializations for AI coding agents. By structuring AI agent contexts into individual files, it allows large language model agents to load specific knowledge on the fly instead of relying on massive and bloated static system prompts.
4
-
5
- While the primary purpose is to compund the knowledge of engineering, I will add more domains as I see fit.
6
-
7
- 🔗 **GitHub Repository:** [dgkngk/super-kit](https://github.com/dgkngk/super-kit)
8
-
9
- 🔗 **NPM Package:** [superkit-mcp-server](https://www.npmjs.com/package/superkit-mcp-server)
10
-
11
- ## Directory Structure
12
- - `agents/`: Contains instructions and guidelines for specialized AI roles (e.g., `data-engineer`).
13
- - `skills/`: Contains technology-specific or meta skills (patterns, best practices) the agent can load dynamically (e.g., `react-best-practices`).
14
- - `workflows/`: Contains step-by-step interactive slash-commands to guide the AI workflow (e.g., `/plan`, `/explore`).
15
- - `src/`: The Model Context Protocol (MCP) server that exposes all these assets directly to compatible AI platforms.
16
-
17
- ## Providing the Kit to Your AI
18
-
19
- The easiest way to power up your agent with this toolkit is to use the included MCP server.
20
-
21
- You can launch it directly using `npx`:
22
-
23
- ```bash
24
- npx -y superkit-mcp-server
25
- ```
26
-
27
- ## Available Tools
28
-
29
- - **`list_superkit_assets`**: Lists all available agents, skills (tech/meta), and workflows in the Super-Kit repository.
30
- - **`load_superkit_agent`**: Loads the system instructions and guidelines for a specific specialist agent (e.g., `data-engineer`).
31
- - **`load_superkit_skill`**: Loads the skill instructions (`SKILL.md`) for a specific category and skill (e.g., category: `tech`, name: `react-best-practices`).
32
- - **`load_superkit_workflow`**: Loads the instructions for a specific slash-command workflow (e.g., `work`, `explore`).
33
- - **`call_tool_checklist`**: Executes the native TypeScript validation suite (security, web accessibility, react performance, testing, API structure) on a target project location via the MCP environment instead of generic bash loops.
34
-
35
- ## Available Prompts
36
-
37
- The Super-Kit MCP server exposes all workflows inside the `workflows/` directory dynamically as **MCP Prompts**. AI agents can invoke `GetPromptRequestSchema` to instantly load complex workflows (e.g., `plan-compound`, `review-compound`) along with their security and validation tooling straight into their context.
38
-
39
- ## Manual Installation and Configuration
40
-
41
- If you cloned this repository locally, you can build and use the MCP server directly:
42
-
43
- ```bash
44
- cd super-kit
45
- npm install
46
- npm run build
47
- ```
48
-
49
- ### Configuring in AI Platforms
50
-
51
- #### Cline / Roo (VS Code)
52
- Add the following to your `cline_mcp_settings.json`:
53
- ```json
54
- {
55
- "mcpServers": {
56
- "superkit": {
57
- "command": "node",
58
- "args": ["/absolute/path/to/super-kit/build/index.js"]
59
- }
60
- }
61
- }
62
- ```
63
-
64
- #### Cursor / Windsurf
65
- Go to Settings -> Features -> MCP Servers.
66
- Add a new stdio server:
67
- - Name: `superkit`
68
- - Command: `node /absolute/path/to/super-kit/build/index.js`
69
-
70
- ## How it works
71
- The built-in MCP server reads directly from the `super-kit` directory, resolving paths safely to prevent traversal attacks. It automatically parses and returns the Markdown contents of the structural elements so your AI agent always has the right context in mind.
1
+ # Super-Kit
2
+
3
+ Super-Kit is a modular repository containing instructions, workflows, skills, and specializations for AI coding agents. By structuring AI agent contexts into individual files, it allows large language model agents to load specific knowledge on the fly instead of relying on massive and bloated static system prompts.
4
+
5
+ While the primary purpose is to compund the knowledge of engineering, I will add more domains as I see fit.
6
+
7
+ 🔗 **GitHub Repository:** [dgkngk/super-kit](https://github.com/dgkngk/super-kit)
8
+
9
+ 🔗 **NPM Package:** [superkit-mcp-server](https://www.npmjs.com/package/superkit-mcp-server)
10
+
11
+ ## Directory Structure
12
+ - `agents/`: Contains instructions and guidelines for specialized AI roles (e.g., `data-engineer`).
13
+ - `skills/`: Contains technology-specific or meta skills (patterns, best practices) the agent can load dynamically (e.g., `react-best-practices`).
14
+ - `workflows/`: Contains step-by-step interactive slash-commands to guide the AI workflow (e.g., `/plan`, `/explore`).
15
+ - `src/`: The Model Context Protocol (MCP) server that exposes all these assets directly to compatible AI platforms.
16
+
17
+ ## Providing the Kit to Your AI
18
+
19
+ The easiest way to power up your agent with this toolkit is to use the included MCP server.
20
+
21
+ You can launch it directly using `npx`:
22
+
23
+ ```bash
24
+ npx -y superkit-mcp-server
25
+ ```
26
+
27
+ ## Available Tools
28
+
29
+ - **`list_superkit_assets`**: Lists all available agents, skills (tech/meta), and workflows in the Super-Kit repository.
30
+ - **`load_superkit_agent`**: Loads the system instructions and guidelines for a specific specialist agent (e.g., `data-engineer`).
31
+ - **`load_superkit_skill`**: Loads the skill instructions (`SKILL.md`) for a specific category and skill (e.g., category: `tech`, name: `react-best-practices`).
32
+ - **`load_superkit_workflow`**: Loads the instructions for a specific slash-command workflow (e.g., `work`, `explore`).
33
+ - **`call_tool_checklist`**: Executes the native TypeScript validation suite (security, web accessibility, react performance, testing, API structure) on a target project location via the MCP environment instead of generic bash loops.
34
+
35
+ ## Available Prompts
36
+
37
+ The Super-Kit MCP server exposes all workflows inside the `workflows/` directory dynamically as **MCP Prompts**. AI agents can invoke `GetPromptRequestSchema` to instantly load complex workflows (e.g., `plan-compound`, `review-compound`) along with their security and validation tooling straight into their context.
38
+
39
+ ## Manual Installation and Configuration
40
+
41
+ If you cloned this repository locally, you can build and use the MCP server directly:
42
+
43
+ ```bash
44
+ cd super-kit
45
+ npm install
46
+ npm run build
47
+ ```
48
+
49
+ ### Configuring in AI Platforms
50
+
51
+ #### Cline / Roo (VS Code)
52
+ Add the following to your `cline_mcp_settings.json`:
53
+ ```json
54
+ {
55
+ "mcpServers": {
56
+ "superkit": {
57
+ "command": "node",
58
+ "args": ["/absolute/path/to/super-kit/build/index.js"]
59
+ }
60
+ }
61
+ }
62
+ ```
63
+
64
+ #### Cursor / Windsurf
65
+ Go to Settings -> Features -> MCP Servers.
66
+ Add a new stdio server:
67
+ - Name: `superkit`
68
+ - Command: `node /absolute/path/to/super-kit/build/index.js`
69
+
70
+ ## How it works
71
+ The built-in MCP server reads directly from the `super-kit` directory, resolving paths safely to prevent traversal attacks. It automatically parses and returns the Markdown contents of the structural elements so your AI agent always has the right context in mind.