cfsa-antigravity 3.0.2 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -10
- package/bin/cli.mjs +7 -6
- package/package.json +1 -1
- package/template/.agent/PRDS/codex-runtime-support.md +2 -2
- package/template/.agent/TASKS/codex-runtime-support.md +2 -2
- package/template/.agent/instructions/workflow.md +3 -3
- package/template/.agent/kit-sync.md +3 -3
- package/template/.agent/rules/completion-checklist.md +3 -3
- package/template/.agent/skills/parallel-agents/SKILL.md +1 -1
- package/template/.agent/skills/session-continuity/SKILL.md +6 -6
- package/template/.agent/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.agent/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.agent/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.agent/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.agent/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.agent/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.agent/workflows/create-prd-architecture.md +2 -2
- package/template/.agent/workflows/create-prd-design-system.md +2 -2
- package/template/.agent/workflows/create-prd-security.md +2 -2
- package/template/.agent/workflows/create-prd-stack.md +2 -2
- package/template/.agent/workflows/create-prd.md +2 -2
- package/template/.agent/workflows/decompose-architecture-validate.md +1 -1
- package/template/.agent/workflows/decompose-architecture.md +2 -2
- package/template/.agent/workflows/ideate.md +2 -2
- package/template/.agent/workflows/implement-slice-setup.md +1 -1
- package/template/.agent/workflows/implement-slice-tdd.md +3 -3
- package/template/.agent/workflows/implement-slice.md +2 -2
- package/template/.agent/workflows/plan-phase-preflight.md +2 -2
- package/template/.agent/workflows/plan-phase-write.md +2 -2
- package/template/.agent/workflows/plan-phase.md +2 -2
- package/template/.agent/workflows/setup-workspace.md +2 -2
- package/template/.agent/workflows/update-architecture-map.md +1 -1
- package/template/.agent/workflows/validate-phase-quality.md +1 -1
- package/template/.agent/workflows/validate-phase-readiness.md +2 -2
- package/template/.agent/workflows/validate-phase.md +2 -2
- package/template/.agent/workflows/verify-infrastructure.md +1 -1
- package/template/.agent/workflows/write-architecture-spec-deepen.md +3 -3
- package/template/.agent/workflows/write-architecture-spec-design.md +1 -1
- package/template/.agent/workflows/write-architecture-spec.md +3 -3
- package/template/.agent/workflows/write-be-spec-classify.md +1 -1
- package/template/.agent/workflows/write-be-spec-write.md +3 -3
- package/template/.agent/workflows/write-be-spec.md +3 -3
- package/template/.agent/workflows/write-fe-spec-classify.md +1 -1
- package/template/.agent/workflows/write-fe-spec-write.md +2 -2
- package/template/.agent/workflows/write-fe-spec.md +3 -3
- package/template/.claude/README.md +3 -1
- package/template/.claude/instructions/workflow.md +3 -3
- package/template/.claude/kit-sync.md +3 -3
- package/template/.claude/rules/completion-checklist.md +3 -3
- package/template/.claude/skills/parallel-agents/SKILL.md +1 -1
- package/template/.claude/skills/plan-phase/SKILL.md +2 -2
- package/template/.claude/skills/plan-phase-preflight/SKILL.md +2 -2
- package/template/.claude/skills/session-continuity/SKILL.md +6 -6
- package/template/.claude/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.claude/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.claude/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.claude/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.claude/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.claude/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.claude/skills/setup/setup-cfsa.md +1 -1
- package/template/.claude/skills/write-architecture-spec/SKILL.md +2 -2
- package/template/.claude/skills/write-architecture-spec-deepen/SKILL.md +1 -1
- package/template/.claude/skills/write-architecture-spec-design/SKILL.md +1 -1
- package/template/.claude/skills/write-be-spec/SKILL.md +3 -3
- package/template/.claude/skills/write-be-spec-classify/SKILL.md +1 -1
- package/template/.claude/skills/write-be-spec-write/SKILL.md +1 -1
- package/template/.claude/skills/write-fe-spec/SKILL.md +3 -3
- package/template/.claude/skills/write-fe-spec-write/SKILL.md +1 -1
- package/template/.codex/README.md +99 -0
- package/template/.codex/instructions/commands.md +24 -0
- package/template/.codex/instructions/example.md +21 -0
- package/template/.codex/instructions/patterns.md +61 -0
- package/template/.codex/instructions/structure.md +29 -0
- package/template/.codex/instructions/tech-stack.md +93 -0
- package/template/.codex/instructions/workflow.md +64 -0
- package/template/.codex/kit-sync.md +6 -0
- package/template/.codex/rules/boundary-not-placeholder.md +146 -0
- package/template/.codex/rules/completion-checklist.md +60 -0
- package/template/.codex/rules/debug-by-test.md +49 -0
- package/template/.codex/rules/decision-classification.md +113 -0
- package/template/.codex/rules/extensibility.md +52 -0
- package/template/.codex/rules/memory-capture.md +84 -0
- package/template/.codex/rules/question-vs-command.md +91 -0
- package/template/.codex/rules/security-first.md +54 -0
- package/template/.codex/rules/single-question.md +59 -0
- package/template/.codex/rules/skill-mcp-first.md +45 -0
- package/template/.codex/rules/source-before-ask.md +93 -0
- package/template/.codex/rules/specificity-standards.md +64 -0
- package/template/.codex/rules/tdd-contract-first.md +67 -0
- package/template/.codex/rules/vertical-slices.md +83 -0
- package/template/.codex/skill-library/MANIFEST.md +498 -0
- package/template/.codex/skill-library/README.md +38 -0
- package/template/.codex/skill-library/meta/claude-code/README.md +9 -0
- package/template/.codex/skill-library/meta/claude-code/agent-development/SKILL.md +415 -0
- package/template/.codex/skill-library/meta/claude-code/hook-development/SKILL.md +712 -0
- package/template/.codex/skill-library/meta/claude-code/plugin-structure/SKILL.md +476 -0
- package/template/.codex/skill-library/meta/mcp-builder/SKILL.md +236 -0
- package/template/.codex/skill-library/meta/product-marketing-context/SKILL.md +241 -0
- package/template/.codex/skill-library/meta/tmux-processes/SKILL.md +210 -0
- package/template/.codex/skill-library/meta/using-tmux-for-interactive-commands/SKILL.md +178 -0
- package/template/.codex/skill-library/stack/3d/threejs-pro/SKILL.md +300 -0
- package/template/.codex/skill-library/stack/ai/ai-sdk/SKILL.md +77 -0
- package/template/.codex/skill-library/stack/ai/langchain/SKILL.md +530 -0
- package/template/.codex/skill-library/stack/ai/ollama/SKILL.md +321 -0
- package/template/.codex/skill-library/stack/ai/openai-sdk/SKILL.md +549 -0
- package/template/.codex/skill-library/stack/analytics/google-analytics/SKILL.md +153 -0
- package/template/.codex/skill-library/stack/api/graphql/SKILL.md +1061 -0
- package/template/.codex/skill-library/stack/api/trpc/SKILL.md +576 -0
- package/template/.codex/skill-library/stack/auth/authjs/SKILL.md +569 -0
- package/template/.codex/skill-library/stack/auth/clerk/SKILL.md +590 -0
- package/template/.codex/skill-library/stack/auth/firebase-auth/SKILL.md +734 -0
- package/template/.codex/skill-library/stack/auth/lucia/SKILL.md +230 -0
- package/template/.codex/skill-library/stack/auth/supabase-auth/SKILL.md +293 -0
- package/template/.codex/skill-library/stack/cms/payload-cms/SKILL.md +573 -0
- package/template/.codex/skill-library/stack/cms/shopify/SKILL.md +1193 -0
- package/template/.codex/skill-library/stack/cms/wordpress/SKILL.md +1104 -0
- package/template/.codex/skill-library/stack/css/sass-scss/SKILL.md +1121 -0
- package/template/.codex/skill-library/stack/css/tailwind-css-patterns/SKILL.md +863 -0
- package/template/.codex/skill-library/stack/css/tailwind-design-system/SKILL.md +490 -0
- package/template/.codex/skill-library/stack/css/vanilla-css/SKILL.md +1078 -0
- package/template/.codex/skill-library/stack/databases/clickhouse/SKILL.md +311 -0
- package/template/.codex/skill-library/stack/databases/influxdb/SKILL.md +280 -0
- package/template/.codex/skill-library/stack/databases/lancedb/SKILL.md +415 -0
- package/template/.codex/skill-library/stack/databases/mongodb/SKILL.md +1169 -0
- package/template/.codex/skill-library/stack/databases/neo4j/SKILL.md +839 -0
- package/template/.codex/skill-library/stack/databases/pgvector/SKILL.md +241 -0
- package/template/.codex/skill-library/stack/databases/pinecone/SKILL.md +212 -0
- package/template/.codex/skill-library/stack/databases/postgresql/SKILL.md +658 -0
- package/template/.codex/skill-library/stack/databases/qdrant/SKILL.md +312 -0
- package/template/.codex/skill-library/stack/databases/redis/SKILL.md +1079 -0
- package/template/.codex/skill-library/stack/databases/spacetimedb/SKILL.md +532 -0
- package/template/.codex/skill-library/stack/databases/sqlite/SKILL.md +1132 -0
- package/template/.codex/skill-library/stack/databases/supabase/SKILL.md +640 -0
- package/template/.codex/skill-library/stack/databases/surrealdb-expert/SKILL.md +945 -0
- package/template/.codex/skill-library/stack/databases/timescaledb/SKILL.md +745 -0
- package/template/.codex/skill-library/stack/databases/weaviate/SKILL.md +218 -0
- package/template/.codex/skill-library/stack/devops/git-advanced/SKILL.md +972 -0
- package/template/.codex/skill-library/stack/devops/git-workflow/SKILL.md +420 -0
- package/template/.codex/skill-library/stack/devops/github-actions/SKILL.md +554 -0
- package/template/.codex/skill-library/stack/devops/kubernetes/SKILL.md +950 -0
- package/template/.codex/skill-library/stack/devops/nginx/SKILL.md +841 -0
- package/template/.codex/skill-library/stack/devops/terraform/SKILL.md +860 -0
- package/template/.codex/skill-library/stack/email/resend/SKILL.md +391 -0
- package/template/.codex/skill-library/stack/extensions/chrome-extension/SKILL.md +375 -0
- package/template/.codex/skill-library/stack/extensions/plasmo/SKILL.md +195 -0
- package/template/.codex/skill-library/stack/extensions/vscode-extension/SKILL.md +453 -0
- package/template/.codex/skill-library/stack/extensions/wxt/SKILL.md +216 -0
- package/template/.codex/skill-library/stack/feature-flags/flagsmith/SKILL.md +187 -0
- package/template/.codex/skill-library/stack/feature-flags/launchdarkly/SKILL.md +183 -0
- package/template/.codex/skill-library/stack/feature-flags/posthog-flags/SKILL.md +189 -0
- package/template/.codex/skill-library/stack/frameworks/astro-framework/SKILL.md +162 -0
- package/template/.codex/skill-library/stack/frameworks/electron/SKILL.md +1286 -0
- package/template/.codex/skill-library/stack/frameworks/fastapi/SKILL.md +650 -0
- package/template/.codex/skill-library/stack/frameworks/hono/SKILL.md +90 -0
- package/template/.codex/skill-library/stack/frameworks/nestjs/SKILL.md +878 -0
- package/template/.codex/skill-library/stack/frameworks/nextjs/SKILL.md +635 -0
- package/template/.codex/skill-library/stack/frameworks/nuxt/SKILL.md +564 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/SKILL.md +81 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/events.md +353 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/migration.md +339 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/performance.md +443 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/runes.md +394 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/snippets.md +291 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/sveltekit.md +401 -0
- package/template/.codex/skill-library/stack/frameworks/svelte5/references/typescript.md +305 -0
- package/template/.codex/skill-library/stack/frameworks/sveltekit/SKILL.md +614 -0
- package/template/.codex/skill-library/stack/frameworks/tauri/SKILL.md +920 -0
- package/template/.codex/skill-library/stack/gamedev/godot/SKILL.md +1032 -0
- package/template/.codex/skill-library/stack/gamedev/unity/SKILL.md +1175 -0
- package/template/.codex/skill-library/stack/hosting/aws/SKILL.md +467 -0
- package/template/.codex/skill-library/stack/hosting/cloudflare/SKILL.md +201 -0
- package/template/.codex/skill-library/stack/hosting/docker-expert/SKILL.md +409 -0
- package/template/.codex/skill-library/stack/hosting/vercel/SKILL.md +484 -0
- package/template/.codex/skill-library/stack/languages/bash-scripting/SKILL.md +773 -0
- package/template/.codex/skill-library/stack/languages/c-cpp/SKILL.md +712 -0
- package/template/.codex/skill-library/stack/languages/gdscript/SKILL.md +789 -0
- package/template/.codex/skill-library/stack/languages/go/SKILL.md +664 -0
- package/template/.codex/skill-library/stack/languages/java/SKILL.md +778 -0
- package/template/.codex/skill-library/stack/languages/kotlin/SKILL.md +665 -0
- package/template/.codex/skill-library/stack/languages/python/SKILL.md +678 -0
- package/template/.codex/skill-library/stack/languages/rust/SKILL.md +673 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/SKILL.md +141 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/advanced-generics.md +90 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/branded-types.md +57 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/builder-pattern.md +71 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/common-pitfalls.md +135 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/conditional-types.md +27 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/decorators.md +98 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/discriminated-unions.md +62 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/mapped-types.md +53 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/performance-best-practices.md +104 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/template-literal-types.md +49 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/testing-types.md +112 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/type-guards.md +70 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/type-inference.md +101 -0
- package/template/.codex/skill-library/stack/languages/typescript-advanced-patterns/references/utility-types.md +98 -0
- package/template/.codex/skill-library/stack/languages/vanilla-javascript/SKILL.md +803 -0
- package/template/.codex/skill-library/stack/messaging/kafka/SKILL.md +235 -0
- package/template/.codex/skill-library/stack/messaging/nats/SKILL.md +147 -0
- package/template/.codex/skill-library/stack/messaging/rabbitmq/SKILL.md +178 -0
- package/template/.codex/skill-library/stack/messaging/sqs/SKILL.md +187 -0
- package/template/.codex/skill-library/stack/mobile/expo-react-native/SKILL.md +665 -0
- package/template/.codex/skill-library/stack/mobile/flutter/SKILL.md +316 -0
- package/template/.codex/skill-library/stack/mobile/kotlin-compose/SKILL.md +215 -0
- package/template/.codex/skill-library/stack/mobile/react-native/SKILL.md +337 -0
- package/template/.codex/skill-library/stack/mobile/swiftui/SKILL.md +261 -0
- package/template/.codex/skill-library/stack/monitoring/posthog/SKILL.md +396 -0
- package/template/.codex/skill-library/stack/monitoring/sentry/SKILL.md +509 -0
- package/template/.codex/skill-library/stack/notifications/fcm/SKILL.md +229 -0
- package/template/.codex/skill-library/stack/notifications/sendgrid/SKILL.md +220 -0
- package/template/.codex/skill-library/stack/notifications/twilio/SKILL.md +204 -0
- package/template/.codex/skill-library/stack/observability/datadog/SKILL.md +179 -0
- package/template/.codex/skill-library/stack/observability/distributed-tracing/SKILL.md +140 -0
- package/template/.codex/skill-library/stack/observability/opentelemetry/SKILL.md +164 -0
- package/template/.codex/skill-library/stack/observability/prometheus-grafana/SKILL.md +246 -0
- package/template/.codex/skill-library/stack/observability/python-observability/SKILL.md +158 -0
- package/template/.codex/skill-library/stack/orm/drizzle-orm/SKILL.md +613 -0
- package/template/.codex/skill-library/stack/orm/prisma/SKILL.md +744 -0
- package/template/.codex/skill-library/stack/payments/lemonsqueezy/SKILL.md +393 -0
- package/template/.codex/skill-library/stack/payments/stripe-integration/SKILL.md +457 -0
- package/template/.codex/skill-library/stack/queue/bullmq/SKILL.md +385 -0
- package/template/.codex/skill-library/stack/queue/inngest/SKILL.md +438 -0
- package/template/.codex/skill-library/stack/realtime/socketio/SKILL.md +595 -0
- package/template/.codex/skill-library/stack/search/algolia/SKILL.md +206 -0
- package/template/.codex/skill-library/stack/search/elasticsearch/SKILL.md +248 -0
- package/template/.codex/skill-library/stack/search/meilisearch/SKILL.md +385 -0
- package/template/.codex/skill-library/stack/search/typesense/SKILL.md +189 -0
- package/template/.codex/skill-library/stack/security/crypto-patterns/SKILL.md +437 -0
- package/template/.codex/skill-library/stack/security/csp-cors-headers/SKILL.md +588 -0
- package/template/.codex/skill-library/stack/security/dependency-auditing/SKILL.md +560 -0
- package/template/.codex/skill-library/stack/security/input-sanitization/SKILL.md +430 -0
- package/template/.codex/skill-library/stack/security/owasp-web-security/SKILL.md +421 -0
- package/template/.codex/skill-library/stack/state/tanstack-query/SKILL.md +637 -0
- package/template/.codex/skill-library/stack/state/zustand/SKILL.md +483 -0
- package/template/.codex/skill-library/stack/storage/aws-s3/SKILL.md +415 -0
- package/template/.codex/skill-library/stack/storage/cloudflare-r2/SKILL.md +252 -0
- package/template/.codex/skill-library/stack/storage/gcs/SKILL.md +229 -0
- package/template/.codex/skill-library/stack/testing/playwright/SKILL.md +641 -0
- package/template/.codex/skill-library/stack/testing/storybook/SKILL.md +923 -0
- package/template/.codex/skill-library/stack/testing/testing-library/SKILL.md +872 -0
- package/template/.codex/skill-library/stack/testing/vitest/SKILL.md +714 -0
- package/template/.codex/skill-library/stack/ui/react-best-practices/SKILL.md +877 -0
- package/template/.codex/skill-library/stack/ui/react-composition-patterns/SKILL.md +1107 -0
- package/template/.codex/skill-library/stack/ui/react-flow/SKILL.md +425 -0
- package/template/.codex/skill-library/stack/ui/shadcn-ui/SKILL.md +703 -0
- package/template/.codex/skill-library/stack/ui/svelte-flow/SKILL.md +390 -0
- package/template/.codex/skill-library/surface/api/api-caching/SKILL.md +458 -0
- package/template/.codex/skill-library/surface/api/api-documentation-openapi/SKILL.md +697 -0
- package/template/.codex/skill-library/surface/api/api-error-handling/SKILL.md +478 -0
- package/template/.codex/skill-library/surface/api/api-security-checklist/SKILL.md +147 -0
- package/template/.codex/skill-library/surface/api/email-best-practices/SKILL.md +59 -0
- package/template/.codex/skill-library/surface/api/rate-limiting-abuse-protection/SKILL.md +147 -0
- package/template/.codex/skill-library/surface/api/webhook-design/SKILL.md +752 -0
- package/template/.codex/skill-library/surface/cli/cli-configuration-management/SKILL.md +445 -0
- package/template/.codex/skill-library/surface/cli/cli-error-diagnostics/SKILL.md +515 -0
- package/template/.codex/skill-library/surface/cli/cli-shell-integration/SKILL.md +479 -0
- package/template/.codex/skill-library/surface/cli/cli-ux-design/SKILL.md +477 -0
- package/template/.codex/skill-library/surface/desktop/desktop-app-distribution/SKILL.md +416 -0
- package/template/.codex/skill-library/surface/desktop/desktop-security-sandboxing/SKILL.md +407 -0
- package/template/.codex/skill-library/surface/desktop/desktop-ux-conventions/SKILL.md +361 -0
- package/template/.codex/skill-library/surface/desktop/native-os-integration/SKILL.md +563 -0
- package/template/.codex/skill-library/surface/extension/browser-extension-patterns/SKILL.md +482 -0
- package/template/.codex/skill-library/surface/extension/plugin-architecture-design/SKILL.md +632 -0
- package/template/.codex/skill-library/surface/extension/vscode-extension-development/SKILL.md +728 -0
- package/template/.codex/skill-library/surface/mobile/app-store-submission/SKILL.md +304 -0
- package/template/.codex/skill-library/surface/mobile/mobile-offline-sync/SKILL.md +443 -0
- package/template/.codex/skill-library/surface/mobile/mobile-responsive-patterns/SKILL.md +432 -0
- package/template/.codex/skill-library/surface/mobile/push-notifications/SKILL.md +495 -0
- package/template/.codex/skill-library/surface/web/accessibility-compliance/SKILL.md +827 -0
- package/template/.codex/skill-library/surface/web/ai-seo/SKILL.md +398 -0
- package/template/.codex/skill-library/surface/web/ai-seo/references/content-patterns.md +285 -0
- package/template/.codex/skill-library/surface/web/ai-seo/references/platform-ranking-factors.md +152 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/SKILL.md +309 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/event-library.md +260 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/ga4-implementation.md +300 -0
- package/template/.codex/skill-library/surface/web/analytics-tracking/references/gtm-implementation.md +390 -0
- package/template/.codex/skill-library/surface/web/authentication-ui-flows/SKILL.md +530 -0
- package/template/.codex/skill-library/surface/web/dark-mode-theming/SKILL.md +516 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/SKILL.md +105 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/charts.csv +26 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/colors.csv +97 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/landing.csv +31 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/styles.csv +59 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/typography.csv +58 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/data/ux-guidelines.csv +100 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/core.py +258 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/design_system.py +1067 -0
- package/template/.codex/skill-library/surface/web/design-reference-data/scripts/search.py +106 -0
- package/template/.codex/skill-library/surface/web/form-handling-validation/SKILL.md +675 -0
- package/template/.codex/skill-library/surface/web/frontend-design/SKILL.md +1393 -0
- package/template/.codex/skill-library/surface/web/frontend-design/templates/cppn-hero.tsx +299 -0
- package/template/.codex/skill-library/surface/web/frontend-design/templates/wave-hero.tsx +875 -0
- package/template/.codex/skill-library/surface/web/frontend-verification/SKILL.md +111 -0
- package/template/.codex/skill-library/surface/web/frontend-verification/scripts/ux_audit.py +739 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/SKILL.md +332 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/icu-message-format.md +223 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/intl-api-patterns.md +326 -0
- package/template/.codex/skill-library/surface/web/i18n-localization/references/rtl-support.md +298 -0
- package/template/.codex/skill-library/surface/web/offline-first-pwa/SKILL.md +657 -0
- package/template/.codex/skill-library/surface/web/page-cro/SKILL.md +182 -0
- package/template/.codex/skill-library/surface/web/page-cro/references/experiments.md +248 -0
- package/template/.codex/skill-library/surface/web/programmatic-seo/SKILL.md +238 -0
- package/template/.codex/skill-library/surface/web/programmatic-seo/references/playbooks.md +308 -0
- package/template/.codex/skill-library/surface/web/schema-markup/SKILL.md +179 -0
- package/template/.codex/skill-library/surface/web/schema-markup/references/schema-examples.md +398 -0
- package/template/.codex/skill-library/surface/web/seo-audit/SKILL.md +394 -0
- package/template/.codex/skill-library/surface/web/seo-audit/references/ai-writing-detection.md +200 -0
- package/template/.codex/skill-library/surface/web/web-performance-optimization/SKILL.md +646 -0
- package/template/.codex/skill-library/surface/web/web-scraping/SKILL.md +58 -0
- package/template/.codex/skills/README.md +78 -0
- package/template/.codex/skills/accessibility/SKILL.md +522 -0
- package/template/.codex/skills/accessibility/references/WCAG.md +162 -0
- package/template/.codex/skills/accessibility/references/ia-spec-checklist.md +35 -0
- package/template/.codex/skills/adversarial-review/SKILL.md +90 -0
- package/template/.codex/skills/antigravity-workflows/SKILL.md +81 -0
- package/template/.codex/skills/antigravity-workflows/resources/implementation-playbook.md +36 -0
- package/template/.codex/skills/api-design-principles/SKILL.md +169 -0
- package/template/.codex/skills/api-design-principles/assets/api-design-checklist.md +155 -0
- package/template/.codex/skills/api-design-principles/assets/rest-api-template.py +182 -0
- package/template/.codex/skills/api-design-principles/references/graphql-schema-design.md +583 -0
- package/template/.codex/skills/api-design-principles/references/rest-best-practices.md +408 -0
- package/template/.codex/skills/api-design-principles/resources/implementation-playbook.md +513 -0
- package/template/.codex/skills/api-versioning/SKILL.md +166 -0
- package/template/.codex/skills/api-versioning/references/typescript.md +157 -0
- package/template/.codex/skills/architecture-mapping/SKILL.md +219 -0
- package/template/.codex/skills/audit-ambiguity/SKILL.md +54 -0
- package/template/.codex/skills/audit-ambiguity-execute/SKILL.md +86 -0
- package/template/.codex/skills/audit-ambiguity-rubrics/SKILL.md +58 -0
- package/template/.codex/skills/bootstrap-agents/SKILL.md +258 -0
- package/template/.codex/skills/bootstrap-agents-fill/SKILL.md +25 -0
- package/template/.codex/skills/bootstrap-agents-provision/SKILL.md +22 -0
- package/template/.codex/skills/brainstorming/SKILL.md +177 -0
- package/template/.codex/skills/brand-guidelines/SKILL.md +44 -0
- package/template/.codex/skills/clean-code/SKILL.md +196 -0
- package/template/.codex/skills/clean-code/references/typescript.md +126 -0
- package/template/.codex/skills/code-review-pro/SKILL.md +152 -0
- package/template/.codex/skills/concise-planning/SKILL.md +107 -0
- package/template/.codex/skills/create-prd/SKILL.md +94 -0
- package/template/.codex/skills/create-prd-architecture/SKILL.md +72 -0
- package/template/.codex/skills/create-prd-compile/SKILL.md +85 -0
- package/template/.codex/skills/create-prd-design-system/SKILL.md +69 -0
- package/template/.codex/skills/create-prd-security/SKILL.md +66 -0
- package/template/.codex/skills/create-prd-stack/SKILL.md +84 -0
- package/template/.codex/skills/cross-layer-consistency/SKILL.md +117 -0
- package/template/.codex/skills/database-schema-design/SKILL.md +205 -0
- package/template/.codex/skills/database-schema-design/references/relational.md +228 -0
- package/template/.codex/skills/decompose-architecture/SKILL.md +72 -0
- package/template/.codex/skills/decompose-architecture-structure/SKILL.md +62 -0
- package/template/.codex/skills/decompose-architecture-validate/SKILL.md +72 -0
- package/template/.codex/skills/deployment-procedures/SKILL.md +241 -0
- package/template/.codex/skills/design-anti-cliche/SKILL.md +159 -0
- package/template/.codex/skills/design-direction/SKILL.md +45 -0
- package/template/.codex/skills/error-handling-patterns/SKILL.md +226 -0
- package/template/.codex/skills/error-handling-patterns/references/go.md +162 -0
- package/template/.codex/skills/error-handling-patterns/references/python.md +262 -0
- package/template/.codex/skills/error-handling-patterns/references/rust.md +112 -0
- package/template/.codex/skills/error-handling-patterns/references/typescript.md +178 -0
- package/template/.codex/skills/evolve-contract/SKILL.md +24 -0
- package/template/.codex/skills/evolve-feature/SKILL.md +18 -0
- package/template/.codex/skills/evolve-feature-cascade/SKILL.md +24 -0
- package/template/.codex/skills/evolve-feature-classify/SKILL.md +21 -0
- package/template/.codex/skills/find-skills/SKILL.md +145 -0
- package/template/.codex/skills/git-advanced/SKILL.md +972 -0
- package/template/.codex/skills/git-workflow/SKILL.md +420 -0
- package/template/.codex/skills/idea-extraction/SKILL.md +644 -0
- package/template/.codex/skills/ideate/SKILL.md +77 -0
- package/template/.codex/skills/ideate-discover/SKILL.md +89 -0
- package/template/.codex/skills/ideate-extract/SKILL.md +77 -0
- package/template/.codex/skills/ideate-validate/SKILL.md +75 -0
- package/template/.codex/skills/implement-slice/SKILL.md +64 -0
- package/template/.codex/skills/implement-slice-setup/SKILL.md +70 -0
- package/template/.codex/skills/implement-slice-tdd/SKILL.md +78 -0
- package/template/.codex/skills/logging-best-practices/SKILL.md +192 -0
- package/template/.codex/skills/logging-best-practices/references/go.md +49 -0
- package/template/.codex/skills/logging-best-practices/references/python.md +52 -0
- package/template/.codex/skills/logging-best-practices/references/typescript.md +215 -0
- package/template/.codex/skills/migration-management/SKILL.md +200 -0
- package/template/.codex/skills/migration-management/references/relational.md +214 -0
- package/template/.codex/skills/minimalist-surgical-development/SKILL.md +135 -0
- package/template/.codex/skills/parallel-agents/SKILL.md +165 -0
- package/template/.codex/skills/parallel-debugging/SKILL.md +135 -0
- package/template/.codex/skills/parallel-feature-development/SKILL.md +157 -0
- package/template/.codex/skills/performance-budgeting/SKILL.md +144 -0
- package/template/.codex/skills/pipeline-rubrics/SKILL.md +51 -0
- package/template/.codex/skills/pipeline-rubrics/references/architecture-rubric.md +19 -0
- package/template/.codex/skills/pipeline-rubrics/references/be-rubric.md +21 -0
- package/template/.codex/skills/pipeline-rubrics/references/fe-rubric.md +20 -0
- package/template/.codex/skills/pipeline-rubrics/references/ia-rubric.md +19 -0
- package/template/.codex/skills/pipeline-rubrics/references/scoring.md +32 -0
- package/template/.codex/skills/pipeline-rubrics/references/vision-rubric.md +12 -0
- package/template/.codex/skills/plan-phase/SKILL.md +62 -0
- package/template/.codex/skills/plan-phase-preflight/SKILL.md +75 -0
- package/template/.codex/skills/plan-phase-write/SKILL.md +85 -0
- package/template/.codex/skills/prd-templates/SKILL.md +107 -0
- package/template/.codex/skills/prd-templates/references/architecture-completeness-checklist.md +28 -0
- package/template/.codex/skills/prd-templates/references/architecture-design-template.md +88 -0
- package/template/.codex/skills/prd-templates/references/be-spec-classification.md +41 -0
- package/template/.codex/skills/prd-templates/references/be-spec-template.md +107 -0
- package/template/.codex/skills/prd-templates/references/bootstrap-verification-protocol.md +50 -0
- package/template/.codex/skills/prd-templates/references/constraint-exploration.md +41 -0
- package/template/.codex/skills/prd-templates/references/data-placement-template.md +74 -0
- package/template/.codex/skills/prd-templates/references/decision-confirmation-protocol.md +68 -0
- package/template/.codex/skills/prd-templates/references/decision-propagation.md +121 -0
- package/template/.codex/skills/prd-templates/references/decomposition-templates.md +226 -0
- package/template/.codex/skills/prd-templates/references/deep-ideation-loading-protocol.md +114 -0
- package/template/.codex/skills/prd-templates/references/design-system-decisions.md +198 -0
- package/template/.codex/skills/prd-templates/references/design-system-prerequisite-check.md +18 -0
- package/template/.codex/skills/prd-templates/references/domain-exhaustion-criteria.md +37 -0
- package/template/.codex/skills/prd-templates/references/engagement-tier-protocol.md +58 -0
- package/template/.codex/skills/prd-templates/references/engineering-standards-template.md +126 -0
- package/template/.codex/skills/prd-templates/references/evolution-layer-guidance.md +91 -0
- package/template/.codex/skills/prd-templates/references/expansion-modes.md +27 -0
- package/template/.codex/skills/prd-templates/references/fe-classification-procedures.md +47 -0
- package/template/.codex/skills/prd-templates/references/fe-spec-template.md +90 -0
- package/template/.codex/skills/prd-templates/references/feature-ledger-protocol.md +149 -0
- package/template/.codex/skills/prd-templates/references/folder-seeding-protocol.md +77 -0
- package/template/.codex/skills/prd-templates/references/fractal-cx-template.md +58 -0
- package/template/.codex/skills/prd-templates/references/fractal-feature-template.md +93 -0
- package/template/.codex/skills/prd-templates/references/fractal-node-index-template.md +55 -0
- package/template/.codex/skills/prd-templates/references/gate-applicability.md +92 -0
- package/template/.codex/skills/prd-templates/references/ideation-crosscut-template.md +36 -0
- package/template/.codex/skills/prd-templates/references/ideation-index-template.md +111 -0
- package/template/.codex/skills/prd-templates/references/ideation-meta-template.md +126 -0
- package/template/.codex/skills/prd-templates/references/infrastructure-report-template.md +71 -0
- package/template/.codex/skills/prd-templates/references/input-classification.md +23 -0
- package/template/.codex/skills/prd-templates/references/map-guard-protocol.md +65 -0
- package/template/.codex/skills/prd-templates/references/operational-templates.md +116 -0
- package/template/.codex/skills/prd-templates/references/persona-completeness-gate.md +20 -0
- package/template/.codex/skills/prd-templates/references/placeholder-guard-template.md +21 -0
- package/template/.codex/skills/prd-templates/references/placeholder-workflow-mapping.md +50 -0
- package/template/.codex/skills/prd-templates/references/shard-boundary-analysis.md +103 -0
- package/template/.codex/skills/prd-templates/references/shard-split-remediation.md +157 -0
- package/template/.codex/skills/prd-templates/references/skill-loading-protocol.md +36 -0
- package/template/.codex/skills/prd-templates/references/slice-completion-gates.md +29 -0
- package/template/.codex/skills/prd-templates/references/spec-coverage-sweep.md +44 -0
- package/template/.codex/skills/prd-templates/references/surface-model.md +61 -0
- package/template/.codex/skills/prd-templates/references/tdd-testing-policy.md +39 -0
- package/template/.codex/skills/prd-templates/references/vision-template.md +57 -0
- package/template/.codex/skills/prd-templates/references/workflow-checkpoint-protocol.md +112 -0
- package/template/.codex/skills/prd-templates/references/write-verification-protocol.md +57 -0
- package/template/.codex/skills/prompt-engineer/SKILL.md +203 -0
- package/template/.codex/skills/propagate-decision/SKILL.md +18 -0
- package/template/.codex/skills/propagate-decision-apply/SKILL.md +22 -0
- package/template/.codex/skills/propagate-decision-scan/SKILL.md +20 -0
- package/template/.codex/skills/regex-patterns/SKILL.md +333 -0
- package/template/.codex/skills/regex-patterns/references/go.md +44 -0
- package/template/.codex/skills/regex-patterns/references/javascript.md +63 -0
- package/template/.codex/skills/regex-patterns/references/python.md +77 -0
- package/template/.codex/skills/regex-patterns/references/rust.md +43 -0
- package/template/.codex/skills/remediate-pipeline/SKILL.md +18 -0
- package/template/.codex/skills/remediate-pipeline-assess/SKILL.md +21 -0
- package/template/.codex/skills/remediate-pipeline-execute/SKILL.md +23 -0
- package/template/.codex/skills/remediate-shard-split/SKILL.md +21 -0
- package/template/.codex/skills/resolve-ambiguity/SKILL.md +278 -0
- package/template/.codex/skills/security-scanning-security-hardening/SKILL.md +231 -0
- package/template/.codex/skills/session-continuity/SKILL.md +732 -0
- package/template/.codex/skills/session-continuity/protocols/01-session-resumption.md +38 -0
- package/template/.codex/skills/session-continuity/protocols/02-progress-generation.md +85 -0
- package/template/.codex/skills/session-continuity/protocols/03-progress-update.md +70 -0
- package/template/.codex/skills/session-continuity/protocols/04-pattern-extraction.md +60 -0
- package/template/.codex/skills/session-continuity/protocols/05-session-close.md +37 -0
- package/template/.codex/skills/session-continuity/protocols/06-decision-analysis.md +84 -0
- package/template/.codex/skills/session-continuity/protocols/07-spec-pipeline-generation.md +48 -0
- package/template/.codex/skills/session-continuity/protocols/08-spec-pipeline-update.md +65 -0
- package/template/.codex/skills/session-continuity/protocols/09-parallel-claim.md +122 -0
- package/template/.codex/skills/session-continuity/protocols/10-placeholder-verification-gate.md +83 -0
- package/template/.codex/skills/session-continuity/protocols/11-parallel-synthesis.md +21 -0
- package/template/.codex/skills/session-continuity/protocols/ambiguity-gates.md +48 -0
- package/template/.codex/skills/setup/README.md +24 -0
- package/template/.codex/skills/setup/setup-cfsa.md +200 -0
- package/template/.codex/skills/setup/setup-fill-placeholders.md +192 -0
- package/template/.codex/skills/setup/setup-provision-skills.md +82 -0
- package/template/.codex/skills/setup/setup-verify.md +89 -0
- package/template/.codex/skills/setup-workspace/SKILL.md +83 -0
- package/template/.codex/skills/setup-workspace-cicd/SKILL.md +56 -0
- package/template/.codex/skills/setup-workspace-data/SKILL.md +69 -0
- package/template/.codex/skills/setup-workspace-hosting/SKILL.md +59 -0
- package/template/.codex/skills/setup-workspace-scaffold/SKILL.md +72 -0
- package/template/.codex/skills/skill-creator/SKILL.md +203 -0
- package/template/.codex/skills/spec-writing/SKILL.md +110 -0
- package/template/.codex/skills/sync-kit/SKILL.md +23 -0
- package/template/.codex/skills/systematic-debugging/CREATION-LOG.md +119 -0
- package/template/.codex/skills/systematic-debugging/SKILL.md +297 -0
- package/template/.codex/skills/systematic-debugging/condition-based-waiting-example.ts +158 -0
- package/template/.codex/skills/systematic-debugging/condition-based-waiting.md +115 -0
- package/template/.codex/skills/systematic-debugging/defense-in-depth.md +122 -0
- package/template/.codex/skills/systematic-debugging/find-polluter.sh +63 -0
- package/template/.codex/skills/systematic-debugging/root-cause-tracing.md +169 -0
- package/template/.codex/skills/systematic-debugging/test-academic.md +14 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-1.md +58 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-2.md +68 -0
- package/template/.codex/skills/systematic-debugging/test-pressure-3.md +69 -0
- package/template/.codex/skills/tdd-workflow/SKILL.md +186 -0
- package/template/.codex/skills/tdd-workflow/references/typescript.md +231 -0
- package/template/.codex/skills/tech-stack-catalog/SKILL.md +49 -0
- package/template/.codex/skills/tech-stack-catalog/references/constraint-questions.md +237 -0
- package/template/.codex/skills/tech-stack-catalog/references/dev-tooling-decisions.md +37 -0
- package/template/.codex/skills/tech-stack-catalog/references/surface-decision-tables.md +69 -0
- package/template/.codex/skills/technical-writer/SKILL.md +242 -0
- package/template/.codex/skills/testing-strategist/SKILL.md +319 -0
- package/template/.codex/skills/testing-strategist/references/typescript.md +328 -0
- package/template/.codex/skills/update-architecture-map/SKILL.md +21 -0
- package/template/.codex/skills/utilities/resolve-skill.md +195 -0
- package/template/.codex/skills/validate-phase/SKILL.md +62 -0
- package/template/.codex/skills/validate-phase-quality/SKILL.md +67 -0
- package/template/.codex/skills/validate-phase-readiness/SKILL.md +74 -0
- package/template/.codex/skills/verification-before-completion/SKILL.md +97 -0
- package/template/.codex/skills/verify-infrastructure/SKILL.md +25 -0
- package/template/.codex/skills/workflow-automation/SKILL.md +166 -0
- package/template/.codex/skills/workflow-automation/references/inngest.md +88 -0
- package/template/.codex/skills/workflow-automation/references/temporal.md +64 -0
- package/template/.codex/skills/write-architecture-spec/SKILL.md +78 -0
- package/template/.codex/skills/write-architecture-spec-deepen/SKILL.md +82 -0
- package/template/.codex/skills/write-architecture-spec-design/SKILL.md +80 -0
- package/template/.codex/skills/write-be-spec/SKILL.md +75 -0
- package/template/.codex/skills/write-be-spec-classify/SKILL.md +80 -0
- package/template/.codex/skills/write-be-spec-write/SKILL.md +99 -0
- package/template/.codex/skills/write-fe-spec/SKILL.md +79 -0
- package/template/.codex/skills/write-fe-spec-classify/SKILL.md +77 -0
- package/template/.codex/skills/write-fe-spec-write/SKILL.md +88 -0
- package/template/.factory/README.md +2 -3
- package/template/.factory/instructions/workflow.md +3 -3
- package/template/.factory/kit-sync.md +3 -3
- package/template/.factory/skills/completion-checklist/SKILL.md +3 -3
- package/template/.factory/skills/parallel-agents/SKILL.md +1 -1
- package/template/.factory/skills/plan-phase/SKILL.md +2 -2
- package/template/.factory/skills/plan-phase-preflight/SKILL.md +2 -2
- package/template/.factory/skills/session-continuity/SKILL.md +6 -6
- package/template/.factory/skills/session-continuity/protocols/01-session-resumption.md +1 -1
- package/template/.factory/skills/session-continuity/protocols/02-progress-generation.md +3 -3
- package/template/.factory/skills/session-continuity/protocols/03-progress-update.md +4 -4
- package/template/.factory/skills/session-continuity/protocols/07-spec-pipeline-generation.md +1 -1
- package/template/.factory/skills/session-continuity/protocols/08-spec-pipeline-update.md +2 -2
- package/template/.factory/skills/session-continuity/protocols/11-parallel-synthesis.md +1 -1
- package/template/.factory/skills/setup-cfsa/SKILL.md +1 -1
- package/template/.factory/skills/write-architecture-spec/SKILL.md +2 -2
- package/template/.factory/skills/write-architecture-spec-deepen/SKILL.md +1 -1
- package/template/.factory/skills/write-architecture-spec-design/SKILL.md +1 -1
- package/template/.factory/skills/write-be-spec/SKILL.md +3 -3
- package/template/.factory/skills/write-be-spec-classify/SKILL.md +1 -1
- package/template/.factory/skills/write-be-spec-write/SKILL.md +1 -1
- package/template/.factory/skills/write-fe-spec/SKILL.md +3 -3
- package/template/.factory/skills/write-fe-spec-write/SKILL.md +1 -1
- package/template/.memory/README.md +1 -0
- package/template/.memory/mcp-server/README.md +10 -2
- package/template/.memory/mcp-server/client.mjs +61 -18
- package/template/.memory/mcp-server/daemon.mjs +8 -3
- package/template/.memory/mcp-server/runtime.mjs +51 -14
- package/template/.memory/mcp-server/start.mjs +4 -2
- package/template/.memory/migrate/migrate-legacy.mjs +1 -0
- package/template/.memory/pipeline/README.md +1 -0
- package/template/CLAUDE.md +4 -4
- package/template/CODEX.md +6 -53
- package/template/GEMINI.md +2 -2
- package/template/docs/README.md +5 -2
- package/template/docs/kit-architecture.md +36 -19
- package/template/docs/progress-state-catalog.md +48 -0
- package/template/.factory/progress/memory/.gitkeep +0 -0
- /package/template/{.agent/progress → .codex/skills/skill-creator/references}/.gitkeep +0 -0
- /package/template/{.agent/progress/memory → .codex/skills/skill-creator/scripts}/.gitkeep +0 -0
- /package/template/{.agent/progress/sessions → .memory/pipeline/progress}/.gitkeep +0 -0
- /package/template/{.claude/progress → .memory/pipeline/progress/memory}/.gitkeep +0 -0
- /package/template/{.claude/progress/memory → .memory/pipeline/progress/phases}/.gitkeep +0 -0
- /package/template/{.claude → .memory/pipeline}/progress/sessions/.gitkeep +0 -0
- /package/template/{.factory/progress → .memory/pipeline/progress/slices}/.gitkeep +0 -0
|
@@ -0,0 +1,476 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: Plugin Structure
|
|
3
|
+
description: This skill should be used when the user asks to "create a plugin", "scaffold a plugin", "understand plugin structure", "organize plugin components", "set up plugin.json", "use ${CLAUDE_PLUGIN_ROOT}", "add commands/agents/skills/hooks", "configure auto-discovery", or needs guidance on plugin directory layout, manifest configuration, component organization, file naming conventions, or Claude Code plugin architecture best practices.
|
|
4
|
+
version: 0.1.0
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# Plugin Structure for Claude Code
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Claude Code plugins follow a standardized directory structure with automatic component discovery. Understanding this structure enables creating well-organized, maintainable plugins that integrate seamlessly with Claude Code.
|
|
12
|
+
|
|
13
|
+
**Key concepts:**
|
|
14
|
+
- Conventional directory layout for automatic discovery
|
|
15
|
+
- Manifest-driven configuration in `.claude-plugin/plugin.json`
|
|
16
|
+
- Component-based organization (commands, agents, skills, hooks)
|
|
17
|
+
- Portable path references using `${CLAUDE_PLUGIN_ROOT}`
|
|
18
|
+
- Explicit vs. auto-discovered component loading
|
|
19
|
+
|
|
20
|
+
## Directory Structure
|
|
21
|
+
|
|
22
|
+
Every Claude Code plugin follows this organizational pattern:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
plugin-name/
|
|
26
|
+
├── .claude-plugin/
|
|
27
|
+
│ └── plugin.json # Required: Plugin manifest
|
|
28
|
+
├── commands/ # Slash commands (.md files)
|
|
29
|
+
├── agents/ # Subagent definitions (.md files)
|
|
30
|
+
├── skills/ # Agent skills (subdirectories)
|
|
31
|
+
│ └── skill-name/
|
|
32
|
+
│ └── SKILL.md # Required for each skill
|
|
33
|
+
├── hooks/
|
|
34
|
+
│ └── hooks.json # Event handler configuration
|
|
35
|
+
├── .mcp.json # MCP server definitions
|
|
36
|
+
└── scripts/ # Helper scripts and utilities
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
**Critical rules:**
|
|
40
|
+
|
|
41
|
+
1. **Manifest location**: The `plugin.json` manifest MUST be in `.claude-plugin/` directory
|
|
42
|
+
2. **Component locations**: All component directories (commands, agents, skills, hooks) MUST be at plugin root level, NOT nested inside `.claude-plugin/`
|
|
43
|
+
3. **Optional components**: Only create directories for components the plugin actually uses
|
|
44
|
+
4. **Naming convention**: Use kebab-case for all directory and file names
|
|
45
|
+
|
|
46
|
+
## Plugin Manifest (plugin.json)
|
|
47
|
+
|
|
48
|
+
The manifest defines plugin metadata and configuration. Located at `.claude-plugin/plugin.json`:
|
|
49
|
+
|
|
50
|
+
### Required Fields
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"name": "plugin-name"
|
|
55
|
+
}
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
**Name requirements:**
|
|
59
|
+
- Use kebab-case format (lowercase with hyphens)
|
|
60
|
+
- Must be unique across installed plugins
|
|
61
|
+
- No spaces or special characters
|
|
62
|
+
- Example: `code-review-assistant`, `test-runner`, `api-docs`
|
|
63
|
+
|
|
64
|
+
### Recommended Metadata
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"name": "plugin-name",
|
|
69
|
+
"version": "1.0.0",
|
|
70
|
+
"description": "Brief explanation of plugin purpose",
|
|
71
|
+
"author": {
|
|
72
|
+
"name": "Author Name",
|
|
73
|
+
"email": "author@example.com",
|
|
74
|
+
"url": "https://example.com"
|
|
75
|
+
},
|
|
76
|
+
"homepage": "https://docs.example.com",
|
|
77
|
+
"repository": "https://github.com/user/plugin-name",
|
|
78
|
+
"license": "MIT",
|
|
79
|
+
"keywords": ["testing", "automation", "ci-cd"]
|
|
80
|
+
}
|
|
81
|
+
```
|
|
82
|
+
|
|
83
|
+
**Version format**: Follow semantic versioning (MAJOR.MINOR.PATCH)
|
|
84
|
+
**Keywords**: Use for plugin discovery and categorization
|
|
85
|
+
|
|
86
|
+
### Component Path Configuration
|
|
87
|
+
|
|
88
|
+
Specify custom paths for components (supplements default directories):
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"name": "plugin-name",
|
|
93
|
+
"commands": "./custom-commands",
|
|
94
|
+
"agents": ["./agents", "./specialized-agents"],
|
|
95
|
+
"hooks": "./config/hooks.json",
|
|
96
|
+
"mcpServers": "./.mcp.json"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
**Important**: Custom paths supplement defaults—they don't replace them. Components in both default directories and custom paths will load.
|
|
101
|
+
|
|
102
|
+
**Path rules:**
|
|
103
|
+
- Must be relative to plugin root
|
|
104
|
+
- Must start with `./`
|
|
105
|
+
- Cannot use absolute paths
|
|
106
|
+
- Support arrays for multiple locations
|
|
107
|
+
|
|
108
|
+
## Component Organization
|
|
109
|
+
|
|
110
|
+
### Commands
|
|
111
|
+
|
|
112
|
+
**Location**: `commands/` directory
|
|
113
|
+
**Format**: Markdown files with YAML frontmatter
|
|
114
|
+
**Auto-discovery**: All `.md` files in `commands/` load automatically
|
|
115
|
+
|
|
116
|
+
**Example structure**:
|
|
117
|
+
```
|
|
118
|
+
commands/
|
|
119
|
+
├── review.md # /review command
|
|
120
|
+
├── test.md # /test command
|
|
121
|
+
└── deploy.md # /deploy command
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
**File format**:
|
|
125
|
+
```markdown
|
|
126
|
+
---
|
|
127
|
+
name: command-name
|
|
128
|
+
description: Command description
|
|
129
|
+
---
|
|
130
|
+
|
|
131
|
+
Command implementation instructions...
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
**Usage**: Commands integrate as native slash commands in Claude Code
|
|
135
|
+
|
|
136
|
+
### Agents
|
|
137
|
+
|
|
138
|
+
**Location**: `agents/` directory
|
|
139
|
+
**Format**: Markdown files with YAML frontmatter
|
|
140
|
+
**Auto-discovery**: All `.md` files in `agents/` load automatically
|
|
141
|
+
|
|
142
|
+
**Example structure**:
|
|
143
|
+
```
|
|
144
|
+
agents/
|
|
145
|
+
├── code-reviewer.md
|
|
146
|
+
├── test-generator.md
|
|
147
|
+
└── refactorer.md
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
**File format**:
|
|
151
|
+
```markdown
|
|
152
|
+
---
|
|
153
|
+
description: Agent role and expertise
|
|
154
|
+
capabilities:
|
|
155
|
+
- Specific task 1
|
|
156
|
+
- Specific task 2
|
|
157
|
+
---
|
|
158
|
+
|
|
159
|
+
Detailed agent instructions and knowledge...
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
**Usage**: Users can invoke agents manually, or Claude Code selects them automatically based on task context
|
|
163
|
+
|
|
164
|
+
### Skills
|
|
165
|
+
|
|
166
|
+
**Location**: `skills/` directory with subdirectories per skill
|
|
167
|
+
**Format**: Each skill in its own directory with `SKILL.md` file
|
|
168
|
+
**Auto-discovery**: All `SKILL.md` files in skill subdirectories load automatically
|
|
169
|
+
|
|
170
|
+
**Example structure**:
|
|
171
|
+
```
|
|
172
|
+
skills/
|
|
173
|
+
├── api-testing/
|
|
174
|
+
│ ├── SKILL.md
|
|
175
|
+
│ ├── scripts/
|
|
176
|
+
│ │ └── test-runner.py
|
|
177
|
+
│ └── references/
|
|
178
|
+
│ └── api-spec.md
|
|
179
|
+
└── database-migrations/
|
|
180
|
+
├── SKILL.md
|
|
181
|
+
└── examples/
|
|
182
|
+
└── migration-template.sql
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
**SKILL.md format**:
|
|
186
|
+
```markdown
|
|
187
|
+
---
|
|
188
|
+
name: Skill Name
|
|
189
|
+
description: When to use this skill
|
|
190
|
+
version: 1.0.0
|
|
191
|
+
---
|
|
192
|
+
|
|
193
|
+
Skill instructions and guidance...
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
**Supporting files**: Skills can include scripts, references, examples, or assets in subdirectories
|
|
197
|
+
|
|
198
|
+
**Usage**: Claude Code autonomously activates skills based on task context matching the description
|
|
199
|
+
|
|
200
|
+
### Hooks
|
|
201
|
+
|
|
202
|
+
**Location**: `hooks/hooks.json` or inline in `plugin.json`
|
|
203
|
+
**Format**: JSON configuration defining event handlers
|
|
204
|
+
**Registration**: Hooks register automatically when plugin enables
|
|
205
|
+
|
|
206
|
+
**Example structure**:
|
|
207
|
+
```
|
|
208
|
+
hooks/
|
|
209
|
+
├── hooks.json # Hook configuration
|
|
210
|
+
└── scripts/
|
|
211
|
+
├── validate.sh # Hook script
|
|
212
|
+
└── check-style.sh # Hook script
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
**Configuration format**:
|
|
216
|
+
```json
|
|
217
|
+
{
|
|
218
|
+
"PreToolUse": [{
|
|
219
|
+
"matcher": "Write|Edit",
|
|
220
|
+
"hooks": [{
|
|
221
|
+
"type": "command",
|
|
222
|
+
"command": "bash ${CLAUDE_PLUGIN_ROOT}/hooks/scripts/validate.sh",
|
|
223
|
+
"timeout": 30
|
|
224
|
+
}]
|
|
225
|
+
}]
|
|
226
|
+
}
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
**Available events**: PreToolUse, PostToolUse, Stop, SubagentStop, SessionStart, SessionEnd, UserPromptSubmit, PreCompact, Notification
|
|
230
|
+
|
|
231
|
+
**Usage**: Hooks execute automatically in response to Claude Code events
|
|
232
|
+
|
|
233
|
+
### MCP Servers
|
|
234
|
+
|
|
235
|
+
**Location**: `.mcp.json` at plugin root or inline in `plugin.json`
|
|
236
|
+
**Format**: JSON configuration for MCP server definitions
|
|
237
|
+
**Auto-start**: Servers start automatically when plugin enables
|
|
238
|
+
|
|
239
|
+
**Example format**:
|
|
240
|
+
```json
|
|
241
|
+
{
|
|
242
|
+
"mcpServers": {
|
|
243
|
+
"server-name": {
|
|
244
|
+
"command": "node",
|
|
245
|
+
"args": ["${CLAUDE_PLUGIN_ROOT}/servers/server.js"],
|
|
246
|
+
"env": {
|
|
247
|
+
"API_KEY": "${API_KEY}"
|
|
248
|
+
}
|
|
249
|
+
}
|
|
250
|
+
}
|
|
251
|
+
}
|
|
252
|
+
```
|
|
253
|
+
|
|
254
|
+
**Usage**: MCP servers integrate seamlessly with Claude Code's tool system
|
|
255
|
+
|
|
256
|
+
## Portable Path References
|
|
257
|
+
|
|
258
|
+
### ${CLAUDE_PLUGIN_ROOT}
|
|
259
|
+
|
|
260
|
+
Use `${CLAUDE_PLUGIN_ROOT}` environment variable for all intra-plugin path references:
|
|
261
|
+
|
|
262
|
+
```json
|
|
263
|
+
{
|
|
264
|
+
"command": "bash ${CLAUDE_PLUGIN_ROOT}/scripts/run.sh"
|
|
265
|
+
}
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
**Why it matters**: Plugins install in different locations depending on:
|
|
269
|
+
- User installation method (marketplace, local, npm)
|
|
270
|
+
- Operating system conventions
|
|
271
|
+
- User preferences
|
|
272
|
+
|
|
273
|
+
**Where to use it**:
|
|
274
|
+
- Hook command paths
|
|
275
|
+
- MCP server command arguments
|
|
276
|
+
- Script execution references
|
|
277
|
+
- Resource file paths
|
|
278
|
+
|
|
279
|
+
**Never use**:
|
|
280
|
+
- Hardcoded absolute paths (`/Users/name/plugins/...`)
|
|
281
|
+
- Relative paths from working directory (`./scripts/...` in commands)
|
|
282
|
+
- Home directory shortcuts (`~/plugins/...`)
|
|
283
|
+
|
|
284
|
+
### Path Resolution Rules
|
|
285
|
+
|
|
286
|
+
**In manifest JSON fields** (hooks, MCP servers):
|
|
287
|
+
```json
|
|
288
|
+
"command": "${CLAUDE_PLUGIN_ROOT}/scripts/tool.sh"
|
|
289
|
+
```
|
|
290
|
+
|
|
291
|
+
**In component files** (commands, agents, skills):
|
|
292
|
+
```markdown
|
|
293
|
+
Reference scripts at: ${CLAUDE_PLUGIN_ROOT}/scripts/helper.py
|
|
294
|
+
```
|
|
295
|
+
|
|
296
|
+
**In executed scripts**:
|
|
297
|
+
```bash
|
|
298
|
+
#!/bin/bash
|
|
299
|
+
# ${CLAUDE_PLUGIN_ROOT} available as environment variable
|
|
300
|
+
source "${CLAUDE_PLUGIN_ROOT}/lib/common.sh"
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
## File Naming Conventions
|
|
304
|
+
|
|
305
|
+
### Component Files
|
|
306
|
+
|
|
307
|
+
**Commands**: Use kebab-case `.md` files
|
|
308
|
+
- `code-review.md` → `/code-review`
|
|
309
|
+
- `run-tests.md` → `/run-tests`
|
|
310
|
+
- `api-docs.md` → `/api-docs`
|
|
311
|
+
|
|
312
|
+
**Agents**: Use kebab-case `.md` files describing role
|
|
313
|
+
- `test-generator.md`
|
|
314
|
+
- `code-reviewer.md`
|
|
315
|
+
- `performance-analyzer.md`
|
|
316
|
+
|
|
317
|
+
**Skills**: Use kebab-case directory names
|
|
318
|
+
- `api-testing/`
|
|
319
|
+
- `database-migrations/`
|
|
320
|
+
- `error-handling/`
|
|
321
|
+
|
|
322
|
+
### Supporting Files
|
|
323
|
+
|
|
324
|
+
**Scripts**: Use descriptive kebab-case names with appropriate extensions
|
|
325
|
+
- `validate-input.sh`
|
|
326
|
+
- `generate-report.py`
|
|
327
|
+
- `process-data.js`
|
|
328
|
+
|
|
329
|
+
**Documentation**: Use kebab-case markdown files
|
|
330
|
+
- `api-reference.md`
|
|
331
|
+
- `migration-guide.md`
|
|
332
|
+
- `best-practices.md`
|
|
333
|
+
|
|
334
|
+
**Configuration**: Use standard names
|
|
335
|
+
- `hooks.json`
|
|
336
|
+
- `.mcp.json`
|
|
337
|
+
- `plugin.json`
|
|
338
|
+
|
|
339
|
+
## Auto-Discovery Mechanism
|
|
340
|
+
|
|
341
|
+
Claude Code automatically discovers and loads components:
|
|
342
|
+
|
|
343
|
+
1. **Plugin manifest**: Reads `.claude-plugin/plugin.json` when plugin enables
|
|
344
|
+
2. **Commands**: Scans `commands/` directory for `.md` files
|
|
345
|
+
3. **Agents**: Scans `agents/` directory for `.md` files
|
|
346
|
+
4. **Skills**: Scans `skills/` for subdirectories containing `SKILL.md`
|
|
347
|
+
5. **Hooks**: Loads configuration from `hooks/hooks.json` or manifest
|
|
348
|
+
6. **MCP servers**: Loads configuration from `.mcp.json` or manifest
|
|
349
|
+
|
|
350
|
+
**Discovery timing**:
|
|
351
|
+
- Plugin installation: Components register with Claude Code
|
|
352
|
+
- Plugin enable: Components become available for use
|
|
353
|
+
- No restart required: Changes take effect on next Claude Code session
|
|
354
|
+
|
|
355
|
+
**Override behavior**: Custom paths in `plugin.json` supplement (not replace) default directories
|
|
356
|
+
|
|
357
|
+
## Best Practices
|
|
358
|
+
|
|
359
|
+
### Organization
|
|
360
|
+
|
|
361
|
+
1. **Logical grouping**: Group related components together
|
|
362
|
+
- Put test-related commands, agents, and skills together
|
|
363
|
+
- Create subdirectories in `scripts/` for different purposes
|
|
364
|
+
|
|
365
|
+
2. **Minimal manifest**: Keep `plugin.json` lean
|
|
366
|
+
- Only specify custom paths when necessary
|
|
367
|
+
- Rely on auto-discovery for standard layouts
|
|
368
|
+
- Use inline configuration only for simple cases
|
|
369
|
+
|
|
370
|
+
3. **Documentation**: Include README files
|
|
371
|
+
- Plugin root: Overall purpose and usage
|
|
372
|
+
- Component directories: Specific guidance
|
|
373
|
+
- Script directories: Usage and requirements
|
|
374
|
+
|
|
375
|
+
### Naming
|
|
376
|
+
|
|
377
|
+
1. **Consistency**: Use consistent naming across components
|
|
378
|
+
- If command is `test-runner`, name related agent `test-runner-agent`
|
|
379
|
+
- Match skill directory names to their purpose
|
|
380
|
+
|
|
381
|
+
2. **Clarity**: Use descriptive names that indicate purpose
|
|
382
|
+
- Good: `api-integration-testing/`, `code-quality-checker.md`
|
|
383
|
+
- Avoid: `utils/`, `misc.md`, `temp.sh`
|
|
384
|
+
|
|
385
|
+
3. **Length**: Balance brevity with clarity
|
|
386
|
+
- Commands: 2-3 words (`review-pr`, `run-ci`)
|
|
387
|
+
- Agents: Describe role clearly (`code-reviewer`, `test-generator`)
|
|
388
|
+
- Skills: Topic-focused (`error-handling`, `api-design`)
|
|
389
|
+
|
|
390
|
+
### Portability
|
|
391
|
+
|
|
392
|
+
1. **Always use ${CLAUDE_PLUGIN_ROOT}**: Never hardcode paths
|
|
393
|
+
2. **Test on multiple systems**: Verify on macOS, Linux, Windows
|
|
394
|
+
3. **Document dependencies**: List required tools and versions
|
|
395
|
+
4. **Avoid system-specific features**: Use portable bash/Python constructs
|
|
396
|
+
|
|
397
|
+
### Maintenance
|
|
398
|
+
|
|
399
|
+
1. **Version consistently**: Update version in plugin.json for releases
|
|
400
|
+
2. **Deprecate gracefully**: Mark old components clearly before removal
|
|
401
|
+
3. **Document breaking changes**: Note changes affecting existing users
|
|
402
|
+
4. **Test thoroughly**: Verify all components work after changes
|
|
403
|
+
|
|
404
|
+
## Common Patterns
|
|
405
|
+
|
|
406
|
+
### Minimal Plugin
|
|
407
|
+
|
|
408
|
+
Single command with no dependencies:
|
|
409
|
+
```
|
|
410
|
+
my-plugin/
|
|
411
|
+
├── .claude-plugin/
|
|
412
|
+
│ └── plugin.json # Just name field
|
|
413
|
+
└── commands/
|
|
414
|
+
└── hello.md # Single command
|
|
415
|
+
```
|
|
416
|
+
|
|
417
|
+
### Full-Featured Plugin
|
|
418
|
+
|
|
419
|
+
Complete plugin with all component types:
|
|
420
|
+
```
|
|
421
|
+
my-plugin/
|
|
422
|
+
├── .claude-plugin/
|
|
423
|
+
│ └── plugin.json
|
|
424
|
+
├── commands/ # User-facing commands
|
|
425
|
+
├── agents/ # Specialized subagents
|
|
426
|
+
├── skills/ # Auto-activating skills
|
|
427
|
+
├── hooks/ # Event handlers
|
|
428
|
+
│ ├── hooks.json
|
|
429
|
+
│ └── scripts/
|
|
430
|
+
├── .mcp.json # External integrations
|
|
431
|
+
└── scripts/ # Shared utilities
|
|
432
|
+
```
|
|
433
|
+
|
|
434
|
+
### Skill-Focused Plugin
|
|
435
|
+
|
|
436
|
+
Plugin providing only skills:
|
|
437
|
+
```
|
|
438
|
+
my-plugin/
|
|
439
|
+
├── .claude-plugin/
|
|
440
|
+
│ └── plugin.json
|
|
441
|
+
└── skills/
|
|
442
|
+
├── skill-one/
|
|
443
|
+
│ └── SKILL.md
|
|
444
|
+
└── skill-two/
|
|
445
|
+
└── SKILL.md
|
|
446
|
+
```
|
|
447
|
+
|
|
448
|
+
## Troubleshooting
|
|
449
|
+
|
|
450
|
+
**Component not loading**:
|
|
451
|
+
- Verify file is in correct directory with correct extension
|
|
452
|
+
- Check YAML frontmatter syntax (commands, agents, skills)
|
|
453
|
+
- Ensure skill has `SKILL.md` (not `README.md` or other name)
|
|
454
|
+
- Confirm plugin is enabled in Claude Code settings
|
|
455
|
+
|
|
456
|
+
**Path resolution errors**:
|
|
457
|
+
- Replace all hardcoded paths with `${CLAUDE_PLUGIN_ROOT}`
|
|
458
|
+
- Verify paths are relative and start with `./` in manifest
|
|
459
|
+
- Check that referenced files exist at specified paths
|
|
460
|
+
- Test with `echo $CLAUDE_PLUGIN_ROOT` in hook scripts
|
|
461
|
+
|
|
462
|
+
**Auto-discovery not working**:
|
|
463
|
+
- Confirm directories are at plugin root (not in `.claude-plugin/`)
|
|
464
|
+
- Check file naming follows conventions (kebab-case, correct extensions)
|
|
465
|
+
- Verify custom paths in manifest are correct
|
|
466
|
+
- Restart Claude Code to reload plugin configuration
|
|
467
|
+
|
|
468
|
+
**Conflicts between plugins**:
|
|
469
|
+
- Use unique, descriptive component names
|
|
470
|
+
- Namespace commands with plugin name if needed
|
|
471
|
+
- Document potential conflicts in plugin README
|
|
472
|
+
- Consider command prefixes for related functionality
|
|
473
|
+
|
|
474
|
+
---
|
|
475
|
+
|
|
476
|
+
For detailed examples and advanced patterns, see files in `references/` and `examples/` directories.
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: mcp-builder
|
|
3
|
+
description: Guide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).
|
|
4
|
+
license: Complete terms in LICENSE.txt
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
# MCP Server Development Guide
|
|
8
|
+
|
|
9
|
+
## Overview
|
|
10
|
+
|
|
11
|
+
Create MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. The quality of an MCP server is measured by how well it enables LLMs to accomplish real-world tasks.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
# Process
|
|
16
|
+
|
|
17
|
+
## 🚀 High-Level Workflow
|
|
18
|
+
|
|
19
|
+
Creating a high-quality MCP server involves four main phases:
|
|
20
|
+
|
|
21
|
+
### Phase 1: Deep Research and Planning
|
|
22
|
+
|
|
23
|
+
#### 1.1 Understand Modern MCP Design
|
|
24
|
+
|
|
25
|
+
**API Coverage vs. Workflow Tools:**
|
|
26
|
+
Balance comprehensive API endpoint coverage with specialized workflow tools. Workflow tools can be more convenient for specific tasks, while comprehensive coverage gives agents flexibility to compose operations. Performance varies by client—some clients benefit from code execution that combines basic tools, while others work better with higher-level workflows. When uncertain, prioritize comprehensive API coverage.
|
|
27
|
+
|
|
28
|
+
**Tool Naming and Discoverability:**
|
|
29
|
+
Clear, descriptive tool names help agents find the right tools quickly. Use consistent prefixes (e.g., `github_create_issue`, `github_list_repos`) and action-oriented naming.
|
|
30
|
+
|
|
31
|
+
**Context Management:**
|
|
32
|
+
Agents benefit from concise tool descriptions and the ability to filter/paginate results. Design tools that return focused, relevant data. Some clients support code execution which can help agents filter and process data efficiently.
|
|
33
|
+
|
|
34
|
+
**Actionable Error Messages:**
|
|
35
|
+
Error messages should guide agents toward solutions with specific suggestions and next steps.
|
|
36
|
+
|
|
37
|
+
#### 1.2 Study MCP Protocol Documentation
|
|
38
|
+
|
|
39
|
+
**Navigate the MCP specification:**
|
|
40
|
+
|
|
41
|
+
Start with the sitemap to find relevant pages: `https://modelcontextprotocol.io/sitemap.xml`
|
|
42
|
+
|
|
43
|
+
Then fetch specific pages with `.md` suffix for markdown format (e.g., `https://modelcontextprotocol.io/specification/draft.md`).
|
|
44
|
+
|
|
45
|
+
Key pages to review:
|
|
46
|
+
- Specification overview and architecture
|
|
47
|
+
- Transport mechanisms (streamable HTTP, stdio)
|
|
48
|
+
- Tool, resource, and prompt definitions
|
|
49
|
+
|
|
50
|
+
#### 1.3 Study Framework Documentation
|
|
51
|
+
|
|
52
|
+
**Recommended stack:**
|
|
53
|
+
- **Language**: TypeScript (high-quality SDK support and good compatibility in many execution environments e.g. MCPB. Plus AI models are good at generating TypeScript code, benefiting from its broad usage, static typing and good linting tools)
|
|
54
|
+
- **Transport**: Streamable HTTP for remote servers, using stateless JSON (simpler to scale and maintain, as opposed to stateful sessions and streaming responses). stdio for local servers.
|
|
55
|
+
|
|
56
|
+
**Load framework documentation:**
|
|
57
|
+
|
|
58
|
+
- **MCP Best Practices**: [📋 View Best Practices](./reference/mcp_best_practices.md) - Core guidelines
|
|
59
|
+
|
|
60
|
+
**For TypeScript (recommended):**
|
|
61
|
+
- **TypeScript SDK**: Use WebFetch to load `https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md`
|
|
62
|
+
- [⚡ TypeScript Guide](./reference/node_mcp_server.md) - TypeScript patterns and examples
|
|
63
|
+
|
|
64
|
+
**For Python:**
|
|
65
|
+
- **Python SDK**: Use WebFetch to load `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
|
|
66
|
+
- [🐍 Python Guide](./reference/python_mcp_server.md) - Python patterns and examples
|
|
67
|
+
|
|
68
|
+
#### 1.4 Plan Your Implementation
|
|
69
|
+
|
|
70
|
+
**Understand the API:**
|
|
71
|
+
Review the service's API documentation to identify key endpoints, authentication requirements, and data models. Use web search and WebFetch as needed.
|
|
72
|
+
|
|
73
|
+
**Tool Selection:**
|
|
74
|
+
Prioritize comprehensive API coverage. List endpoints to implement, starting with the most common operations.
|
|
75
|
+
|
|
76
|
+
---
|
|
77
|
+
|
|
78
|
+
### Phase 2: Implementation
|
|
79
|
+
|
|
80
|
+
#### 2.1 Set Up Project Structure
|
|
81
|
+
|
|
82
|
+
See language-specific guides for project setup:
|
|
83
|
+
- [⚡ TypeScript Guide](./reference/node_mcp_server.md) - Project structure, package.json, tsconfig.json
|
|
84
|
+
- [🐍 Python Guide](./reference/python_mcp_server.md) - Module organization, dependencies
|
|
85
|
+
|
|
86
|
+
#### 2.2 Implement Core Infrastructure
|
|
87
|
+
|
|
88
|
+
Create shared utilities:
|
|
89
|
+
- API client with authentication
|
|
90
|
+
- Error handling helpers
|
|
91
|
+
- Response formatting (JSON/Markdown)
|
|
92
|
+
- Pagination support
|
|
93
|
+
|
|
94
|
+
#### 2.3 Implement Tools
|
|
95
|
+
|
|
96
|
+
For each tool:
|
|
97
|
+
|
|
98
|
+
**Input Schema:**
|
|
99
|
+
- Use Zod (TypeScript) or Pydantic (Python)
|
|
100
|
+
- Include constraints and clear descriptions
|
|
101
|
+
- Add examples in field descriptions
|
|
102
|
+
|
|
103
|
+
**Output Schema:**
|
|
104
|
+
- Define `outputSchema` where possible for structured data
|
|
105
|
+
- Use `structuredContent` in tool responses (TypeScript SDK feature)
|
|
106
|
+
- Helps clients understand and process tool outputs
|
|
107
|
+
|
|
108
|
+
**Tool Description:**
|
|
109
|
+
- Concise summary of functionality
|
|
110
|
+
- Parameter descriptions
|
|
111
|
+
- Return type schema
|
|
112
|
+
|
|
113
|
+
**Implementation:**
|
|
114
|
+
- Async/await for I/O operations
|
|
115
|
+
- Proper error handling with actionable messages
|
|
116
|
+
- Support pagination where applicable
|
|
117
|
+
- Return both text content and structured data when using modern SDKs
|
|
118
|
+
|
|
119
|
+
**Annotations:**
|
|
120
|
+
- `readOnlyHint`: true/false
|
|
121
|
+
- `destructiveHint`: true/false
|
|
122
|
+
- `idempotentHint`: true/false
|
|
123
|
+
- `openWorldHint`: true/false
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
### Phase 3: Review and Test
|
|
128
|
+
|
|
129
|
+
#### 3.1 Code Quality
|
|
130
|
+
|
|
131
|
+
Review for:
|
|
132
|
+
- No duplicated code (DRY principle)
|
|
133
|
+
- Consistent error handling
|
|
134
|
+
- Full type coverage
|
|
135
|
+
- Clear tool descriptions
|
|
136
|
+
|
|
137
|
+
#### 3.2 Build and Test
|
|
138
|
+
|
|
139
|
+
**TypeScript:**
|
|
140
|
+
- Run `npm run build` to verify compilation
|
|
141
|
+
- Test with MCP Inspector: `npx @modelcontextprotocol/inspector`
|
|
142
|
+
|
|
143
|
+
**Python:**
|
|
144
|
+
- Verify syntax: `python -m py_compile your_server.py`
|
|
145
|
+
- Test with MCP Inspector
|
|
146
|
+
|
|
147
|
+
See language-specific guides for detailed testing approaches and quality checklists.
|
|
148
|
+
|
|
149
|
+
---
|
|
150
|
+
|
|
151
|
+
### Phase 4: Create Evaluations
|
|
152
|
+
|
|
153
|
+
After implementing your MCP server, create comprehensive evaluations to test its effectiveness.
|
|
154
|
+
|
|
155
|
+
**Load [✅ Evaluation Guide](./reference/evaluation.md) for complete evaluation guidelines.**
|
|
156
|
+
|
|
157
|
+
#### 4.1 Understand Evaluation Purpose
|
|
158
|
+
|
|
159
|
+
Use evaluations to test whether LLMs can effectively use your MCP server to answer realistic, complex questions.
|
|
160
|
+
|
|
161
|
+
#### 4.2 Create 10 Evaluation Questions
|
|
162
|
+
|
|
163
|
+
To create effective evaluations, follow the process outlined in the evaluation guide:
|
|
164
|
+
|
|
165
|
+
1. **Tool Inspection**: List available tools and understand their capabilities
|
|
166
|
+
2. **Content Exploration**: Use READ-ONLY operations to explore available data
|
|
167
|
+
3. **Question Generation**: Create 10 complex, realistic questions
|
|
168
|
+
4. **Answer Verification**: Solve each question yourself to verify answers
|
|
169
|
+
|
|
170
|
+
#### 4.3 Evaluation Requirements
|
|
171
|
+
|
|
172
|
+
Ensure each question is:
|
|
173
|
+
- **Independent**: Not dependent on other questions
|
|
174
|
+
- **Read-only**: Only non-destructive operations required
|
|
175
|
+
- **Complex**: Requiring multiple tool calls and deep exploration
|
|
176
|
+
- **Realistic**: Based on real use cases humans would care about
|
|
177
|
+
- **Verifiable**: Single, clear answer that can be verified by string comparison
|
|
178
|
+
- **Stable**: Answer won't change over time
|
|
179
|
+
|
|
180
|
+
#### 4.4 Output Format
|
|
181
|
+
|
|
182
|
+
Create an XML file with this structure:
|
|
183
|
+
|
|
184
|
+
```xml
|
|
185
|
+
<evaluation>
|
|
186
|
+
<qa_pair>
|
|
187
|
+
<question>Find discussions about AI model launches with animal codenames. One model needed a specific safety designation that uses the format ASL-X. What number X was being determined for the model named after a spotted wild cat?</question>
|
|
188
|
+
<answer>3</answer>
|
|
189
|
+
</qa_pair>
|
|
190
|
+
<!-- More qa_pairs... -->
|
|
191
|
+
</evaluation>
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
# Reference Files
|
|
197
|
+
|
|
198
|
+
## 📚 Documentation Library
|
|
199
|
+
|
|
200
|
+
Load these resources as needed during development:
|
|
201
|
+
|
|
202
|
+
### Core MCP Documentation (Load First)
|
|
203
|
+
- **MCP Protocol**: Start with sitemap at `https://modelcontextprotocol.io/sitemap.xml`, then fetch specific pages with `.md` suffix
|
|
204
|
+
- [📋 MCP Best Practices](./reference/mcp_best_practices.md) - Universal MCP guidelines including:
|
|
205
|
+
- Server and tool naming conventions
|
|
206
|
+
- Response format guidelines (JSON vs Markdown)
|
|
207
|
+
- Pagination best practices
|
|
208
|
+
- Transport selection (streamable HTTP vs stdio)
|
|
209
|
+
- Security and error handling standards
|
|
210
|
+
|
|
211
|
+
### SDK Documentation (Load During Phase 1/2)
|
|
212
|
+
- **Python SDK**: Fetch from `https://raw.githubusercontent.com/modelcontextprotocol/python-sdk/main/README.md`
|
|
213
|
+
- **TypeScript SDK**: Fetch from `https://raw.githubusercontent.com/modelcontextprotocol/typescript-sdk/main/README.md`
|
|
214
|
+
|
|
215
|
+
### Language-Specific Implementation Guides (Load During Phase 2)
|
|
216
|
+
- [🐍 Python Implementation Guide](./reference/python_mcp_server.md) - Complete Python/FastMCP guide with:
|
|
217
|
+
- Server initialization patterns
|
|
218
|
+
- Pydantic model examples
|
|
219
|
+
- Tool registration with `@mcp.tool`
|
|
220
|
+
- Complete working examples
|
|
221
|
+
- Quality checklist
|
|
222
|
+
|
|
223
|
+
- [⚡ TypeScript Implementation Guide](./reference/node_mcp_server.md) - Complete TypeScript guide with:
|
|
224
|
+
- Project structure
|
|
225
|
+
- Zod schema patterns
|
|
226
|
+
- Tool registration with `server.registerTool`
|
|
227
|
+
- Complete working examples
|
|
228
|
+
- Quality checklist
|
|
229
|
+
|
|
230
|
+
### Evaluation Guide (Load During Phase 4)
|
|
231
|
+
- [✅ Evaluation Guide](./reference/evaluation.md) - Complete evaluation creation guide with:
|
|
232
|
+
- Question creation guidelines
|
|
233
|
+
- Answer verification strategies
|
|
234
|
+
- XML format specifications
|
|
235
|
+
- Example questions and answers
|
|
236
|
+
- Running an evaluation with the provided scripts
|