skillfullstack 0.0.0-stage → 1.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/.skillsRegistry/catalog.json +231 -0
- package/AGENTS.md +89 -0
- package/README.md +210 -2
- package/bin/index.js +508 -0
- package/package.json +57 -4
- package/skills/backend/apiEngineering/SKILL.md +102 -0
- package/skills/backend/apiEngineering/evals/evalApiEngineering.py +81 -0
- package/skills/backend/apiEngineering/evals/fixtures/invalid/sampleInvalidOpenApi.json +40 -0
- package/skills/backend/apiEngineering/evals/fixtures/valid/sampleValidOpenApi.json +47 -0
- package/skills/backend/apiEngineering/policies/compatibility.md +42 -0
- package/skills/backend/apiEngineering/policies/mandatory.md +48 -0
- package/skills/backend/apiEngineering/policies/performance.md +39 -0
- package/skills/backend/apiEngineering/policies/security.md +36 -0
- package/skills/backend/apiEngineering/references/apiObservability.md +39 -0
- package/skills/backend/apiEngineering/references/apiReference.md +3 -0
- package/skills/backend/apiEngineering/references/apiSecurityOwasp.md +47 -0
- package/skills/backend/apiEngineering/references/contractCompatibility.md +26 -0
- package/skills/backend/apiEngineering/references/databaseTransactions.md +40 -0
- package/skills/backend/apiEngineering/references/distributedReliability.md +26 -0
- package/skills/backend/apiEngineering/references/multiTenancy.md +27 -0
- package/skills/backend/apiEngineering/references/openApi32Standards.md +58 -0
- package/skills/backend/apiEngineering/references/paginationVersioning.md +57 -0
- package/skills/backend/apiEngineering/references/responseStandards.md +94 -0
- package/skills/backend/apiEngineering/scripts/auditApiContract.py +123 -0
- package/skills/backend/apiEngineering/scripts/checkBreakingChanges.py +77 -0
- package/skills/backend/apiEngineering/scripts/generateResponseEnvelope.py +88 -0
- package/skills/backend/apiEngineering/templates/apiChecklist.md +27 -0
- package/skills/backend/apiEngineering/templates/openapi.yaml +125 -0
- package/skills/backend/apiEngineering/templates/problemDetails.json +44 -0
- package/skills/backend/databaseArchitecture/SKILL.md +118 -0
- package/skills/backend/databaseArchitecture/evals/evalDatabaseArchitecture.py +85 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/dangerousMigration.sql +4 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/invalidSchema.sql +23 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/safeMigration.sql +3 -0
- package/skills/backend/databaseArchitecture/evals/fixtures/validSchema.sql +37 -0
- package/skills/backend/databaseArchitecture/policies/integrity.md +25 -0
- package/skills/backend/databaseArchitecture/policies/mandatory.md +32 -0
- package/skills/backend/databaseArchitecture/policies/migration.md +22 -0
- package/skills/backend/databaseArchitecture/policies/normalization.md +25 -0
- package/skills/backend/databaseArchitecture/policies/performance.md +26 -0
- package/skills/backend/databaseArchitecture/policies/recovery.md +23 -0
- package/skills/backend/databaseArchitecture/policies/security.md +26 -0
- package/skills/backend/databaseArchitecture/policies/tableCreationChecklist.md +70 -0
- package/skills/backend/databaseArchitecture/references/analyticsWarehousing.md +32 -0
- package/skills/backend/databaseArchitecture/references/apiReference.md +3 -0
- package/skills/backend/databaseArchitecture/references/backupDisasterRecovery.md +27 -0
- package/skills/backend/databaseArchitecture/references/dataModelingLifecycle.md +30 -0
- package/skills/backend/databaseArchitecture/references/databaseTaxonomy.md +32 -0
- package/skills/backend/databaseArchitecture/references/indexingOptimization.md +32 -0
- package/skills/backend/databaseArchitecture/references/normalizationTheory.md +61 -0
- package/skills/backend/databaseArchitecture/references/scalabilitySharding.md +37 -0
- package/skills/backend/databaseArchitecture/references/transactionConcurrency.md +39 -0
- package/skills/backend/databaseArchitecture/scripts/analyzeMigration.py +99 -0
- package/skills/backend/databaseArchitecture/scripts/auditDatabaseSchema.py +177 -0
- package/skills/backend/databaseArchitecture/scripts/inspectDatabaseIndexes.py +149 -0
- package/skills/backend/databaseArchitecture/templates/adrTemplate.md +32 -0
- package/skills/backend/databaseArchitecture/templates/databaseChecklist.md +29 -0
- package/skills/backend/databaseArchitecture/templates/migrationPlan.md +40 -0
- package/skills/backend/durableBackgroundJobs/SKILL.md +112 -0
- package/skills/backend/durableBackgroundJobs/evals/durableJobVerification.json +14 -0
- package/skills/backend/durableBackgroundJobs/references/apiReference.md +3 -0
- package/skills/backend/durableBackgroundJobs/references/durableStepPatterns.md +6 -0
- package/skills/backend/durableBackgroundJobs/references/idempotencyKeys.md +5 -0
- package/skills/backend/durableBackgroundJobs/scripts/testWorkflowDispatch.py +24 -0
- package/skills/backend/golangStandard/SKILL.md +155 -0
- package/skills/backend/golangStandard/evals/goVerification.json +14 -0
- package/skills/backend/golangStandard/references/apiReference.md +3 -0
- package/skills/backend/golangStandard/references/layoutGuide.md +26 -0
- package/skills/backend/golangStandard/references/slogPatterns.md +26 -0
- package/skills/backend/golangStandard/scripts/scaffoldGoModule.py +105 -0
- package/skills/backend/pythonStandard/SKILL.md +138 -0
- package/skills/backend/pythonStandard/evals/pythonVerification.json +14 -0
- package/skills/backend/pythonStandard/references/apiReference.md +3 -0
- package/skills/backend/pythonStandard/references/pydanticPatterns.md +16 -0
- package/skills/backend/pythonStandard/references/pyprojectSpecs.md +37 -0
- package/skills/backend/pythonStandard/scripts/scaffoldUvProject.py +79 -0
- package/skills/backend/upstash/SKILL.md +98 -0
- package/skills/backend/upstash/evals/upstashVerification.json +14 -0
- package/skills/backend/upstash/references/apiReference.md +3 -0
- package/skills/backend/upstash/references/qstashFlowControl.md +34 -0
- package/skills/backend/upstash/references/ratelimitPatterns.md +53 -0
- package/skills/backend/upstash/references/workflowPatterns.md +35 -0
- package/skills/backend/upstash/scripts/testRedisConnection.py +36 -0
- package/skills/cicdDevops/cicdPipeline/SKILL.md +148 -0
- package/skills/cicdDevops/cicdPipeline/evals/evalCicd.py +37 -0
- package/skills/cicdDevops/cicdPipeline/references/apiReference.md +3 -0
- package/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md +27 -0
- package/skills/cicdDevops/cicdPipeline/scripts/auditDockerfileSecurity.py +56 -0
- package/skills/dataAi/mcpServerDevelopment/SKILL.md +123 -0
- package/skills/dataAi/mcpServerDevelopment/evals/mcpVerification.json +14 -0
- package/skills/dataAi/mcpServerDevelopment/references/apiReference.md +3 -0
- package/skills/dataAi/mcpServerDevelopment/references/mcpClientConfigs.md +38 -0
- package/skills/dataAi/mcpServerDevelopment/references/toolSchemaDesign.md +6 -0
- package/skills/dataAi/mcpServerDevelopment/scripts/runFastMcpBoilerplate.py +36 -0
- package/skills/dataAi/ragPipelineProduction/SKILL.md +113 -0
- package/skills/dataAi/ragPipelineProduction/evals/ragVerification.json +14 -0
- package/skills/dataAi/ragPipelineProduction/references/apiReference.md +3 -0
- package/skills/dataAi/ragPipelineProduction/references/chunkingStrategies.md +10 -0
- package/skills/dataAi/ragPipelineProduction/references/rrfAlgorithm.md +13 -0
- package/skills/dataAi/ragPipelineProduction/scripts/runHybridRrfSearch.py +33 -0
- package/skills/devopsCloud/cloudflare/SKILL.md +282 -0
- package/skills/devopsCloud/cloudflare/assets/README.md +48 -0
- package/skills/devopsCloud/cloudflare/assets/ai/agents-sdk.md +118 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-gateway.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/ai/ai-search.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/ai/workers-ai.md +127 -0
- package/skills/devopsCloud/cloudflare/assets/cli/c3.md +292 -0
- package/skills/devopsCloud/cloudflare/assets/cli/cf-cli.md +90 -0
- package/skills/devopsCloud/cloudflare/assets/cli/wrangler.md +43 -0
- package/skills/devopsCloud/cloudflare/assets/compute/cron-triggers.md +486 -0
- package/skills/devopsCloud/cloudflare/assets/compute/service-bindings.md +251 -0
- package/skills/devopsCloud/cloudflare/assets/compute/smart-placement.md +435 -0
- package/skills/devopsCloud/cloudflare/assets/compute/static-assets.md +220 -0
- package/skills/devopsCloud/cloudflare/assets/compute/workers.md +129 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/d1.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/durable-objects.md +122 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/hyperdrive.md +210 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/kv.md +198 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/queues.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/r2.md +105 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/vectorize.md +97 -0
- package/skills/devopsCloud/cloudflare/assets/database-storage/workflows.md +141 -0
- package/skills/devopsCloud/cloudflare/assets/llms.txt +143 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/cache-cdn.md +109 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/dns.md +71 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/rate-limiting.md +130 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/tunnels.md +57 -0
- package/skills/devopsCloud/cloudflare/assets/networking-security/waf.md +143 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/1xxx-errors.md +209 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/5xx-errors.md +111 -0
- package/skills/devopsCloud/cloudflare/assets/troubleshooting/http-status-codes.md +38 -0
- package/skills/devopsCloud/cloudflare/evals/evals.json +75 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/dynamic-routing.md +15 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/features.md +22 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/sdk-integration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/ai-gateway/troubleshooting.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/README.md +25 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/gotchas.md +13 -0
- package/skills/devopsCloud/cloudflare/references/ai-search/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/bindings/README.md +16 -0
- package/skills/devopsCloud/cloudflare/references/bindings/api.md +19 -0
- package/skills/devopsCloud/cloudflare/references/bindings/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/bindings/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/bindings/patterns.md +20 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/README.md +18 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/api.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/configuration.md +12 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/browser-rendering/patterns.md +12 -0
- package/skills/devopsCloud/cloudflare/references/cliComparison.md +93 -0
- package/skills/devopsCloud/cloudflare/references/containers/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/containers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/containers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/containers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/containers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/cron-triggers/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/d1/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/d1/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/frameworkCompatibility.md +110 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/README.md +28 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/api.md +26 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/configuration.md +34 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/gotchas.md +20 -0
- package/skills/devopsCloud/cloudflare/references/hyperdrive/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/images/README.md +12 -0
- package/skills/devopsCloud/cloudflare/references/images/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/images/configuration.md +17 -0
- package/skills/devopsCloud/cloudflare/references/images/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/images/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/README.md +15 -0
- package/skills/devopsCloud/cloudflare/references/kv/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/kv/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/kv/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/kv/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/miniflare/patterns.md +19 -0
- package/skills/devopsCloud/cloudflare/references/observability/README.md +27 -0
- package/skills/devopsCloud/cloudflare/references/observability/api.md +20 -0
- package/skills/devopsCloud/cloudflare/references/observability/configuration.md +23 -0
- package/skills/devopsCloud/cloudflare/references/observability/gotchas.md +25 -0
- package/skills/devopsCloud/cloudflare/references/observability/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/pages/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/pages/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/pages-functions/patterns.md +16 -0
- package/skills/devopsCloud/cloudflare/references/productSelectionMatrix.md +54 -0
- package/skills/devopsCloud/cloudflare/references/queues/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/queues/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/queues/configuration.md +20 -0
- package/skills/devopsCloud/cloudflare/references/queues/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/queues/patterns.md +21 -0
- package/skills/devopsCloud/cloudflare/references/r2/README.md +26 -0
- package/skills/devopsCloud/cloudflare/references/r2/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/r2/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/r2/gotchas.md +17 -0
- package/skills/devopsCloud/cloudflare/references/r2/patterns.md +18 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/configuration.md +25 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/secrets-store/patterns.md +27 -0
- package/skills/devopsCloud/cloudflare/references/skill-feedback.md +41 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/api.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/static-assets/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/stream/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/stream/api-live.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/api.md +21 -0
- package/skills/devopsCloud/cloudflare/references/stream/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/gotchas.md +18 -0
- package/skills/devopsCloud/cloudflare/references/stream/patterns.md +22 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/configuration.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/gotchas.md +16 -0
- package/skills/devopsCloud/cloudflare/references/tail-workers/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/README.md +20 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/api.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/configuration.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/networking.md +14 -0
- package/skills/devopsCloud/cloudflare/references/tunnel/patterns.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/README.md +22 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/api.md +18 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/configuration.md +19 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/vectorize/patterns.md +24 -0
- package/skills/devopsCloud/cloudflare/references/waf/README.md +21 -0
- package/skills/devopsCloud/cloudflare/references/waf/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/waf/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/waf/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/waf/patterns.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/README.md +24 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/api.md +13 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/configuration.md +16 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/gotchas.md +15 -0
- package/skills/devopsCloud/cloudflare/references/workers-ai/patterns.md +14 -0
- package/skills/devopsCloud/cloudflare/references/workflows/README.md +23 -0
- package/skills/devopsCloud/cloudflare/references/workflows/api.md +17 -0
- package/skills/devopsCloud/cloudflare/references/workflows/configuration.md +18 -0
- package/skills/devopsCloud/cloudflare/references/workflows/gotchas.md +19 -0
- package/skills/devopsCloud/cloudflare/references/workflows/patterns.md +30 -0
- package/skills/devopsCloud/cloudflare/scripts/auditCloudflareProduction.py +95 -0
- package/skills/foundation/promptEvalTesting/SKILL.md +114 -0
- package/skills/foundation/promptEvalTesting/evals/promptEvalVerification.json +14 -0
- package/skills/foundation/promptEvalTesting/references/apiReference.md +3 -0
- package/skills/foundation/promptEvalTesting/references/evalMetricsCatalog.md +7 -0
- package/skills/foundation/promptEvalTesting/references/promptfooConfigSpecs.md +16 -0
- package/skills/foundation/promptEvalTesting/scripts/runPromptEvalSuite.py +29 -0
- package/skills/frontend/astro/SKILL.md +327 -0
- package/skills/frontend/astro/assets/README.md +71 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/content-collections.md +1061 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/data-fetching.md +109 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/images.md +719 -0
- package/skills/frontend/astro/assets/add-content-to-your-site/markdown.md +725 -0
- package/skills/frontend/astro/assets/build-your-ui/components.md +402 -0
- package/skills/frontend/astro/assets/build-your-ui/fonts.md +437 -0
- package/skills/frontend/astro/assets/build-your-ui/front-end-frameworks.md +245 -0
- package/skills/frontend/astro/assets/build-your-ui/layouts.md +267 -0
- package/skills/frontend/astro/assets/build-your-ui/scripts-and-event-handling.md +229 -0
- package/skills/frontend/astro/assets/build-your-ui/styles-and-css.md +782 -0
- package/skills/frontend/astro/assets/build-your-ui/syntax-highlighting.md +269 -0
- package/skills/frontend/astro/assets/configuration/build-with-ai.md +389 -0
- package/skills/frontend/astro/assets/configuration/configuration-overview.md +122 -0
- package/skills/frontend/astro/assets/configuration/dev-toolbar.md +86 -0
- package/skills/frontend/astro/assets/configuration/editor-setup.md +166 -0
- package/skills/frontend/astro/assets/configuration/environment-variables.md +352 -0
- package/skills/frontend/astro/assets/configuration/typescript.md +379 -0
- package/skills/frontend/astro/assets/configuration/working-with-integrations.md +606 -0
- package/skills/frontend/astro/assets/reference/adapter-reference.md +1242 -0
- package/skills/frontend/astro/assets/reference/cli-reference.md +575 -0
- package/skills/frontend/astro/assets/reference/configuration-reference.md +3144 -0
- package/skills/frontend/astro/assets/reference/content-loader-reference.md +1682 -0
- package/skills/frontend/astro/assets/reference/directives-reference.md +324 -0
- package/skills/frontend/astro/assets/reference/image-service-reference.md +346 -0
- package/skills/frontend/astro/assets/reference/integrations-reference.md +2813 -0
- package/skills/frontend/astro/assets/reference/modules/astro-actions.md +604 -0
- package/skills/frontend/astro/assets/reference/modules/astro-app.md +460 -0
- package/skills/frontend/astro/assets/reference/modules/astro-assets.md +1657 -0
- package/skills/frontend/astro/assets/reference/modules/astro-config.md +395 -0
- package/skills/frontend/astro/assets/reference/modules/astro-content.md +720 -0
- package/skills/frontend/astro/assets/reference/modules/astro-env.md +46 -0
- package/skills/frontend/astro/assets/reference/modules/astro-fetch.md +346 -0
- package/skills/frontend/astro/assets/reference/modules/astro-hono.md +37 -0
- package/skills/frontend/astro/assets/reference/modules/astro-i18n.md +462 -0
- package/skills/frontend/astro/assets/reference/modules/astro-middleware.md +292 -0
- package/skills/frontend/astro/assets/reference/modules/astro-static-paths.md +74 -0
- package/skills/frontend/astro/assets/reference/modules/astro-transitions.md +595 -0
- package/skills/frontend/astro/assets/reference/modules/astro-zod.md +120 -0
- package/skills/frontend/astro/assets/reference/session-driver-reference.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/endpoints.md +251 -0
- package/skills/frontend/astro/assets/routing-and-navigation/internationalization.md +374 -0
- package/skills/frontend/astro/assets/routing-and-navigation/middleware.md +288 -0
- package/skills/frontend/astro/assets/routing-and-navigation/pages.md +205 -0
- package/skills/frontend/astro/assets/routing-and-navigation/prefetch.md +273 -0
- package/skills/frontend/astro/assets/routing-and-navigation/routing.md +760 -0
- package/skills/frontend/astro/assets/routing-and-navigation/view-transitions.md +792 -0
- package/skills/frontend/astro/assets/server-rendering/actions.md +770 -0
- package/skills/frontend/astro/assets/server-rendering/caching.md +255 -0
- package/skills/frontend/astro/assets/server-rendering/on-demand-rendering.md +289 -0
- package/skills/frontend/astro/assets/server-rendering/server-islands.md +126 -0
- package/skills/frontend/astro/assets/server-rendering/sessions.md +270 -0
- package/skills/frontend/astro/assets/start-a-new-project/develop-and-build.md +147 -0
- package/skills/frontend/astro/assets/start-a-new-project/installation.md +342 -0
- package/skills/frontend/astro/assets/start-a-new-project/project-structure.md +137 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/testing.md +412 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/troubleshooting.md +229 -0
- package/skills/frontend/astro/assets/upgrade-and-troubleshooting/upgrade-astro.md +205 -0
- package/skills/frontend/astro/assets/welcome/courses.md +46 -0
- package/skills/frontend/astro/assets/welcome/islands-architecture.md +135 -0
- package/skills/frontend/astro/assets/welcome/why-astro.md +90 -0
- package/skills/frontend/astro/evals/evals.json +66 -0
- package/skills/frontend/astro/references/contentCollections.md +164 -0
- package/skills/frontend/astro/references/islandsArchitecture.md +128 -0
- package/skills/frontend/astro/references/serverIslandsAndActions.md +187 -0
- package/skills/frontend/astro/scripts/auditAstroProduction.py +78 -0
- package/skills/frontend/generativeUi/SKILL.md +128 -0
- package/skills/frontend/generativeUi/evals/generativeUiVerification.json +14 -0
- package/skills/frontend/generativeUi/references/apiReference.md +3 -0
- package/skills/frontend/generativeUi/references/clientToolComponentMapping.md +8 -0
- package/skills/frontend/generativeUi/references/dataStreamProtocol.md +10 -0
- package/skills/frontend/generativeUi/scripts/generateUiComponentStub.py +46 -0
- package/skills/frontend/nextjs/SKILL.md +138 -0
- package/skills/frontend/nextjs/assets/README.md +67 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/create-next-app.md +210 -0
- package/skills/frontend/nextjs/assets/api-reference/cli/next.md +484 -0
- package/skills/frontend/nextjs/assets/api-reference/components/font.md +952 -0
- package/skills/frontend/nextjs/assets/api-reference/components/form.md +387 -0
- package/skills/frontend/nextjs/assets/api-reference/components/image.md +1372 -0
- package/skills/frontend/nextjs/assets/api-reference/components/link.md +954 -0
- package/skills/frontend/nextjs/assets/api-reference/components/script.md +421 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-private.md +211 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache-remote.md +652 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-cache.md +848 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-client.md +149 -0
- package/skills/frontend/nextjs/assets/api-reference/directives/use-server.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/edge-runtime.md +188 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/default.md +80 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/dynamic-routes.md +417 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/error.md +361 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/forbidden.md +75 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation-client.md +308 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/instrumentation.md +177 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/intercepting-routes.md +78 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/layout.md +803 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/loading.md +209 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/mdx-components.md +84 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/app-icons.md +302 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/manifest.md +90 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/opengraph-image.md +580 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/robots.md +234 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/metadata/sitemap.md +459 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/not-found.md +278 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/page.md +283 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/parallel-routes.md +517 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/proxy.md +857 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/public-folder.md +47 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-groups.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/dynamicParams.md +40 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/ensureStatic.md +195 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/instant.md +204 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/maxDuration.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/preferredRegion.md +55 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/prefetch.md +113 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route-segment-config/runtime.md +43 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/route.md +772 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/src-folder.md +42 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/template.md +174 -0
- package/skills/frontend/nextjs/assets/api-reference/file-conventions/unauthorized.md +143 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/after.md +332 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheLife.md +642 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cacheTag.md +272 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/catchError.md +267 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/connection.md +114 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/cookies.md +349 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/draft-mode.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/fetch.md +141 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/forbidden.md +327 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-image-metadata.md +311 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-metadata.md +1510 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-sitemaps.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-static-params.md +606 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/generate-viewport.md +347 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/headers.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/image-response.md +225 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/io.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/navigation.md +220 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-request.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-response.md +219 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/next-root-params.md +479 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/not-found.md +269 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/permanentRedirect.md +92 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/prefetch.md +202 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/redirect.md +255 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/refresh.md +91 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidatePath.md +248 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/revalidateTag.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unauthorized.md +389 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_cache.md +131 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_noStore.md +61 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/unstable_rethrow.md +79 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/updateTag.md +173 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-link-status.md +268 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-offline.md +222 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-params.md +102 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-pathname.md +189 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-report-web-vitals.md +175 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-router.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-search-params.md +416 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segment.md +214 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-selected-layout-segments.md +116 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/use-server-inserted-html.md +145 -0
- package/skills/frontend/nextjs/assets/api-reference/functions/userAgent.md +95 -0
- package/skills/frontend/nextjs/assets/api-reference/turbopack.md +552 -0
- package/skills/frontend/nextjs/assets/architecture/accessibility.md +47 -0
- package/skills/frontend/nextjs/assets/architecture/fast-refresh.md +122 -0
- package/skills/frontend/nextjs/assets/architecture/nextjs-compiler.md +376 -0
- package/skills/frontend/nextjs/assets/architecture/supported-browsers.md +146 -0
- package/skills/frontend/nextjs/assets/community/contribution-guide.md +459 -0
- package/skills/frontend/nextjs/assets/community/rspack.md +25 -0
- package/skills/frontend/nextjs/assets/getting-started/caching.md +626 -0
- package/skills/frontend/nextjs/assets/getting-started/css.md +336 -0
- package/skills/frontend/nextjs/assets/getting-started/deploying.md +115 -0
- package/skills/frontend/nextjs/assets/getting-started/error-handling.md +485 -0
- package/skills/frontend/nextjs/assets/getting-started/fetching-data.md +743 -0
- package/skills/frontend/nextjs/assets/getting-started/fonts.md +232 -0
- package/skills/frontend/nextjs/assets/getting-started/images.md +272 -0
- package/skills/frontend/nextjs/assets/getting-started/installation.md +446 -0
- package/skills/frontend/nextjs/assets/getting-started/layouts-and-pages.md +386 -0
- package/skills/frontend/nextjs/assets/getting-started/linking-and-navigating.md +475 -0
- package/skills/frontend/nextjs/assets/getting-started/metadata-and-og-images.md +370 -0
- package/skills/frontend/nextjs/assets/getting-started/mutating-data.md +679 -0
- package/skills/frontend/nextjs/assets/getting-started/project-structure.md +290 -0
- package/skills/frontend/nextjs/assets/getting-started/proxy.md +107 -0
- package/skills/frontend/nextjs/assets/getting-started/revalidating.md +241 -0
- package/skills/frontend/nextjs/assets/getting-started/route-handlers.md +233 -0
- package/skills/frontend/nextjs/assets/getting-started/server-and-client-components.md +683 -0
- package/skills/frontend/nextjs/assets/getting-started/upgrading.md +137 -0
- package/skills/frontend/nextjs/assets/glossary.md +315 -0
- package/skills/frontend/nextjs/evals/nextjsVerification.json +14 -0
- package/skills/frontend/nextjs/references/apiReference.md +3 -0
- package/skills/frontend/nextjs/references/dataAccessLayer.md +39 -0
- package/skills/frontend/nextjs/references/nextjsFeatureMap.md +276 -0
- package/skills/frontend/nextjs/references/productionChecklist.md +49 -0
- package/skills/frontend/nextjs/references/securityHeadersCsp.md +44 -0
- package/skills/frontend/nextjs/scripts/auditProductionReadiness.py +85 -0
- package/skills/frontend/shadcn-ui/SKILL.md +102 -0
- package/skills/frontend/shadcn-ui/assets/README.md +82 -0
- package/skills/frontend/shadcn-ui/assets/advanced/javascript.md +44 -0
- package/skills/frontend/shadcn-ui/assets/advanced/monorepo.md +254 -0
- package/skills/frontend/shadcn-ui/assets/advanced/react-19.md +166 -0
- package/skills/frontend/shadcn-ui/assets/advanced/tailwind-v4.md +333 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chain-of-thought.md +519 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/chat.md +581 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/checkpoint.md +243 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/confirmation.md +382 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/context.md +188 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/file-tree.md +248 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/index.md +307 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/inline-citation.md +219 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/message.md +298 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/model-selector.md +368 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/plan.md +398 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/prompt-input.md +403 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/queue.md +517 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/reasoning.md +349 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/sources.md +303 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/stack-trace.md +514 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/subagent.md +551 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/suggestion.md +246 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/task.md +380 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/terminal.md +463 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/test-results.md +641 -0
- package/skills/frontend/shadcn-ui/assets/ai-elements/tool.md +915 -0
- package/skills/frontend/shadcn-ui/assets/components/accordion.md +490 -0
- package/skills/frontend/shadcn-ui/assets/components/alert-dialog.md +520 -0
- package/skills/frontend/shadcn-ui/assets/components/alert.md +351 -0
- package/skills/frontend/shadcn-ui/assets/components/aspect-ratio.md +206 -0
- package/skills/frontend/shadcn-ui/assets/components/attachment.md +715 -0
- package/skills/frontend/shadcn-ui/assets/components/avatar.md +581 -0
- package/skills/frontend/shadcn-ui/assets/components/badge.md +276 -0
- package/skills/frontend/shadcn-ui/assets/components/breadcrumb.md +556 -0
- package/skills/frontend/shadcn-ui/assets/components/bubble.md +706 -0
- package/skills/frontend/shadcn-ui/assets/components/button-group.md +969 -0
- package/skills/frontend/shadcn-ui/assets/components/button.md +523 -0
- package/skills/frontend/shadcn-ui/assets/components/calendar.md +959 -0
- package/skills/frontend/shadcn-ui/assets/components/card.md +684 -0
- package/skills/frontend/shadcn-ui/assets/components/carousel.md +643 -0
- package/skills/frontend/shadcn-ui/assets/components/chart.md +1295 -0
- package/skills/frontend/shadcn-ui/assets/components/checkbox.md +553 -0
- package/skills/frontend/shadcn-ui/assets/components/code-block.md +2041 -0
- package/skills/frontend/shadcn-ui/assets/components/collapsible.md +504 -0
- package/skills/frontend/shadcn-ui/assets/components/combobox.md +1102 -0
- package/skills/frontend/shadcn-ui/assets/components/command.md +682 -0
- package/skills/frontend/shadcn-ui/assets/components/context-menu.md +949 -0
- package/skills/frontend/shadcn-ui/assets/components/data-table.md +1667 -0
- package/skills/frontend/shadcn-ui/assets/components/date-picker.md +698 -0
- package/skills/frontend/shadcn-ui/assets/components/dialog.md +454 -0
- package/skills/frontend/shadcn-ui/assets/components/direction.md +205 -0
- package/skills/frontend/shadcn-ui/assets/components/drawer.md +806 -0
- package/skills/frontend/shadcn-ui/assets/components/dropdown-menu.md +1315 -0
- package/skills/frontend/shadcn-ui/assets/components/empty.md +562 -0
- package/skills/frontend/shadcn-ui/assets/components/field.md +1321 -0
- package/skills/frontend/shadcn-ui/assets/components/hover-card.md +342 -0
- package/skills/frontend/shadcn-ui/assets/components/index.md +82 -0
- package/skills/frontend/shadcn-ui/assets/components/input-group.md +980 -0
- package/skills/frontend/shadcn-ui/assets/components/input-otp.md +551 -0
- package/skills/frontend/shadcn-ui/assets/components/input.md +555 -0
- package/skills/frontend/shadcn-ui/assets/components/item.md +937 -0
- package/skills/frontend/shadcn-ui/assets/components/kbd.md +290 -0
- package/skills/frontend/shadcn-ui/assets/components/label.md +327 -0
- package/skills/frontend/shadcn-ui/assets/components/marker.md +445 -0
- package/skills/frontend/shadcn-ui/assets/components/menubar.md +804 -0
- package/skills/frontend/shadcn-ui/assets/components/message-scroller.md +2770 -0
- package/skills/frontend/shadcn-ui/assets/components/message.md +618 -0
- package/skills/frontend/shadcn-ui/assets/components/native-select.md +321 -0
- package/skills/frontend/shadcn-ui/assets/components/navigation-menu.md +568 -0
- package/skills/frontend/shadcn-ui/assets/components/pagination.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/popover.md +402 -0
- package/skills/frontend/shadcn-ui/assets/components/progress.md +240 -0
- package/skills/frontend/shadcn-ui/assets/components/questionnaire.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/components/radio-group.md +440 -0
- package/skills/frontend/shadcn-ui/assets/components/resizable.md +302 -0
- package/skills/frontend/shadcn-ui/assets/components/scroll-area.md +226 -0
- package/skills/frontend/shadcn-ui/assets/components/select.md +647 -0
- package/skills/frontend/shadcn-ui/assets/components/separator.md +235 -0
- package/skills/frontend/shadcn-ui/assets/components/sheet.md +354 -0
- package/skills/frontend/shadcn-ui/assets/components/sidebar.md +1156 -0
- package/skills/frontend/shadcn-ui/assets/components/skeleton.md +217 -0
- package/skills/frontend/shadcn-ui/assets/components/slider.md +253 -0
- package/skills/frontend/shadcn-ui/assets/components/spinner.md +352 -0
- package/skills/frontend/shadcn-ui/assets/components/switch.md +296 -0
- package/skills/frontend/shadcn-ui/assets/components/table.md +572 -0
- package/skills/frontend/shadcn-ui/assets/components/tabs.md +425 -0
- package/skills/frontend/shadcn-ui/assets/components/textarea.md +218 -0
- package/skills/frontend/shadcn-ui/assets/components/toast.md +260 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle-group.md +419 -0
- package/skills/frontend/shadcn-ui/assets/components/toggle.md +220 -0
- package/skills/frontend/shadcn-ui/assets/components/tooltip.md +332 -0
- package/skills/frontend/shadcn-ui/assets/components/trace.md +1890 -0
- package/skills/frontend/shadcn-ui/assets/components/typography.md +561 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/next.md +108 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/overview.md +75 -0
- package/skills/frontend/shadcn-ui/assets/dark-mode/vite.md +144 -0
- package/skills/frontend/shadcn-ui/assets/forms/next.md +716 -0
- package/skills/frontend/shadcn-ui/assets/forms/overview.md +60 -0
- package/skills/frontend/shadcn-ui/assets/forms/react-hook-form.md +2055 -0
- package/skills/frontend/shadcn-ui/assets/forms/tanstack-form.md +2236 -0
- package/skills/frontend/shadcn-ui/assets/installation/astro.md +252 -0
- package/skills/frontend/shadcn-ui/assets/installation/manual.md +255 -0
- package/skills/frontend/shadcn-ui/assets/installation/next.md +256 -0
- package/skills/frontend/shadcn-ui/assets/installation/react-router.md +226 -0
- package/skills/frontend/shadcn-ui/assets/installation/remix.md +52 -0
- package/skills/frontend/shadcn-ui/assets/installation/vite.md +314 -0
- package/skills/frontend/shadcn-ui/assets/mcp/mcp.md +338 -0
- package/skills/frontend/shadcn-ui/assets/overview/changelog.md +6 -0
- package/skills/frontend/shadcn-ui/assets/overview/cli.md +738 -0
- package/skills/frontend/shadcn-ui/assets/overview/components-json.md +379 -0
- package/skills/frontend/shadcn-ui/assets/overview/directory.md +74 -0
- package/skills/frontend/shadcn-ui/assets/overview/introduction.md +77 -0
- package/skills/frontend/shadcn-ui/assets/overview/skills.md +71 -0
- package/skills/frontend/shadcn-ui/assets/overview/theming.md +304 -0
- package/skills/frontend/shadcn-ui/assets/overview/typeset.md +242 -0
- package/skills/frontend/shadcn-ui/assets/registry/getting-started.md +648 -0
- package/skills/frontend/shadcn-ui/assets/registry/overview.md +90 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-item-json.md +483 -0
- package/skills/frontend/shadcn-ui/assets/registry/registry-json.md +178 -0
- package/skills/frontend/shadcn-ui/evals/componentVerification.json +19 -0
- package/skills/frontend/shadcn-ui/references/aiComponentsCatalog.md +51 -0
- package/skills/frontend/shadcn-ui/references/apiReference.md +3 -0
- package/skills/frontend/shadcn-ui/references/blocksCatalog.md +32 -0
- package/skills/frontend/shadcn-ui/references/cliCommands.md +47 -0
- package/skills/frontend/shadcn-ui/references/componentMarkdownSources.md +48 -0
- package/skills/frontend/shadcn-ui/scripts/fetchComponentDocs.py +43 -0
- package/skills/frontend/tsxReactStandard/SKILL.md +150 -0
- package/skills/frontend/tsxReactStandard/evals/tsxVerification.json +14 -0
- package/skills/frontend/tsxReactStandard/references/apiReference.md +3 -0
- package/skills/frontend/tsxReactStandard/references/discriminatedUnions.md +31 -0
- package/skills/frontend/tsxReactStandard/references/tsconfigStrict.md +36 -0
- package/skills/frontend/tsxReactStandard/scripts/validateTsxTypes.py +44 -0
- package/skills/gitVersionControl/gitWorkflow/SKILL.md +128 -0
- package/skills/gitVersionControl/gitWorkflow/assets/README.md +23 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-environment.md +87 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-formatting.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/cli/gh-reference.md +2363 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-git.md +156 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/about-remote-repositories.md +65 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/associating-text-editors-with-git.md +93 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/caching-your-github-credentials.md +115 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/getting-changes-from-a-remote-repository.md +76 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/ignoring-files.md +51 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/managing-remote-repositories.md +231 -0
- package/skills/gitVersionControl/gitWorkflow/assets/using-git/pushing-commits-to-a-remote-repository.md +119 -0
- package/skills/gitVersionControl/gitWorkflow/evals/evalGitWorkflow.py +43 -0
- package/skills/gitVersionControl/gitWorkflow/references/apiReference.md +3 -0
- package/skills/gitVersionControl/gitWorkflow/references/branchingModels.md +32 -0
- package/skills/gitVersionControl/gitWorkflow/scripts/diagnoseGitGraph.py +68 -0
- package/skills/github/assets/README.md +39 -0
- package/skills/github/assets/cli/gh-environment.md +87 -0
- package/skills/github/assets/cli/gh-formatting.md +156 -0
- package/skills/github/assets/cli/gh-reference.md +2363 -0
- package/skills/github/assets/docs-api/github-docs-api.md +60 -0
- package/skills/github/assets/rest-api/actions-secrets.md +1272 -0
- package/skills/github/assets/rest-api/actions-variables.md +1247 -0
- package/skills/github/assets/rest-api/actions-workflow-runs.md +1697 -0
- package/skills/github/assets/rest-api/actions-workflows.md +348 -0
- package/skills/github/assets/rest-api/authenticating.md +174 -0
- package/skills/github/assets/rest-api/branches.md +727 -0
- package/skills/github/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/assets/rest-api/collaborators.md +547 -0
- package/skills/github/assets/rest-api/commits.md +957 -0
- package/skills/github/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/assets/rest-api/orgs.md +1172 -0
- package/skills/github/assets/rest-api/overview.md +875 -0
- package/skills/github/assets/rest-api/pull-reviews.md +722 -0
- package/skills/github/assets/rest-api/pulls.md +1605 -0
- package/skills/github/assets/rest-api/quickstart.md +344 -0
- package/skills/github/assets/rest-api/releases.md +650 -0
- package/skills/github/assets/rest-api/repos.md +2957 -0
- package/skills/github/assets/rest-api/rules.md +1507 -0
- package/skills/github/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubAction/SKILL.md +159 -0
- package/skills/github/githubAction/assets/README.md +38 -0
- package/skills/github/githubAction/assets/reference/contexts.md +918 -0
- package/skills/github/githubAction/assets/reference/dependency-caching.md +393 -0
- package/skills/github/githubAction/assets/reference/events-that-trigger-workflows.md +1348 -0
- package/skills/github/githubAction/assets/reference/expressions.md +441 -0
- package/skills/github/githubAction/assets/reference/metadata-syntax.md +803 -0
- package/skills/github/githubAction/assets/reference/variables.md +149 -0
- package/skills/github/githubAction/assets/reference/workflow-cancellation.md +22 -0
- package/skills/github/githubAction/assets/reference/workflow-commands.md +1056 -0
- package/skills/github/githubAction/assets/reference/workflow-syntax.md +1721 -0
- package/skills/github/githubAction/assets/rest-api/secrets.md +1272 -0
- package/skills/github/githubAction/assets/rest-api/workflow-runs.md +1697 -0
- package/skills/github/githubAction/assets/rest-api/workflows.md +348 -0
- package/skills/github/githubAction/assets/starter-workflows/automation/stale.yml +27 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/blank.yml +36 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/docker-image.yml +18 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/go.yml +28 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/maven.yml +35 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/node.js.yml +31 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/python-app.yml +39 -0
- package/skills/github/githubAction/assets/starter-workflows/ci/rust.yml +22 -0
- package/skills/github/githubAction/assets/starter-workflows/code-scanning/codeql.yml +97 -0
- package/skills/github/githubAction/evals/actionVerification.json +14 -0
- package/skills/github/githubAction/references/apiReference.md +3 -0
- package/skills/github/githubAction/references/workflowPatterns.md +81 -0
- package/skills/github/githubAction/scripts/validateWorkflowYaml.py +53 -0
- package/skills/github/githubQuality/SKILL.md +136 -0
- package/skills/github/githubQuality/assets/README.md +24 -0
- package/skills/github/githubQuality/assets/pull-requests/about-code-owners.md +178 -0
- package/skills/github/githubQuality/assets/pull-requests/about-merge-methods.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/creating-a-pull-request.md +170 -0
- package/skills/github/githubQuality/assets/pull-requests/giving-reviews.md +48 -0
- package/skills/github/githubQuality/assets/pull-requests/managing-a-merge-queue.md +134 -0
- package/skills/github/githubQuality/assets/pull-requests/merging-a-pull-request.md +101 -0
- package/skills/github/githubQuality/assets/pull-requests/resolving-reviews.md +59 -0
- package/skills/github/githubQuality/assets/pull-requests/status-checks.md +135 -0
- package/skills/github/githubQuality/assets/rest-api/checks-runs.md +1013 -0
- package/skills/github/githubQuality/assets/rest-api/checks-suites.md +1142 -0
- package/skills/github/githubQuality/assets/rest-api/commits.md +957 -0
- package/skills/github/githubQuality/assets/rest-api/pulls.md +1605 -0
- package/skills/github/githubQuality/assets/rest-api/reviews.md +722 -0
- package/skills/github/githubQuality/evals/qualityVerification.json +14 -0
- package/skills/github/githubQuality/references/apiReference.md +3 -0
- package/skills/github/githubQuality/references/codeownersExample.md +26 -0
- package/skills/github/githubQuality/references/prTemplate.md +20 -0
- package/skills/github/githubQuality/scripts/auditPrQuality.py +52 -0
- package/skills/github/githubSecurity/SKILL.md +170 -0
- package/skills/github/githubSecurity/assets/README.md +32 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/code-scanning/code-scanning.md +67 -0
- package/skills/github/githubSecurity/assets/code-scanning/codeql-code-scanning.md +79 -0
- package/skills/github/githubSecurity/assets/code-scanning/configure-code-scanning.md +121 -0
- package/skills/github/githubSecurity/assets/dependabot/about-the-dependabot-yml-file.md +74 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-alerts.md +133 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-security-updates.md +95 -0
- package/skills/github/githubSecurity/assets/dependabot/dependabot-version-updates.md +80 -0
- package/skills/github/githubSecurity/assets/rest-api/code-scanning.md +2957 -0
- package/skills/github/githubSecurity/assets/rest-api/dependabot-alerts.md +895 -0
- package/skills/github/githubSecurity/assets/rest-api/secret-scanning.md +947 -0
- package/skills/github/githubSecurity/assets/secret-scanning/enable-secret-scanning.md +59 -0
- package/skills/github/githubSecurity/assets/secret-scanning/secret-scanning.md +105 -0
- package/skills/github/githubSecurity/assets/security-advisories/github-advisory-database.md +148 -0
- package/skills/github/githubSecurity/evals/securityVerification.json +14 -0
- package/skills/github/githubSecurity/references/apiReference.md +3 -0
- package/skills/github/githubSecurity/references/codeqlAnalysis.yml +42 -0
- package/skills/github/githubSecurity/references/dependabotConfig.yml +27 -0
- package/skills/github/githubSecurity/scripts/auditRepoSecurity.py +47 -0
- package/skills/github/githubSetup/SKILL.md +137 -0
- package/skills/github/githubSetup/assets/README.md +40 -0
- package/skills/github/githubSetup/assets/branches/about-protected-branches.md +198 -0
- package/skills/github/githubSetup/assets/branches/changing-the-default-branch.md +49 -0
- package/skills/github/githubSetup/assets/branches/deleting-and-restoring-branches.md +44 -0
- package/skills/github/githubSetup/assets/branches/managing-a-branch-protection-rule.md +115 -0
- package/skills/github/githubSetup/assets/branches/renaming-a-branch.md +74 -0
- package/skills/github/githubSetup/assets/branches/viewing-branches-in-your-repository.md +30 -0
- package/skills/github/githubSetup/assets/repositories/about-repositories.md +127 -0
- package/skills/github/githubSetup/assets/repositories/cloning-a-repository.md +114 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-new-repository.md +82 -0
- package/skills/github/githubSetup/assets/repositories/creating-a-repository-from-a-template.md +51 -0
- package/skills/github/githubSetup/assets/repositories/deleting-a-repository.md +34 -0
- package/skills/github/githubSetup/assets/repositories/managing-teams-and-people-with-access.md +69 -0
- package/skills/github/githubSetup/assets/repositories/renaming-a-repository.md +47 -0
- package/skills/github/githubSetup/assets/repositories/restoring-a-deleted-repository.md +61 -0
- package/skills/github/githubSetup/assets/repositories/setting-repository-visibility.md +137 -0
- package/skills/github/githubSetup/assets/rest-api/branches.md +727 -0
- package/skills/github/githubSetup/assets/rest-api/quickstart.md +344 -0
- package/skills/github/githubSetup/assets/rest-api/repos.md +2957 -0
- package/skills/github/githubSetup/assets/rulesets/about-rulesets.md +72 -0
- package/skills/github/githubSetup/assets/rulesets/available-rules-for-rulesets.md +383 -0
- package/skills/github/githubSetup/assets/rulesets/converting-branch-protections-to-rulesets.md +92 -0
- package/skills/github/githubSetup/assets/rulesets/creating-rulesets-for-a-repository.md +108 -0
- package/skills/github/githubSetup/assets/rulesets/managing-rulesets-for-a-repository.md +149 -0
- package/skills/github/githubSetup/assets/rulesets/troubleshooting-rules.md +122 -0
- package/skills/github/githubSetup/evals/setupVerification.json +14 -0
- package/skills/github/githubSetup/references/apiReference.md +3 -0
- package/skills/github/githubSetup/references/repoSettingsBlueprint.md +13 -0
- package/skills/github/githubSetup/references/rulesetTemplates.json +42 -0
- package/skills/github/githubSetup/scripts/configureRepoBaseline.py +46 -0
- package/skills/github/githubTeam/SKILL.md +115 -0
- package/skills/github/githubTeam/assets/README.md +21 -0
- package/skills/github/githubTeam/assets/organizations/about-organizations.md +69 -0
- package/skills/github/githubTeam/assets/organizations/repository-roles-for-an-organization.md +94 -0
- package/skills/github/githubTeam/assets/rest-api/collaborators.md +547 -0
- package/skills/github/githubTeam/assets/rest-api/orgs.md +1172 -0
- package/skills/github/githubTeam/assets/rest-api/teams.md +1690 -0
- package/skills/github/githubTeam/assets/teams/about-teams.md +82 -0
- package/skills/github/githubTeam/assets/teams/adding-members-to-a-team.md +55 -0
- package/skills/github/githubTeam/evals/teamVerification.json +14 -0
- package/skills/github/githubTeam/references/apiReference.md +3 -0
- package/skills/github/githubTeam/references/permissionMatrix.md +17 -0
- package/skills/github/githubTeam/references/reviewAssignment.md +17 -0
- package/skills/github/githubTeam/scripts/manageTeamSync.py +31 -0
- package/skills/securityQa/llmSecurityRedteaming/SKILL.md +86 -0
- package/skills/securityQa/llmSecurityRedteaming/evals/securityRedteamVerification.json +14 -0
- package/skills/securityQa/llmSecurityRedteaming/references/apiReference.md +3 -0
- package/skills/securityQa/llmSecurityRedteaming/references/jailbreakTaxonomy.md +6 -0
- package/skills/securityQa/llmSecurityRedteaming/references/owaspLlmTopTen.md +12 -0
- package/skills/securityQa/llmSecurityRedteaming/scripts/testPromptInjection.py +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/SKILL.md +110 -0
- package/skills/softwareDevelopment/requirementsEngineering/evals/evalRequirements.py +33 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/apiReference.md +3 -0
- package/skills/softwareDevelopment/requirementsEngineering/references/requirementsAnalysisModels.md +34 -0
- package/skills/softwareDevelopment/requirementsEngineering/scripts/validateUserStories.py +49 -0
- package/skills/testing/testDrivenDevelopment/SKILL.md +122 -0
- package/skills/testing/testDrivenDevelopment/evals/evalTdd.py +25 -0
- package/skills/testing/testDrivenDevelopment/references/apiReference.md +3 -0
- package/skills/testing/testDrivenDevelopment/references/testPyramidDoubles.md +35 -0
- package/skills/testing/testDrivenDevelopment/scripts/auditTestPyramid.py +58 -0
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: cicdPipeline
|
|
3
|
+
description: Production CI/CD pipelines, containerization, build/test matrices, and zero-downtime deployment strategies
|
|
4
|
+
version: latest
|
|
5
|
+
last-verified: 2026-11-16
|
|
6
|
+
slash-commands:
|
|
7
|
+
- command: /cicd-pipeline
|
|
8
|
+
description: Scaffold portable CI/CD workflow matrix with test and security gates
|
|
9
|
+
argument-hint: "[--stack=node|python|go] [--provider=github|gitlab]"
|
|
10
|
+
- command: /dockerfile-audit
|
|
11
|
+
description: Audit Dockerfile for security, multi-stage layering, and non-root users
|
|
12
|
+
argument-hint: "[--path=Dockerfile] [--strict]"
|
|
13
|
+
- command: /deploy-strategy
|
|
14
|
+
description: Scaffold zero-downtime Canary or Blue-Green deployment configurations
|
|
15
|
+
argument-hint: "[--strategy=canary|blue-green|rolling]"
|
|
16
|
+
- command: /dora-metrics
|
|
17
|
+
description: Calculate and evaluate DORA delivery velocity metrics
|
|
18
|
+
argument-hint: "[--window=30d]"
|
|
19
|
+
---
|
|
20
|
+
|
|
21
|
+
# CI/CD Pipelines & DevOps Engineering
|
|
22
|
+
|
|
23
|
+
High-leverage engineering guide for robust Continuous Integration, hardened containerization, zero-downtime deployment strategies, and DORA metrics tracking.
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## 1. Core Principles & Safety Laws
|
|
28
|
+
|
|
29
|
+
1. **Deterministic & Ephemeral Builds**: Builds must be 100% reproducible. Lockfiles (`pnpm-lock.yaml`, `poetry.lock`, `go.sum`) are mandatory.
|
|
30
|
+
2. **Shift Left Security**: Static analysis, credential scanning, and vulnerability audits execute on every commit before merging to trunk.
|
|
31
|
+
3. **Hardened Container Invariants**:
|
|
32
|
+
- Always run as non-root user (`USER nonroot` or dedicated UID 10001).
|
|
33
|
+
- Use multi-stage builds to exclude compiler tools from final runtime images.
|
|
34
|
+
- Pin specific base image digests or immutable release tags.
|
|
35
|
+
4. **Zero-Downtime Deployment Invariants**:
|
|
36
|
+
- Backward-compatible database migrations (expand-contract pattern).
|
|
37
|
+
- Active readiness and liveness probes before directing production traffic.
|
|
38
|
+
|
|
39
|
+
---
|
|
40
|
+
|
|
41
|
+
## 2. Six-Stage Execution Lifecycle
|
|
42
|
+
|
|
43
|
+
```mermaid
|
|
44
|
+
flowchart LR
|
|
45
|
+
U["1. Understand"] --> I["2. Inspect"]
|
|
46
|
+
I --> P["3. Plan"]
|
|
47
|
+
P --> E["4. Execute"]
|
|
48
|
+
E --> V["5. Validate"]
|
|
49
|
+
V --> R["6. Report"]
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Stage 1: Understand
|
|
53
|
+
- Identify runtime ecosystem (Node/Next.js, Python/FastAPI, Go), target cloud provider, and SLOs.
|
|
54
|
+
|
|
55
|
+
### Stage 2: Inspect
|
|
56
|
+
- Audit existing Dockerfile and pipeline configs using `python3 scripts/auditDockerfileSecurity.py`.
|
|
57
|
+
- Verify pipeline cache efficiency and test execution bottlenecks.
|
|
58
|
+
|
|
59
|
+
### Stage 3: Plan
|
|
60
|
+
- Select deployment strategy:
|
|
61
|
+
- **Canary**: 5% $\rightarrow$ 25% $\rightarrow$ 100% traffic shift with automated error budget rollbacks.
|
|
62
|
+
- **Blue-Green**: Instant DNS/router switch between identical production slots.
|
|
63
|
+
- **Rolling**: Node-by-node update with maxUnavailable = 0.
|
|
64
|
+
|
|
65
|
+
### Stage 4: Execute
|
|
66
|
+
|
|
67
|
+
#### Standard Multi-Stage Hardened Dockerfile
|
|
68
|
+
```dockerfile
|
|
69
|
+
# Stage 1: Builder
|
|
70
|
+
FROM node:20-alpine AS builder
|
|
71
|
+
WORKDIR /app
|
|
72
|
+
COPY package.json pnpm-lock.yaml ./
|
|
73
|
+
RUN corepack enable && pnpm install --frozen-lockfile
|
|
74
|
+
COPY . .
|
|
75
|
+
RUN pnpm build
|
|
76
|
+
|
|
77
|
+
# Stage 2: Minimal Distroless Runtime
|
|
78
|
+
FROM node:20-alpine AS runner
|
|
79
|
+
WORKDIR /app
|
|
80
|
+
ENV NODE_ENV=production
|
|
81
|
+
RUN addgroup -S -g 1001 appgroup && adduser -S -u 1001 -G appgroup appuser
|
|
82
|
+
COPY --from=builder --chown=appuser:appgroup /app/dist ./dist
|
|
83
|
+
COPY --from=builder --chown=appuser:appgroup /app/node_modules ./node_modules
|
|
84
|
+
USER appuser
|
|
85
|
+
EXPOSE 3000
|
|
86
|
+
CMD ["node", "dist/server.js"]
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
#### GitHub Actions / GitLab Generic Pipeline Blueprint
|
|
90
|
+
```yaml
|
|
91
|
+
name: CI/CD Delivery Pipeline
|
|
92
|
+
on:
|
|
93
|
+
push:
|
|
94
|
+
branches: [main]
|
|
95
|
+
pull_request:
|
|
96
|
+
|
|
97
|
+
jobs:
|
|
98
|
+
validate:
|
|
99
|
+
runs-on: ubuntu-latest
|
|
100
|
+
steps:
|
|
101
|
+
- uses: actions/checkout@v4
|
|
102
|
+
- name: Lint & Static Checking
|
|
103
|
+
run: make lint
|
|
104
|
+
- name: Unit & Integration Tests
|
|
105
|
+
run: make test
|
|
106
|
+
|
|
107
|
+
security:
|
|
108
|
+
runs-on: ubuntu-latest
|
|
109
|
+
steps:
|
|
110
|
+
- uses: actions/checkout@v4
|
|
111
|
+
- name: Dependency Audit
|
|
112
|
+
run: make audit
|
|
113
|
+
|
|
114
|
+
deploy:
|
|
115
|
+
needs: [validate, security]
|
|
116
|
+
if: github.ref == 'refs/heads/main'
|
|
117
|
+
runs-on: ubuntu-latest
|
|
118
|
+
steps:
|
|
119
|
+
- uses: actions/checkout@v4
|
|
120
|
+
- name: Deploy Canary / Production
|
|
121
|
+
run: ./scripts/deploy.sh
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### Stage 5: Validate
|
|
125
|
+
1. Run `python3 scripts/auditDockerfileSecurity.py --file=Dockerfile`.
|
|
126
|
+
2. Verify image vulnerability scan passes with 0 Critical/High CVEs.
|
|
127
|
+
3. Test graceful shutdown on `SIGTERM` signals.
|
|
128
|
+
|
|
129
|
+
### Stage 6: Report
|
|
130
|
+
Summarize pipeline stage durations, image layer sizes, and DORA telemetry projections.
|
|
131
|
+
|
|
132
|
+
---
|
|
133
|
+
|
|
134
|
+
## 3. The 4 DORA Metrics Benchmark
|
|
135
|
+
|
|
136
|
+
| DORA Metric | Elite Performers | Low Performers |
|
|
137
|
+
| :--- | :--- | :--- |
|
|
138
|
+
| **Deployment Frequency** | Multiple deploys per day | Fewer than once per 6 months |
|
|
139
|
+
| **Lead Time for Changes** | Less than 1 hour | More than 6 months |
|
|
140
|
+
| **Change Failure Rate** | 0% - 15% | 46% - 60% |
|
|
141
|
+
| **Time to Restore Service** | Less than 1 hour | More than 1 week |
|
|
142
|
+
|
|
143
|
+
---
|
|
144
|
+
|
|
145
|
+
## 4. Helper Scripts & Deep References
|
|
146
|
+
|
|
147
|
+
- Dockerfile Security Linter: `python3 scripts/auditDockerfileSecurity.py`
|
|
148
|
+
- Reference: [references/cicdDeploymentPatterns.md](file:///Users/prasangaramanpokharel/projects/SkillFullStack/skills/cicdDevops/cicdPipeline/references/cicdDeploymentPatterns.md)
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
evalCicd.py
|
|
4
|
+
Validates the auditDockerfileSecurity script.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import subprocess
|
|
8
|
+
import json
|
|
9
|
+
import os
|
|
10
|
+
import sys
|
|
11
|
+
|
|
12
|
+
def test_audit_dockerfile():
|
|
13
|
+
script_path = os.path.join(os.path.dirname(__file__), "..", "scripts", "auditDockerfileSecurity.py")
|
|
14
|
+
sample_dockerfile = """
|
|
15
|
+
FROM golang:1.22-alpine AS builder
|
|
16
|
+
WORKDIR /src
|
|
17
|
+
COPY . .
|
|
18
|
+
RUN go build -o /app/server
|
|
19
|
+
|
|
20
|
+
FROM alpine:3.19 AS runner
|
|
21
|
+
RUN adduser -D -u 10001 appuser
|
|
22
|
+
USER appuser
|
|
23
|
+
COPY --from=builder /app/server /app/server
|
|
24
|
+
CMD ["/app/server"]
|
|
25
|
+
"""
|
|
26
|
+
res = subprocess.run([sys.executable, script_path], input=sample_dockerfile, stdout=subprocess.PIPE, stderr=subprocess.PIPE, text=True)
|
|
27
|
+
assert res.returncode == 0, f"Script failed: {res.stderr}"
|
|
28
|
+
data = json.loads(res.stdout)
|
|
29
|
+
assert data["isProductionReady"] is True
|
|
30
|
+
assert data["hasMultiStage"] is True
|
|
31
|
+
assert data["runsAsNonRoot"] is True
|
|
32
|
+
assert data["score"] == 100
|
|
33
|
+
print(" test_audit_dockerfile passed")
|
|
34
|
+
|
|
35
|
+
if __name__ == "__main__":
|
|
36
|
+
test_audit_dockerfile()
|
|
37
|
+
print("All cicdPipeline evals passed.")
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# CI/CD Deployment Strategies & DORA Operational Reference
|
|
2
|
+
|
|
3
|
+
## 1. Zero-Downtime Deployment Strategies (SE Curriculum Chapter 14)
|
|
4
|
+
|
|
5
|
+
### Blue-Green Deployments
|
|
6
|
+
- Two identical environments: Environment Blue (Active traffic) and Environment Green (Staging/Idle).
|
|
7
|
+
- New release deployed and smoke-tested on Green.
|
|
8
|
+
- Router/DNS instantly switches traffic to Green.
|
|
9
|
+
- Rollback: Instant switch back to Blue if errors spike.
|
|
10
|
+
|
|
11
|
+
### Canary Deployments
|
|
12
|
+
- New version is deployed alongside existing production instances.
|
|
13
|
+
- Small fraction of traffic (5%) routed to Canary.
|
|
14
|
+
- Automated monitor tracks HTTP 5xx error rate and p99 latency against SLOs.
|
|
15
|
+
- Traffic increases progressively (25% -> 50% -> 100%) or triggers automated rollback.
|
|
16
|
+
|
|
17
|
+
### Rolling Updates
|
|
18
|
+
- Replicas updated incrementally (e.g. 1 pod at a time).
|
|
19
|
+
- Health probes (`readinessProbe`) ensure new pod is ready before terminating old pod.
|
|
20
|
+
|
|
21
|
+
---
|
|
22
|
+
|
|
23
|
+
## 2. Database Migrations Without Downtime (Expand-Contract Pattern)
|
|
24
|
+
|
|
25
|
+
1. **Expand**: Add new nullable column or table; write dual-write logic in application.
|
|
26
|
+
2. **Backfill**: Migrate historical records via background job.
|
|
27
|
+
3. **Contract**: Switch read queries to new schema; deprecate and remove old column.
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
auditDockerfileSecurity.py
|
|
4
|
+
Audits Dockerfiles for production security best practices:
|
|
5
|
+
- Multi-stage builds
|
|
6
|
+
- Non-root user declaration
|
|
7
|
+
- Avoidance of 'latest' tags
|
|
8
|
+
- Clean package manager cache cleanup
|
|
9
|
+
"""
|
|
10
|
+
|
|
11
|
+
import sys
|
|
12
|
+
import re
|
|
13
|
+
import json
|
|
14
|
+
|
|
15
|
+
def audit_dockerfile_content(content):
|
|
16
|
+
lines = content.splitlines()
|
|
17
|
+
has_multistage = len(re.findall(r"^\s*FROM\s+", content, re.MULTILINE | re.IGNORECASE)) > 1
|
|
18
|
+
has_user = bool(re.search(r"^\s*USER\s+(?!root\b)\w+", content, re.MULTILINE | re.IGNORECASE))
|
|
19
|
+
has_latest_tag = bool(re.search(r"^\s*FROM\s+[\w\./\-]+:latest\b", content, re.MULTILINE | re.IGNORECASE))
|
|
20
|
+
|
|
21
|
+
findings = []
|
|
22
|
+
if not has_multistage:
|
|
23
|
+
findings.append("Missing multi-stage build: final image may contain build tools.")
|
|
24
|
+
if not has_user:
|
|
25
|
+
findings.append("Missing non-root USER declaration: container runs as root.")
|
|
26
|
+
if has_latest_tag:
|
|
27
|
+
findings.append("Uses mutable ':latest' image tag instead of pinned version.")
|
|
28
|
+
|
|
29
|
+
score = 100 - (len(findings) * 30)
|
|
30
|
+
|
|
31
|
+
return {
|
|
32
|
+
"score": max(score, 0),
|
|
33
|
+
"isProductionReady": len(findings) == 0,
|
|
34
|
+
"hasMultiStage": has_multistage,
|
|
35
|
+
"runsAsNonRoot": has_user,
|
|
36
|
+
"usesPinnedTags": not has_latest_tag,
|
|
37
|
+
"findings": findings
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
def main():
|
|
41
|
+
sample = sys.stdin.read() if not sys.stdin.isatty() else """
|
|
42
|
+
FROM node:20-alpine AS builder
|
|
43
|
+
WORKDIR /app
|
|
44
|
+
COPY . .
|
|
45
|
+
RUN npm build
|
|
46
|
+
|
|
47
|
+
FROM node:20-alpine AS runner
|
|
48
|
+
USER appuser
|
|
49
|
+
COPY --from=builder /app/dist ./dist
|
|
50
|
+
CMD ["node", "dist/main.js"]
|
|
51
|
+
"""
|
|
52
|
+
result = audit_dockerfile_content(sample)
|
|
53
|
+
print(json.dumps(result, indent=2))
|
|
54
|
+
|
|
55
|
+
if __name__ == "__main__":
|
|
56
|
+
main()
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mcpServerDevelopment
|
|
3
|
+
description: Build Model Context Protocol (MCP) servers exposing tools, resources, and prompt templates to AI agents. Use when connecting Claude, Cursor, or custom agents to databases, APIs, and local services via stdio or SSE.
|
|
4
|
+
version: 1.x
|
|
5
|
+
last-verified: 2026-11-15
|
|
6
|
+
compatibility: Node.js 18+, Python 3.10+, uv, TypeScript 5+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# MCP Server Development Engineering Guide
|
|
10
|
+
|
|
11
|
+
## 1. Core Architecture & Primitives
|
|
12
|
+
Model Context Protocol (MCP) standardizes agent-to-environment integration across three core primitives:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
┌────────────────────────────────────────────────────────┐
|
|
16
|
+
│ MCP Server Core │
|
|
17
|
+
├─────────────────┬───────────────────┬──────────────────┤
|
|
18
|
+
│ Tools │ Resources │ Prompts │
|
|
19
|
+
│ Model-controlled│ Client-controlled │ User-controlled │
|
|
20
|
+
│ Action execution│ URI-based context │ Workflow presets │
|
|
21
|
+
└─────────────────┴───────────────────┴──────────────────┘
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
- **Tools**: Model-invoked functions with typed JSON Schema input/output (calculating, querying SQL, writing files).
|
|
25
|
+
- **Resources**: Read-only structured data accessed via custom URI schemes (`db://schema`, `file:///logs`).
|
|
26
|
+
- **Prompts**: Parameterized reusable prompts registered by the server for client slash commands.
|
|
27
|
+
- **Transports**:
|
|
28
|
+
- `stdio`: Default for local agent hosts (Cursor, Claude Desktop). Standard in/out JSON-RPC stream.
|
|
29
|
+
- `SSE` (Server-Sent Events) / Streamable HTTP: For distributed or multi-tenant remote deployments.
|
|
30
|
+
|
|
31
|
+
---
|
|
32
|
+
|
|
33
|
+
## 2. Python FastMCP Canonical Pattern
|
|
34
|
+
|
|
35
|
+
```python
|
|
36
|
+
from mcp.server.fastmcp import FastMCP, Context
|
|
37
|
+
|
|
38
|
+
mcp = FastMCP("ProductionDataServer")
|
|
39
|
+
|
|
40
|
+
# 1. Expose Tool (Model-invoked action)
|
|
41
|
+
@mcp.tool()
|
|
42
|
+
def query_database(sql_query: str, limit: int = 50) -> list[dict]:
|
|
43
|
+
"""Execute a read-only query against the database and return records."""
|
|
44
|
+
# Enforce read-only safety
|
|
45
|
+
if any(kw in sql_query.upper() for kw in ["DROP", "DELETE", "UPDATE", "INSERT"]):
|
|
46
|
+
raise ValueError("Only read-only SELECT queries are allowed.")
|
|
47
|
+
return db.execute(sql_query, limit=limit)
|
|
48
|
+
|
|
49
|
+
# 2. Expose Resource (URI context)
|
|
50
|
+
@mcp.resource("schema://main")
|
|
51
|
+
def get_database_schema() -> str:
|
|
52
|
+
"""Return schema DDL definitions for the active database."""
|
|
53
|
+
return db.get_schema_ddl()
|
|
54
|
+
|
|
55
|
+
# 3. Expose Prompt (Slash command preset)
|
|
56
|
+
@mcp.prompt()
|
|
57
|
+
def analyze_slow_queries() -> str:
|
|
58
|
+
"""Prompt template to inspect execution plans of queries."""
|
|
59
|
+
return "Analyze the database schema at schema://main and suggest composite indexes for slow queries."
|
|
60
|
+
|
|
61
|
+
if __name__ == "__main__":
|
|
62
|
+
mcp.run() # Defaults to stdio transport
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 3. TypeScript SDK Canonical Pattern
|
|
68
|
+
|
|
69
|
+
```typescript
|
|
70
|
+
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
|
|
71
|
+
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
|
|
72
|
+
import {
|
|
73
|
+
ListToolsRequestSchema,
|
|
74
|
+
CallToolRequestSchema,
|
|
75
|
+
ListResourcesRequestSchema,
|
|
76
|
+
ReadResourceRequestSchema
|
|
77
|
+
} from "@modelcontextprotocol/sdk/types.js";
|
|
78
|
+
|
|
79
|
+
const server = new Server(
|
|
80
|
+
{ name: "ts-production-mcp", version: "1.0.0" },
|
|
81
|
+
{ capabilities: { tools: {}, resources: {}, prompts: {} } }
|
|
82
|
+
);
|
|
83
|
+
|
|
84
|
+
// Register Tools
|
|
85
|
+
server.setRequestHandler(ListToolsRequestSchema, async () => ({
|
|
86
|
+
tools: [{
|
|
87
|
+
name: "fetch_customer_data",
|
|
88
|
+
description: "Fetch customer profile by ID",
|
|
89
|
+
inputSchema: {
|
|
90
|
+
type: "object",
|
|
91
|
+
properties: { customerId: { type: "string" } },
|
|
92
|
+
required: ["customerId"]
|
|
93
|
+
}
|
|
94
|
+
}]
|
|
95
|
+
}));
|
|
96
|
+
|
|
97
|
+
server.setRequestHandler(CallToolRequestSchema, async (request) => {
|
|
98
|
+
if (request.params.name === "fetch_customer_data") {
|
|
99
|
+
const { customerId } = request.params.arguments as { customerId: string };
|
|
100
|
+
const data = await getCustomer(customerId);
|
|
101
|
+
return { content: [{ type: "text", text: JSON.stringify(data) }] };
|
|
102
|
+
}
|
|
103
|
+
throw new Error(`Tool not found: ${request.params.name}`);
|
|
104
|
+
});
|
|
105
|
+
|
|
106
|
+
const transport = new StdioServerTransport();
|
|
107
|
+
await server.connect(transport);
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## 4. Anti-Patterns & Critical Guardrails
|
|
113
|
+
- ❌ **Polluting stdout in stdio Mode**: Never use raw `print()` or `console.log()` in stdio servers! Doing so corrupts JSON-RPC payloads and breaks the client. Direct all debugging logs strictly to `stderr`.
|
|
114
|
+
- ❌ **Unvalidated Tool Arguments**: Always define strict schemas (Zod or Pydantic) with explicit validation; never accept unvalidated open objects.
|
|
115
|
+
- ❌ **Unchecked Destructive Mutations**: Tool calls that drop, alter, or send external emails should require human-in-the-loop confirmation (`confirm: true`).
|
|
116
|
+
- ❌ **Missing Resource URIs**: Never serve non-standard arbitrary strings as resource identifiers; use valid RFC 3986 URI schemes (`postgres://...`, `memo://...`).
|
|
117
|
+
|
|
118
|
+
---
|
|
119
|
+
|
|
120
|
+
## 5. References & Bundled Utilities
|
|
121
|
+
- Client configuration specs: [references/mcpClientConfigs.md](references/mcpClientConfigs.md)
|
|
122
|
+
- Tool schema best practices: [references/toolSchemaDesign.md](references/toolSchemaDesign.md)
|
|
123
|
+
- Standalone boilerplate server: [scripts/runFastMcpBoilerplate.py](scripts/runFastMcpBoilerplate.py)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"evals": [
|
|
3
|
+
{
|
|
4
|
+
"name": "fastmcp-tool-definition",
|
|
5
|
+
"prompt": "Create a FastMCP tool in Python named calculate_tax with rate and amount parameters.",
|
|
6
|
+
"expectedPattern": "@mcp\\.tool\\(\\)[\\s\\S]*def calculate_tax"
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
"name": "mcp-resource-uri",
|
|
10
|
+
"prompt": "Expose an MCP resource for customer records using a valid custom URI scheme.",
|
|
11
|
+
"expectedPattern": "@mcp\\.resource\\([\"']customer://.*[\"']\\)"
|
|
12
|
+
}
|
|
13
|
+
]
|
|
14
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
# MCP Host Client Configuration Specs
|
|
2
|
+
|
|
3
|
+
How to configure MCP servers across popular host agents:
|
|
4
|
+
|
|
5
|
+
## 1. Claude Desktop (`claude_desktop_config.json`)
|
|
6
|
+
Location: `~/Library/Application Support/Claude/claude_desktop_config.json` (Mac)
|
|
7
|
+
|
|
8
|
+
```json
|
|
9
|
+
{
|
|
10
|
+
"mcpServers": {
|
|
11
|
+
"myPythonServer": {
|
|
12
|
+
"command": "python3",
|
|
13
|
+
"args": ["/absolute/path/to/server.py"],
|
|
14
|
+
"env": {
|
|
15
|
+
"API_KEY": "secret"
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"myNodeServer": {
|
|
19
|
+
"command": "node",
|
|
20
|
+
"args": ["/absolute/path/to/dist/index.js"]
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## 2. Cursor (`.cursor/mcp.json`)
|
|
27
|
+
Location: Project root or global Cursor config:
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"mcpServers": {
|
|
32
|
+
"localTools": {
|
|
33
|
+
"command": "uv",
|
|
34
|
+
"args": ["run", "python", "scripts/mcpServer.py"]
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
```
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
# MCP Tool Schema Design & Best Practices
|
|
2
|
+
|
|
3
|
+
1. **Clear Descriptions**: Tool descriptions are consumed by the LLM's planner. State exactly what the tool does, expected inputs, and error modes.
|
|
4
|
+
2. **Strict Property Types**: Every property in `properties` must define an explicit `type`, and non-optional keys must be listed in `required`.
|
|
5
|
+
3. **Enum Values for Restricted Fields**: When selecting predefined actions or formats, supply `enum: [...]` to prevent model hallucinations.
|
|
6
|
+
4. **Error Handling**: Return clean error strings in the `content: [{ type: "text", text: "Error: ..." }]` block rather than throwing unhandled exceptions that terminate the stdio connection.
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
#!/usr/bin/env python3
|
|
2
|
+
"""
|
|
3
|
+
runFastMcpBoilerplate.py
|
|
4
|
+
Production-ready starter FastMCP server boilerplate with tools, resources, and prompts.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
import sys
|
|
8
|
+
|
|
9
|
+
def main():
|
|
10
|
+
try:
|
|
11
|
+
from mcp.server.fastmcp import FastMCP
|
|
12
|
+
except ImportError:
|
|
13
|
+
sys.stderr.write("mcp package not installed. Run: pip install mcp or uv add mcp\n")
|
|
14
|
+
sys.exit(1)
|
|
15
|
+
|
|
16
|
+
mcp = FastMCP("StarterMcpServer")
|
|
17
|
+
|
|
18
|
+
@mcp.tool()
|
|
19
|
+
def echo_message(message: str) -> str:
|
|
20
|
+
"""Echo a message back to the agent with confirmation."""
|
|
21
|
+
return f"Echo received: {message}"
|
|
22
|
+
|
|
23
|
+
@mcp.resource("system://info")
|
|
24
|
+
def get_system_info() -> str:
|
|
25
|
+
"""Return system status context."""
|
|
26
|
+
return "System status: Healthy. All MCP endpoints operational."
|
|
27
|
+
|
|
28
|
+
@mcp.prompt()
|
|
29
|
+
def summarize_system_prompt() -> str:
|
|
30
|
+
"""Prompt template to summarize system state."""
|
|
31
|
+
return "Review the resource at system://info and give an operational summary."
|
|
32
|
+
|
|
33
|
+
mcp.run()
|
|
34
|
+
|
|
35
|
+
if __name__ == "__main__":
|
|
36
|
+
main()
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: ragPipelineProduction
|
|
3
|
+
description: Production-grade RAG pipeline implementing BM25 and dense vector hybrid search, Reciprocal Rank Fusion (RRF), cross-encoder reranking (Cohere/BGE), and semantic caching. Use when building reliable, hallucination-resistant retrieval systems.
|
|
4
|
+
version: 2.x
|
|
5
|
+
last-verified: 2026-11-15
|
|
6
|
+
compatibility: Python 3.10+, LangChain, LlamaIndex, Qdrant/pgvector, Cohere API
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
# Production RAG Pipeline Engineering Guide
|
|
10
|
+
|
|
11
|
+
## 1. The Production Architecture (Why Naive RAG Fails)
|
|
12
|
+
Naive RAG (vector search alone) fails in 30–40% of production queries because embedding models compress exact keywords (SKUs, IDs, error codes). The industry standard is a 3-stage pipeline:
|
|
13
|
+
|
|
14
|
+
```
|
|
15
|
+
┌─────────────────┐ ┌─────────────────┐
|
|
16
|
+
│ BM25 Lexical │ │ Dense Vector │
|
|
17
|
+
│ Exact keywords │ │ Semantic intent │
|
|
18
|
+
└────────┬────────┘ └────────┬────────┘
|
|
19
|
+
│ │
|
|
20
|
+
└───────────┬─────────────┘
|
|
21
|
+
▼
|
|
22
|
+
┌───────────────────────────┐
|
|
23
|
+
│ Reciprocal Rank Fusion │ Merges top-100 candidates
|
|
24
|
+
│ RRF_score = Σ 1/(60 + r) │ (Zero tuning, sub-millisecond)
|
|
25
|
+
└─────────────┬─────────────┘
|
|
26
|
+
▼
|
|
27
|
+
┌───────────────────────────┐
|
|
28
|
+
│ Cross-Encoder Rerank │ Evaluates [Query + Document] together
|
|
29
|
+
│ (Cohere v3 / BGE-reranker)│ Shrinks top-100 to top-3/5
|
|
30
|
+
└─────────────┬─────────────┘
|
|
31
|
+
▼
|
|
32
|
+
┌───────────────────────────┐
|
|
33
|
+
│ LLM Context Window │ Clean, ultra-high relevancy chunks
|
|
34
|
+
└───────────────────────────┘
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## 2. Canonical Hybrid + RRF Implementation Pattern
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
from typing import List, Dict
|
|
43
|
+
|
|
44
|
+
def reciprocal_rank_fusion(
|
|
45
|
+
bm25_results: List[Dict],
|
|
46
|
+
vector_results: List[Dict],
|
|
47
|
+
k: int = 60,
|
|
48
|
+
top_n: int = 50
|
|
49
|
+
) -> List[Dict]:
|
|
50
|
+
"""
|
|
51
|
+
Fuses two disparate ranked lists using Reciprocal Rank Fusion.
|
|
52
|
+
Score = sum(1 / (k + rank))
|
|
53
|
+
"""
|
|
54
|
+
rrf_scores = {}
|
|
55
|
+
doc_lookup = {}
|
|
56
|
+
|
|
57
|
+
# 1. Score BM25 results
|
|
58
|
+
for rank, doc in enumerate(bm25_results, start=1):
|
|
59
|
+
doc_id = doc["id"]
|
|
60
|
+
doc_lookup[doc_id] = doc
|
|
61
|
+
rrf_scores[doc_id] = rrf_scores.get(doc_id, 0.0) + (1.0 / (k + rank))
|
|
62
|
+
|
|
63
|
+
# 2. Score Dense Vector results
|
|
64
|
+
for rank, doc in enumerate(vector_results, start=1):
|
|
65
|
+
doc_id = doc["id"]
|
|
66
|
+
doc_lookup[doc_id] = doc
|
|
67
|
+
rrf_scores[doc_id] = rrf_scores.get(doc_id, 0.0) + (1.0 / (k + rank))
|
|
68
|
+
|
|
69
|
+
# 3. Sort by aggregated RRF score
|
|
70
|
+
sorted_ids = sorted(rrf_scores.keys(), key=lambda x: rrf_scores[x], reverse=True)
|
|
71
|
+
return [doc_lookup[doc_id] for doc_id in sorted_ids[:top_n]]
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
---
|
|
75
|
+
|
|
76
|
+
## 3. Reranker Integration (Cohere v3)
|
|
77
|
+
|
|
78
|
+
```python
|
|
79
|
+
import cohere
|
|
80
|
+
|
|
81
|
+
co = cohere.ClientV2(api_key="COHERE_API_KEY")
|
|
82
|
+
|
|
83
|
+
def rerank_documents(query: str, candidate_chunks: List[Dict], top_k: int = 5):
|
|
84
|
+
docs = [chunk["text"] for chunk in candidate_chunks]
|
|
85
|
+
response = co.rerank(
|
|
86
|
+
model="rerank-v3.5",
|
|
87
|
+
query=query,
|
|
88
|
+
documents=docs,
|
|
89
|
+
top_n=top_k
|
|
90
|
+
)
|
|
91
|
+
|
|
92
|
+
top_chunks = []
|
|
93
|
+
for item in response.results:
|
|
94
|
+
selected = candidate_chunks[item.index]
|
|
95
|
+
selected["relevance_score"] = item.relevance_score
|
|
96
|
+
top_chunks.append(selected)
|
|
97
|
+
return top_chunks
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## 4. Anti-Patterns & Pitfalls
|
|
103
|
+
- ❌ **Vector-Only Search**: Never rely strictly on cosine similarity for catalog, medical, or legal queries containing exact IDs or product codes. Always pair with BM25.
|
|
104
|
+
- ❌ **Score Addition without Normalization**: Never directly add raw BM25 scores (0–100+) to cosine distances (-1 to 1). Always use **RRF** (ordinal ranking).
|
|
105
|
+
- ❌ **Stuffing 20+ Unranked Chunks**: Dumping massive unranked contexts into the LLM causes the "Lost in the Middle" problem and explodes latency. Rerank down to top 3–5 chunks.
|
|
106
|
+
- ❌ **Arbitrary Fixed Chunking**: Chopping text at fixed 500 characters breaks sentences mid-thought. Use semantic markdown headers or sentence splitters.
|
|
107
|
+
|
|
108
|
+
---
|
|
109
|
+
|
|
110
|
+
## 5. References & Bundled Utilities
|
|
111
|
+
- RRF mathematics and parameter tuning: [references/rrfAlgorithm.md](references/rrfAlgorithm.md)
|
|
112
|
+
- Advanced chunking strategies (Parent-Child, Contextual Retrieval): [references/chunkingStrategies.md](references/chunkingStrategies.md)
|
|
113
|
+
- Standalone hybrid fusion script: [scripts/runHybridRrfSearch.py](scripts/runHybridRrfSearch.py)
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
{
|
|
2
|
+
"evals": [
|
|
3
|
+
{
|
|
4
|
+
"name": "rrf-formula-test",
|
|
5
|
+
"prompt": "Write the Python function to calculate reciprocal rank fusion for two lists with k=60.",
|
|
6
|
+
"expectedPattern": "1\\.0\\s*/\\s*\\(k\\s*\\+\\s*rank\\)"
|
|
7
|
+
},
|
|
8
|
+
{
|
|
9
|
+
"name": "cross-encoder-rerank",
|
|
10
|
+
"prompt": "Show how to use Cohere rerank to compress top-100 candidates to top-5 chunks.",
|
|
11
|
+
"expectedPattern": "co\\.rerank\\([\\s\\S]*model=[\"']rerank-v3"
|
|
12
|
+
}
|
|
13
|
+
]
|
|
14
|
+
}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Advanced Chunking Strategies for Production RAG
|
|
2
|
+
|
|
3
|
+
1. **Parent-Child Document Chunking**:
|
|
4
|
+
- Embed small chunks (e.g., 200 tokens) for precise vector matching.
|
|
5
|
+
- Return the larger parent document (e.g., 1000 tokens) to the LLM for full contextual understanding.
|
|
6
|
+
2. **Contextual Retrieval (Anthropic Pattern)**:
|
|
7
|
+
- Prepend a short LLM-generated document-level context summary (50–100 tokens) to every chunk before embedding.
|
|
8
|
+
- Slashes failed retrievals by keeping isolated paragraphs grounded in the parent subject.
|
|
9
|
+
3. **Markdown / Structural Chunking**:
|
|
10
|
+
- Split along Markdown headings (`#`, `##`, `###`) to preserve logical tables, lists, and sections intact.
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Reciprocal Rank Fusion (RRF) Reference
|
|
2
|
+
|
|
3
|
+
## Mathematical Definition
|
|
4
|
+
For a set of documents $D$ and a set of rankings $R$, the RRF score is:
|
|
5
|
+
|
|
6
|
+
$$RRF(d \in D) = \sum_{r \in R} \frac{1}{k + r(d)}$$
|
|
7
|
+
|
|
8
|
+
Where:
|
|
9
|
+
- $r(d)$ is the 1-based rank position of document $d$ in the current retriever.
|
|
10
|
+
- $k$ is the smoothing constant (canonical value is `60`).
|
|
11
|
+
|
|
12
|
+
## Why $k = 60$?
|
|
13
|
+
$k = 60$ prevents top-ranked documents in one retriever from completely overpowering documents that appear moderately high (e.g. position 2 to 5) across both retrievers.
|