sfcc-dev-mcp 1.0.15 → 1.0.19
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/.github/ISSUE_TEMPLATE/bug_report.yml +3 -1
- package/.github/ISSUE_TEMPLATE/documentation.yml +2 -2
- package/.github/ISSUE_TEMPLATE/question.yml +1 -1
- package/.github/PULL_REQUEST_TEMPLATE/documentation.md +1 -1
- package/.github/PULL_REQUEST_TEMPLATE/new_tool.md +1 -1
- package/.github/agents/official-docs-researcher.agent.md +56 -0
- package/.github/instructions/mcp-node-tests.instructions.md +12 -916
- package/.github/instructions/mcp-yml-tests.instructions.md +14 -742
- package/.github/pull_request_template.md +1 -1
- package/.github/skills/agent-authoring/SKILL.md +66 -0
- package/.github/skills/mcp-log-debugging/SKILL.md +69 -0
- package/.github/skills/mcp-programmatic-testing/SKILL.md +142 -0
- package/.github/skills/mcp-yaml-testing/SKILL.md +136 -0
- package/.github/skills/salesforce-developer-site-scraper/SKILL.md +102 -0
- package/.github/skills/salesforce-developer-site-scraper/scripts/scrape-to-markdown.js +205 -0
- package/.github/skills/salesforce-help-site-scraper/SKILL.md +84 -0
- package/.github/skills/salesforce-help-site-scraper/scripts/scrape-help-to-markdown.js +212 -0
- package/.github/skills/skill-authoring/SKILL.md +228 -0
- package/.github/skills/skill-authoring/references/PATTERNS.md +384 -0
- package/.github/workflows/ci.yml +3 -3
- package/.github/workflows/deploy-pages.yml +9 -19
- package/.github/workflows/publish.yml +5 -2
- package/.github/workflows/update-docs.yml +1 -1
- package/AGENTS.md +140 -286
- package/CONTRIBUTING.md +10 -22
- package/README.md +48 -16
- package/ai-instructions/{github-copilot/copilot-instructions.md → AGENTS.md} +99 -127
- package/ai-instructions/skills/sfcc-caching/SKILL.md +89 -0
- package/{dist/docs/best-practices/cartridge_creation.md → ai-instructions/skills/sfcc-cartridge-development/SKILL.md} +31 -7
- package/ai-instructions/skills/sfcc-forms-development/SKILL.md +261 -0
- package/ai-instructions/skills/sfcc-forms-development/references/ARCHITECTURE-SGJC-SFRA.md +143 -0
- package/ai-instructions/skills/sfcc-forms-development/references/FORM-XML-CHEATSHEET.md +127 -0
- package/ai-instructions/skills/sfcc-fraud-prevention/SKILL.md +95 -0
- package/ai-instructions/skills/sfcc-hooks-registration/SKILL.md +39 -0
- package/ai-instructions/skills/sfcc-isml-development/SKILL.md +370 -0
- package/ai-instructions/skills/sfcc-isml-development/references/REMOTE-INCLUDES.md +116 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-LAYOUTS.md +50 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CART-ACCOUNT-AUTH.md +45 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CATALOG.md +85 -0
- package/ai-instructions/skills/sfcc-isml-development/references/SFRA-STRUCTURE-COMPONENTS.md +63 -0
- package/ai-instructions/skills/sfcc-isml-development/references/UTILITIES-EXPRESSIONS.md +159 -0
- package/ai-instructions/skills/sfcc-isml-development/references/sfra-base-templates-architecture.md +13 -0
- package/ai-instructions/skills/sfcc-job-development/SKILL.md +334 -0
- package/ai-instructions/skills/sfcc-job-development/references/CHUNK-ORIENTED.md +393 -0
- package/ai-instructions/skills/sfcc-job-development/references/STEPTYPES-JSON.md +271 -0
- package/ai-instructions/skills/sfcc-job-development/references/TASK-ORIENTED.md +257 -0
- package/ai-instructions/skills/sfcc-localization/SKILL.md +92 -0
- package/ai-instructions/skills/sfcc-localization/references/CONTROLLERS.md +63 -0
- package/ai-instructions/skills/sfcc-localization/references/FORMATTING.md +29 -0
- package/ai-instructions/skills/sfcc-localization/references/FORMS-LOCALIZATION.md +33 -0
- package/ai-instructions/skills/sfcc-localization/references/JAVASCRIPT-LOCALIZATION.md +41 -0
- package/ai-instructions/skills/sfcc-localization/references/LOCALE-SWITCHING.md +35 -0
- package/ai-instructions/skills/sfcc-localization/references/PATTERNS.md +740 -0
- package/ai-instructions/skills/sfcc-localization/references/PROPERTIES-ENCODING.md +25 -0
- package/ai-instructions/skills/sfcc-localization/references/RESOURCE-BUNDLES.md +67 -0
- package/ai-instructions/skills/sfcc-localization/references/STATIC-FILES.md +23 -0
- package/ai-instructions/skills/sfcc-localization/references/TESTING.md +21 -0
- package/{docs/best-practices/localserviceregistry.md → ai-instructions/skills/sfcc-localserviceregistry/SKILL.md} +65 -31
- package/ai-instructions/skills/sfcc-logging/SKILL.md +352 -0
- package/ai-instructions/skills/sfcc-logging/references/LOG-FILES.md +282 -0
- package/{docs/best-practices/ocapi_hooks.md → ai-instructions/skills/sfcc-ocapi-hooks/SKILL.md} +51 -16
- package/ai-instructions/skills/sfcc-ocapi-scapi-slas/SKILL.md +108 -0
- package/ai-instructions/skills/sfcc-page-designer/SKILL.md +353 -0
- package/ai-instructions/skills/sfcc-page-designer/references/ATTRIBUTE-TYPES.md +436 -0
- package/ai-instructions/skills/sfcc-page-designer/references/META-DEFINITIONS.md +322 -0
- package/{dist/docs/best-practices/performance.md → ai-instructions/skills/sfcc-performance/SKILL.md} +35 -3
- package/ai-instructions/skills/sfcc-platform-limits/SKILL.md +89 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/SKILL.md +237 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/AUTHENTICATION.md +214 -0
- package/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/URL-MAPPING.md +253 -0
- package/{docs/best-practices/scapi_hooks.md → ai-instructions/skills/sfcc-scapi-hooks/SKILL.md} +44 -17
- package/ai-instructions/skills/sfcc-script-evaluation/SKILL.md +380 -0
- package/{docs/best-practices/security.md → ai-instructions/skills/sfcc-security/SKILL.md} +12 -3
- package/ai-instructions/skills/sfcc-sfra-client-side-js/SKILL.md +270 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/AJAX-CSRF-VALIDATION.md +285 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/BASE-MODULE-INDEX.md +206 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/EXTENSION-PATTERNS.md +165 -0
- package/ai-instructions/skills/sfcc-sfra-client-side-js/references/PLUGIN-PATTERNS.md +185 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/SKILL.md +347 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/references/MIDDLEWARE-REFERENCE.md +257 -0
- package/ai-instructions/skills/sfcc-sfra-controllers/references/REMOTE-INCLUDES.md +193 -0
- package/{dist/docs/best-practices/sfra_controllers.md → ai-instructions/skills/sfcc-sfra-controllers/references/standard-sfra-controllers.md} +0 -670
- package/ai-instructions/skills/sfcc-sfra-models/SKILL.md +322 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/MODEL-PATTERNS.md +530 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/MODEL-STRUCTURE.md +234 -0
- package/ai-instructions/skills/sfcc-sfra-models/references/TESTING-SECURITY.md +417 -0
- package/{dist/docs/best-practices/sfra_scss.md → ai-instructions/skills/sfcc-sfra-scss/SKILL.md} +5 -0
- package/ai-instructions/skills/sfcc-webdav-workflows/SKILL.md +111 -0
- package/dist/ai-instructions/AGENTS.md +628 -0
- package/dist/ai-instructions/skills/sfcc-caching/SKILL.md +89 -0
- package/{docs/best-practices/cartridge_creation.md → dist/ai-instructions/skills/sfcc-cartridge-development/SKILL.md} +31 -7
- package/dist/ai-instructions/skills/sfcc-forms-development/SKILL.md +261 -0
- package/dist/ai-instructions/skills/sfcc-forms-development/references/ARCHITECTURE-SGJC-SFRA.md +143 -0
- package/dist/ai-instructions/skills/sfcc-forms-development/references/FORM-XML-CHEATSHEET.md +127 -0
- package/dist/ai-instructions/skills/sfcc-fraud-prevention/SKILL.md +95 -0
- package/dist/ai-instructions/skills/sfcc-hooks-registration/SKILL.md +39 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/SKILL.md +370 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/REMOTE-INCLUDES.md +116 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-LAYOUTS.md +50 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CART-ACCOUNT-AUTH.md +45 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-PAGES-CATALOG.md +85 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/SFRA-STRUCTURE-COMPONENTS.md +63 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/UTILITIES-EXPRESSIONS.md +159 -0
- package/dist/ai-instructions/skills/sfcc-isml-development/references/sfra-base-templates-architecture.md +13 -0
- package/dist/ai-instructions/skills/sfcc-job-development/SKILL.md +334 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/CHUNK-ORIENTED.md +393 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/STEPTYPES-JSON.md +271 -0
- package/dist/ai-instructions/skills/sfcc-job-development/references/TASK-ORIENTED.md +257 -0
- package/dist/ai-instructions/skills/sfcc-localization/SKILL.md +92 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/CONTROLLERS.md +63 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/FORMATTING.md +29 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/FORMS-LOCALIZATION.md +33 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/JAVASCRIPT-LOCALIZATION.md +41 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/LOCALE-SWITCHING.md +35 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/PATTERNS.md +740 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/PROPERTIES-ENCODING.md +25 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/RESOURCE-BUNDLES.md +67 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/STATIC-FILES.md +23 -0
- package/dist/ai-instructions/skills/sfcc-localization/references/TESTING.md +21 -0
- package/dist/{docs/best-practices/localserviceregistry.md → ai-instructions/skills/sfcc-localserviceregistry/SKILL.md} +65 -31
- package/dist/ai-instructions/skills/sfcc-logging/SKILL.md +352 -0
- package/dist/ai-instructions/skills/sfcc-logging/references/LOG-FILES.md +282 -0
- package/dist/{docs/best-practices/ocapi_hooks.md → ai-instructions/skills/sfcc-ocapi-hooks/SKILL.md} +51 -16
- package/dist/ai-instructions/skills/sfcc-ocapi-scapi-slas/SKILL.md +108 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/SKILL.md +353 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/references/ATTRIBUTE-TYPES.md +436 -0
- package/dist/ai-instructions/skills/sfcc-page-designer/references/META-DEFINITIONS.md +322 -0
- package/{docs/best-practices/performance.md → dist/ai-instructions/skills/sfcc-performance/SKILL.md} +35 -3
- package/dist/ai-instructions/skills/sfcc-platform-limits/SKILL.md +89 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/SKILL.md +237 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/AUTHENTICATION.md +214 -0
- package/dist/ai-instructions/skills/sfcc-scapi-custom-endpoints/references/URL-MAPPING.md +253 -0
- package/dist/{docs/best-practices/scapi_hooks.md → ai-instructions/skills/sfcc-scapi-hooks/SKILL.md} +44 -17
- package/dist/ai-instructions/skills/sfcc-script-evaluation/SKILL.md +380 -0
- package/dist/{docs/best-practices/security.md → ai-instructions/skills/sfcc-security/SKILL.md} +12 -3
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/SKILL.md +270 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/AJAX-CSRF-VALIDATION.md +285 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/BASE-MODULE-INDEX.md +206 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/EXTENSION-PATTERNS.md +165 -0
- package/dist/ai-instructions/skills/sfcc-sfra-client-side-js/references/PLUGIN-PATTERNS.md +185 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/SKILL.md +347 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/references/MIDDLEWARE-REFERENCE.md +257 -0
- package/dist/ai-instructions/skills/sfcc-sfra-controllers/references/REMOTE-INCLUDES.md +193 -0
- package/{docs/best-practices/sfra_controllers.md → dist/ai-instructions/skills/sfcc-sfra-controllers/references/standard-sfra-controllers.md} +0 -670
- package/dist/ai-instructions/skills/sfcc-sfra-models/SKILL.md +322 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/MODEL-PATTERNS.md +530 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/MODEL-STRUCTURE.md +234 -0
- package/dist/ai-instructions/skills/sfcc-sfra-models/references/TESTING-SECURITY.md +417 -0
- package/{docs/best-practices/sfra_scss.md → dist/ai-instructions/skills/sfcc-sfra-scss/SKILL.md} +5 -0
- package/dist/ai-instructions/skills/sfcc-webdav-workflows/SKILL.md +111 -0
- package/dist/clients/agent-instructions-client.d.ts +66 -0
- package/dist/clients/agent-instructions-client.d.ts.map +1 -0
- package/dist/clients/agent-instructions-client.js +277 -0
- package/dist/clients/agent-instructions-client.js.map +1 -0
- package/dist/clients/base/abstract-documentation-client.d.ts +146 -0
- package/dist/clients/base/abstract-documentation-client.d.ts.map +1 -0
- package/dist/clients/base/abstract-documentation-client.js +265 -0
- package/dist/clients/base/abstract-documentation-client.js.map +1 -0
- package/dist/clients/base/oauth-token.d.ts +18 -0
- package/dist/clients/base/oauth-token.d.ts.map +1 -1
- package/dist/clients/base/oauth-token.js +45 -2
- package/dist/clients/base/oauth-token.js.map +1 -1
- package/dist/clients/cartridge/cartridge-generation-client.d.ts +59 -0
- package/dist/clients/cartridge/cartridge-generation-client.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-generation-client.js +224 -0
- package/dist/clients/cartridge/cartridge-generation-client.js.map +1 -0
- package/dist/clients/cartridge/cartridge-structure.d.ts +17 -0
- package/dist/clients/cartridge/cartridge-structure.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-structure.js +33 -0
- package/dist/clients/cartridge/cartridge-structure.js.map +1 -0
- package/dist/clients/cartridge/cartridge-templates.d.ts +22 -0
- package/dist/clients/cartridge/cartridge-templates.d.ts.map +1 -0
- package/dist/clients/cartridge/cartridge-templates.js +225 -0
- package/dist/clients/cartridge/cartridge-templates.js.map +1 -0
- package/dist/clients/cartridge/index.d.ts +7 -0
- package/dist/clients/cartridge/index.d.ts.map +1 -0
- package/dist/clients/cartridge/index.js +7 -0
- package/dist/clients/cartridge/index.js.map +1 -0
- package/dist/clients/docs/documentation-scanner.d.ts +5 -2
- package/dist/clients/docs/documentation-scanner.d.ts.map +1 -1
- package/dist/clients/docs/documentation-scanner.js +38 -23
- package/dist/clients/docs/documentation-scanner.js.map +1 -1
- package/dist/clients/docs-client.d.ts +13 -4
- package/dist/clients/docs-client.d.ts.map +1 -1
- package/dist/clients/docs-client.js +44 -11
- package/dist/clients/docs-client.js.map +1 -1
- package/dist/clients/isml-client.d.ts +71 -0
- package/dist/clients/isml-client.d.ts.map +1 -0
- package/dist/clients/isml-client.js +252 -0
- package/dist/clients/isml-client.js.map +1 -0
- package/dist/clients/ocapi/code-versions-client.d.ts.map +1 -1
- package/dist/clients/ocapi/code-versions-client.js +6 -1
- package/dist/clients/ocapi/code-versions-client.js.map +1 -1
- package/dist/clients/ocapi-client.d.ts +9 -101
- package/dist/clients/ocapi-client.d.ts.map +1 -1
- package/dist/clients/ocapi-client.js +11 -93
- package/dist/clients/ocapi-client.js.map +1 -1
- package/dist/clients/script-debugger/index.d.ts +5 -0
- package/dist/clients/script-debugger/index.d.ts.map +1 -0
- package/dist/clients/script-debugger/index.js +5 -0
- package/dist/clients/script-debugger/index.js.map +1 -0
- package/dist/clients/script-debugger/script-debugger-client.d.ts +147 -0
- package/dist/clients/script-debugger/script-debugger-client.d.ts.map +1 -0
- package/dist/clients/script-debugger/script-debugger-client.js +591 -0
- package/dist/clients/script-debugger/script-debugger-client.js.map +1 -0
- package/dist/clients/sfra-client.d.ts +13 -62
- package/dist/clients/sfra-client.d.ts.map +1 -1
- package/dist/clients/sfra-client.js +105 -326
- package/dist/clients/sfra-client.js.map +1 -1
- package/dist/config/configuration-factory.d.ts +1 -1
- package/dist/config/configuration-factory.d.ts.map +1 -1
- package/dist/config/configuration-factory.js +5 -1
- package/dist/config/configuration-factory.js.map +1 -1
- package/dist/config/dw-json-loader.d.ts +7 -0
- package/dist/config/dw-json-loader.d.ts.map +1 -1
- package/dist/config/dw-json-loader.js +92 -15
- package/dist/config/dw-json-loader.js.map +1 -1
- package/dist/config/workspace-roots.d.ts +143 -0
- package/dist/config/workspace-roots.d.ts.map +1 -0
- package/dist/config/workspace-roots.js +448 -0
- package/dist/config/workspace-roots.js.map +1 -0
- package/dist/constants/index.d.ts +1 -0
- package/dist/constants/index.d.ts.map +1 -0
- package/dist/constants/index.js +3 -0
- package/dist/constants/index.js.map +1 -0
- package/dist/core/handlers/abstract-client-handler.d.ts +52 -0
- package/dist/core/handlers/abstract-client-handler.d.ts.map +1 -0
- package/dist/core/handlers/abstract-client-handler.js +51 -0
- package/dist/core/handlers/abstract-client-handler.js.map +1 -0
- package/dist/core/handlers/agent-instructions-handler.d.ts +17 -0
- package/dist/core/handlers/agent-instructions-handler.d.ts.map +1 -0
- package/dist/core/handlers/agent-instructions-handler.js +38 -0
- package/dist/core/handlers/agent-instructions-handler.js.map +1 -0
- package/dist/core/handlers/base-handler.d.ts +3 -68
- package/dist/core/handlers/base-handler.d.ts.map +1 -1
- package/dist/core/handlers/base-handler.js +11 -84
- package/dist/core/handlers/base-handler.js.map +1 -1
- package/dist/core/handlers/cartridge-handler.d.ts +10 -11
- package/dist/core/handlers/cartridge-handler.d.ts.map +1 -1
- package/dist/core/handlers/cartridge-handler.js +10 -28
- package/dist/core/handlers/cartridge-handler.js.map +1 -1
- package/dist/core/handlers/client-factory.d.ts +12 -2
- package/dist/core/handlers/client-factory.d.ts.map +1 -1
- package/dist/core/handlers/client-factory.js +28 -1
- package/dist/core/handlers/client-factory.js.map +1 -1
- package/dist/core/handlers/code-version-handler.d.ts +11 -11
- package/dist/core/handlers/code-version-handler.d.ts.map +1 -1
- package/dist/core/handlers/code-version-handler.js +13 -27
- package/dist/core/handlers/code-version-handler.js.map +1 -1
- package/dist/core/handlers/docs-handler.d.ts +6 -12
- package/dist/core/handlers/docs-handler.d.ts.map +1 -1
- package/dist/core/handlers/docs-handler.js +11 -36
- package/dist/core/handlers/docs-handler.js.map +1 -1
- package/dist/core/handlers/isml-handler.d.ts +11 -0
- package/dist/core/handlers/isml-handler.d.ts.map +1 -0
- package/dist/core/handlers/isml-handler.js +18 -0
- package/dist/core/handlers/isml-handler.js.map +1 -0
- package/dist/core/handlers/job-log-handler.d.ts +8 -7
- package/dist/core/handlers/job-log-handler.d.ts.map +1 -1
- package/dist/core/handlers/job-log-handler.js +14 -5
- package/dist/core/handlers/job-log-handler.js.map +1 -1
- package/dist/core/handlers/log-handler.d.ts +8 -7
- package/dist/core/handlers/log-handler.d.ts.map +1 -1
- package/dist/core/handlers/log-handler.js +14 -5
- package/dist/core/handlers/log-handler.js.map +1 -1
- package/dist/core/handlers/script-debugger-handler.d.ts +18 -0
- package/dist/core/handlers/script-debugger-handler.d.ts.map +1 -0
- package/dist/core/handlers/script-debugger-handler.js +31 -0
- package/dist/core/handlers/script-debugger-handler.js.map +1 -0
- package/dist/core/handlers/sfra-handler.d.ts +6 -12
- package/dist/core/handlers/sfra-handler.d.ts.map +1 -1
- package/dist/core/handlers/sfra-handler.js +11 -36
- package/dist/core/handlers/sfra-handler.js.map +1 -1
- package/dist/core/handlers/simple-client-handler.d.ts +41 -0
- package/dist/core/handlers/simple-client-handler.d.ts.map +1 -0
- package/dist/core/handlers/simple-client-handler.js +49 -0
- package/dist/core/handlers/simple-client-handler.js.map +1 -0
- package/dist/core/handlers/system-object-handler.d.ts +11 -11
- package/dist/core/handlers/system-object-handler.d.ts.map +1 -1
- package/dist/core/handlers/system-object-handler.js +13 -27
- package/dist/core/handlers/system-object-handler.js.map +1 -1
- package/dist/core/handlers/validation-helpers.d.ts +22 -24
- package/dist/core/handlers/validation-helpers.d.ts.map +1 -1
- package/dist/core/handlers/validation-helpers.js +89 -39
- package/dist/core/handlers/validation-helpers.js.map +1 -1
- package/dist/core/instruction-advisor.d.ts +28 -0
- package/dist/core/instruction-advisor.d.ts.map +1 -0
- package/dist/core/instruction-advisor.js +114 -0
- package/dist/core/instruction-advisor.js.map +1 -0
- package/dist/core/server.d.ts +25 -0
- package/dist/core/server.d.ts.map +1 -1
- package/dist/core/server.js +151 -11
- package/dist/core/server.js.map +1 -1
- package/dist/core/tool-definitions.d.ts +6 -854
- package/dist/core/tool-definitions.d.ts.map +1 -1
- package/dist/core/tool-definitions.js +8 -1064
- package/dist/core/tool-definitions.js.map +1 -1
- package/dist/core/tool-schemas/agent-instruction-tools.d.ts +77 -0
- package/dist/core/tool-schemas/agent-instruction-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/agent-instruction-tools.js +72 -0
- package/dist/core/tool-schemas/agent-instruction-tools.js.map +1 -0
- package/dist/core/tool-schemas/cartridge-tools.d.ts +27 -0
- package/dist/core/tool-schemas/cartridge-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/cartridge-tools.js +29 -0
- package/dist/core/tool-schemas/cartridge-tools.js.map +1 -0
- package/dist/core/tool-schemas/code-version-tools.d.ts +28 -0
- package/dist/core/tool-schemas/code-version-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/code-version-tools.js +28 -0
- package/dist/core/tool-schemas/code-version-tools.js.map +1 -0
- package/dist/core/tool-schemas/documentation-tools.d.ts +139 -0
- package/dist/core/tool-schemas/documentation-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/documentation-tools.js +104 -0
- package/dist/core/tool-schemas/documentation-tools.js.map +1 -0
- package/dist/core/tool-schemas/index.d.ts +17 -0
- package/dist/core/tool-schemas/index.d.ts.map +1 -0
- package/dist/core/tool-schemas/index.js +19 -0
- package/dist/core/tool-schemas/index.js.map +1 -0
- package/dist/core/tool-schemas/isml-tools.d.ts +98 -0
- package/dist/core/tool-schemas/isml-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/isml-tools.js +89 -0
- package/dist/core/tool-schemas/isml-tools.js.map +1 -0
- package/dist/core/tool-schemas/log-tools.d.ts +221 -0
- package/dist/core/tool-schemas/log-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/log-tools.js +180 -0
- package/dist/core/tool-schemas/log-tools.js.map +1 -0
- package/dist/core/tool-schemas/script-debugger-tools.d.ts +44 -0
- package/dist/core/tool-schemas/script-debugger-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/script-debugger-tools.js +83 -0
- package/dist/core/tool-schemas/script-debugger-tools.js.map +1 -0
- package/dist/core/tool-schemas/sfra-tools.d.ts +63 -0
- package/dist/core/tool-schemas/sfra-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/sfra-tools.js +65 -0
- package/dist/core/tool-schemas/sfra-tools.js.map +1 -0
- package/dist/core/tool-schemas/shared-schemas.d.ts +350 -0
- package/dist/core/tool-schemas/shared-schemas.d.ts.map +1 -0
- package/dist/core/tool-schemas/shared-schemas.js +153 -0
- package/dist/core/tool-schemas/shared-schemas.js.map +1 -0
- package/dist/core/tool-schemas/system-object-tools.d.ts +511 -0
- package/dist/core/tool-schemas/system-object-tools.d.ts.map +1 -0
- package/dist/core/tool-schemas/system-object-tools.js +126 -0
- package/dist/core/tool-schemas/system-object-tools.js.map +1 -0
- package/dist/docs/dw_net/HTTPClient.md +46 -2
- package/dist/docs/dw_net/HTTPClientLoggingConfig.md +296 -0
- package/dist/docs/dw_order/Basket.md +7 -7
- package/dist/docs/dw_order/BasketMgr.md +22 -6
- package/dist/docs/dw_order.hooks/BasketMergeHooks.md +42 -0
- package/dist/docs/dw_svc/ServiceCallback.md +2 -2
- package/dist/docs/isml/isactivedatacontext.md +382 -0
- package/dist/docs/isml/isactivedatahead.md +566 -0
- package/dist/docs/isml/isanalyticsoff.md +537 -0
- package/dist/docs/isml/isapplepay.md +667 -0
- package/dist/docs/isml/isbreak.md +687 -0
- package/dist/docs/isml/isbuynow.md +682 -0
- package/dist/docs/isml/iscache.md +802 -0
- package/dist/docs/isml/iscomment.md +794 -0
- package/dist/docs/isml/iscomponent.md +797 -0
- package/dist/docs/isml/iscontent.md +594 -0
- package/dist/docs/isml/iscontinue.md +563 -0
- package/dist/docs/isml/iscookie.md +798 -0
- package/dist/docs/isml/isdecorate.md +818 -0
- package/dist/docs/isml/isif.md +737 -0
- package/dist/docs/isml/isinclude.md +874 -0
- package/dist/docs/isml/isloop.md +377 -0
- package/dist/docs/isml/ismodule.md +844 -0
- package/dist/docs/isml/isnext.md +672 -0
- package/dist/docs/isml/isobject.md +760 -0
- package/dist/docs/isml/ispayment.md +577 -0
- package/dist/docs/isml/ispaymentmessages.md +664 -0
- package/dist/docs/isml/isprint.md +875 -0
- package/dist/docs/isml/isredirect.md +716 -0
- package/dist/docs/isml/isremove.md +725 -0
- package/dist/docs/isml/isreplace.md +783 -0
- package/dist/docs/isml/isscript.md +859 -0
- package/dist/docs/isml/isselect.md +908 -0
- package/dist/docs/isml/isset.md +585 -0
- package/dist/docs/isml/isslot.md +824 -0
- package/dist/docs/isml/isstatus.md +711 -0
- package/dist/main.d.ts +16 -0
- package/dist/main.d.ts.map +1 -1
- package/dist/main.js +60 -28
- package/dist/main.js.map +1 -1
- package/dist/services/index.d.ts +4 -2
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/index.js +2 -2
- package/dist/services/index.js.map +1 -1
- package/dist/tool-configs/agent-instructions-tool-config.d.ts +6 -0
- package/dist/tool-configs/agent-instructions-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/agent-instructions-tool-config.js +74 -0
- package/dist/tool-configs/agent-instructions-tool-config.js.map +1 -0
- package/dist/tool-configs/code-version-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/code-version-tool-config.js +0 -5
- package/dist/tool-configs/code-version-tool-config.js.map +1 -1
- package/dist/tool-configs/docs-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/docs-tool-config.js +0 -7
- package/dist/tool-configs/docs-tool-config.js.map +1 -1
- package/dist/tool-configs/isml-tool-config.d.ts +11 -0
- package/dist/tool-configs/isml-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/isml-tool-config.js +77 -0
- package/dist/tool-configs/isml-tool-config.js.map +1 -0
- package/dist/tool-configs/job-log-tool-config.d.ts +1 -2
- package/dist/tool-configs/job-log-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/job-log-tool-config.js +11 -15
- package/dist/tool-configs/job-log-tool-config.js.map +1 -1
- package/dist/tool-configs/log-tool-config.d.ts +1 -2
- package/dist/tool-configs/log-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/log-tool-config.js +35 -51
- package/dist/tool-configs/log-tool-config.js.map +1 -1
- package/dist/tool-configs/script-debugger-tool-config.d.ts +11 -0
- package/dist/tool-configs/script-debugger-tool-config.d.ts.map +1 -0
- package/dist/tool-configs/script-debugger-tool-config.js +35 -0
- package/dist/tool-configs/script-debugger-tool-config.js.map +1 -0
- package/dist/tool-configs/sfra-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/sfra-tool-config.js +0 -11
- package/dist/tool-configs/sfra-tool-config.js.map +1 -1
- package/dist/tool-configs/system-object-tool-config.d.ts.map +1 -1
- package/dist/tool-configs/system-object-tool-config.js +0 -5
- package/dist/tool-configs/system-object-tool-config.js.map +1 -1
- package/dist/types/types.d.ts +2 -0
- package/dist/types/types.d.ts.map +1 -1
- package/dist/utils/cache.d.ts +12 -10
- package/dist/utils/cache.d.ts.map +1 -1
- package/dist/utils/cache.js +47 -47
- package/dist/utils/cache.js.map +1 -1
- package/dist/utils/category-utils.d.ts +31 -0
- package/dist/utils/category-utils.d.ts.map +1 -0
- package/dist/utils/category-utils.js +45 -0
- package/dist/utils/category-utils.js.map +1 -0
- package/dist/utils/log-tool-constants.d.ts +16 -13
- package/dist/utils/log-tool-constants.d.ts.map +1 -1
- package/dist/utils/log-tool-constants.js +10 -11
- package/dist/utils/log-tool-constants.js.map +1 -1
- package/dist/utils/logger.d.ts +11 -0
- package/dist/utils/logger.d.ts.map +1 -1
- package/dist/utils/logger.js +35 -1
- package/dist/utils/logger.js.map +1 -1
- package/dist/utils/markdown-utils.d.ts +60 -0
- package/dist/utils/markdown-utils.d.ts.map +1 -0
- package/dist/utils/markdown-utils.js +206 -0
- package/dist/utils/markdown-utils.js.map +1 -0
- package/dist/utils/path-resolver.d.ts +12 -4
- package/dist/utils/path-resolver.d.ts.map +1 -1
- package/dist/utils/path-resolver.js +22 -8
- package/dist/utils/path-resolver.js.map +1 -1
- package/dist/utils/path-validation.d.ts +40 -0
- package/dist/utils/path-validation.d.ts.map +1 -0
- package/dist/utils/path-validation.js +84 -0
- package/dist/utils/path-validation.js.map +1 -0
- package/docs/dw_net/HTTPClient.md +46 -2
- package/docs/dw_net/HTTPClientLoggingConfig.md +296 -0
- package/docs/dw_order/Basket.md +7 -7
- package/docs/dw_order/BasketMgr.md +22 -6
- package/docs/dw_order.hooks/BasketMergeHooks.md +42 -0
- package/docs/dw_svc/ServiceCallback.md +2 -2
- package/docs/isml/isactivedatacontext.md +382 -0
- package/docs/isml/isactivedatahead.md +566 -0
- package/docs/isml/isanalyticsoff.md +537 -0
- package/docs/isml/isapplepay.md +667 -0
- package/docs/isml/isbreak.md +687 -0
- package/docs/isml/isbuynow.md +682 -0
- package/docs/isml/iscache.md +802 -0
- package/docs/isml/iscomment.md +794 -0
- package/docs/isml/iscomponent.md +797 -0
- package/docs/isml/iscontent.md +594 -0
- package/docs/isml/iscontinue.md +563 -0
- package/docs/isml/iscookie.md +798 -0
- package/docs/isml/isdecorate.md +818 -0
- package/docs/isml/isif.md +737 -0
- package/docs/isml/isinclude.md +874 -0
- package/docs/isml/isloop.md +377 -0
- package/docs/isml/ismodule.md +844 -0
- package/docs/isml/isnext.md +672 -0
- package/docs/isml/isobject.md +760 -0
- package/docs/isml/ispayment.md +577 -0
- package/docs/isml/ispaymentmessages.md +664 -0
- package/docs/isml/isprint.md +875 -0
- package/docs/isml/isredirect.md +716 -0
- package/docs/isml/isremove.md +725 -0
- package/docs/isml/isreplace.md +783 -0
- package/docs/isml/isscript.md +859 -0
- package/docs/isml/isselect.md +908 -0
- package/docs/isml/isset.md +585 -0
- package/docs/isml/isslot.md +824 -0
- package/docs/isml/isstatus.md +711 -0
- package/docs-site-v2/.vitepress/config.mts +190 -0
- package/docs-site-v2/.vitepress/theme/components/AssistantTabs.vue +96 -0
- package/docs-site-v2/.vitepress/theme/components/Callout.vue +10 -0
- package/docs-site-v2/.vitepress/theme/components/Collapsible.vue +14 -0
- package/docs-site-v2/.vitepress/theme/components/DwJsonBuilder.vue +82 -0
- package/docs-site-v2/.vitepress/theme/components/HomeSections.vue +552 -0
- package/docs-site-v2/.vitepress/theme/components/InstructionFilesTabs.vue +87 -0
- package/docs-site-v2/.vitepress/theme/components/ModeTabs.vue +70 -0
- package/docs-site-v2/.vitepress/theme/components/NewcomerCTA.vue +14 -0
- package/docs-site-v2/.vitepress/theme/components/QuickStartCards.vue +20 -0
- package/docs-site-v2/.vitepress/theme/components/QuickStartHero.vue +20 -0
- package/docs-site-v2/.vitepress/theme/components/SkillsList.vue +48 -0
- package/docs-site-v2/.vitepress/theme/components/ToolExplorer.vue +85 -0
- package/docs-site-v2/.vitepress/theme/custom.css +1373 -0
- package/docs-site-v2/.vitepress/theme/index.ts +39 -0
- package/docs-site-v2/data/skills.ts +147 -0
- package/docs-site-v2/data/tools.ts +490 -0
- package/docs-site-v2/development/index.md +151 -0
- package/docs-site-v2/examples/index.md +333 -0
- package/docs-site-v2/features/index.md +144 -0
- package/docs-site-v2/guide/ai-interfaces.md +58 -0
- package/docs-site-v2/guide/configuration.md +208 -0
- package/docs-site-v2/guide/index.md +50 -0
- package/docs-site-v2/index.md +32 -0
- package/docs-site-v2/package-lock.json +2511 -0
- package/docs-site-v2/package.json +15 -0
- package/docs-site-v2/public/android-chrome-192x192.png +0 -0
- package/docs-site-v2/public/android-chrome-512x512.png +0 -0
- package/docs-site-v2/public/apple-touch-icon.png +0 -0
- package/docs-site-v2/public/favicon-16x16.png +0 -0
- package/docs-site-v2/public/favicon-32x32.png +0 -0
- package/docs-site-v2/public/favicon.ico +0 -0
- package/docs-site-v2/public/index.css +4174 -0
- package/docs-site-v2/public/llms.txt +44 -0
- package/docs-site-v2/public/logo-dark.svg +8 -0
- package/docs-site-v2/public/logo.svg +8 -0
- package/{docs-site → docs-site-v2}/public/robots.txt +1 -6
- package/{docs-site → docs-site-v2}/public/site.webmanifest +1 -1
- package/{docs-site → docs-site-v2}/public/sitemap.xml +33 -12
- package/docs-site-v2/script-debugger/index.md +105 -0
- package/docs-site-v2/scripts/generate-llms.js +71 -0
- package/docs-site-v2/scripts/generate-sitemap.js +97 -0
- package/docs-site-v2/security/index.md +115 -0
- package/docs-site-v2/skills/index.md +40 -0
- package/docs-site-v2/tools/index.md +36 -0
- package/docs-site-v2/troubleshooting/index.md +204 -0
- package/eslint.config.js +3 -1
- package/memories/repo/docs-site-v2-build.json +11 -0
- package/package.json +18 -14
- package/scripts/validate-server-json.js +68 -0
- package/server.json +4 -6
- package/src/clients/agent-instructions-client.ts +370 -0
- package/src/clients/base/abstract-documentation-client.ts +405 -0
- package/src/clients/base/oauth-token.ts +52 -2
- package/src/clients/cartridge/cartridge-generation-client.ts +302 -0
- package/src/clients/cartridge/cartridge-structure.ts +37 -0
- package/src/clients/cartridge/cartridge-templates.ts +246 -0
- package/src/clients/cartridge/index.ts +6 -0
- package/src/clients/docs/documentation-scanner.ts +44 -28
- package/src/clients/docs-client.ts +54 -14
- package/src/clients/isml-client.ts +353 -0
- package/src/clients/ocapi/code-versions-client.ts +7 -1
- package/src/clients/ocapi-client.ts +11 -166
- package/src/clients/script-debugger/index.ts +5 -0
- package/src/clients/script-debugger/script-debugger-client.ts +754 -0
- package/src/clients/sfra-client.ts +134 -397
- package/src/config/configuration-factory.ts +6 -1
- package/src/config/dw-json-loader.ts +96 -15
- package/src/config/workspace-roots.ts +540 -0
- package/src/constants/index.ts +1 -0
- package/src/core/handlers/abstract-client-handler.ts +85 -0
- package/src/core/handlers/agent-instructions-handler.ts +48 -0
- package/src/core/handlers/base-handler.ts +17 -127
- package/src/core/handlers/cartridge-handler.ts +13 -33
- package/src/core/handlers/client-factory.ts +32 -2
- package/src/core/handlers/code-version-handler.ts +17 -32
- package/src/core/handlers/docs-handler.ts +12 -44
- package/src/core/handlers/isml-handler.ts +19 -0
- package/src/core/handlers/job-log-handler.ts +19 -8
- package/src/core/handlers/log-handler.ts +19 -8
- package/src/core/handlers/script-debugger-handler.ts +46 -0
- package/src/core/handlers/sfra-handler.ts +12 -44
- package/src/core/handlers/simple-client-handler.ts +78 -0
- package/src/core/handlers/system-object-handler.ts +17 -32
- package/src/core/handlers/validation-helpers.ts +87 -47
- package/src/core/instruction-advisor.ts +122 -0
- package/src/core/server.ts +178 -13
- package/src/core/tool-definitions.ts +25 -1071
- package/src/core/tool-schemas/agent-instruction-tools.ts +72 -0
- package/src/core/tool-schemas/cartridge-tools.ts +29 -0
- package/src/core/tool-schemas/code-version-tools.ts +28 -0
- package/src/core/tool-schemas/documentation-tools.ts +104 -0
- package/src/core/tool-schemas/index.ts +27 -0
- package/src/core/tool-schemas/isml-tools.ts +89 -0
- package/src/core/tool-schemas/log-tools.ts +196 -0
- package/src/core/tool-schemas/script-debugger-tools.ts +83 -0
- package/src/core/tool-schemas/sfra-tools.ts +65 -0
- package/src/core/tool-schemas/shared-schemas.ts +158 -0
- package/src/core/tool-schemas/system-object-tools.ts +127 -0
- package/src/main.ts +63 -30
- package/src/services/index.ts +4 -10
- package/src/tool-configs/agent-instructions-tool-config.ts +83 -0
- package/src/tool-configs/cartridge-tool-config.ts +1 -1
- package/src/tool-configs/code-version-tool-config.ts +0 -5
- package/src/tool-configs/docs-tool-config.ts +0 -7
- package/src/tool-configs/isml-tool-config.ts +87 -0
- package/src/tool-configs/job-log-tool-config.ts +18 -17
- package/src/tool-configs/log-tool-config.ts +49 -64
- package/src/tool-configs/script-debugger-tool-config.ts +69 -0
- package/src/tool-configs/sfra-tool-config.ts +0 -11
- package/src/tool-configs/system-object-tool-config.ts +0 -5
- package/src/types/types.ts +2 -0
- package/src/utils/cache.ts +49 -54
- package/src/utils/category-utils.ts +70 -0
- package/src/utils/log-tool-constants.ts +25 -17
- package/src/utils/logger.ts +38 -1
- package/src/utils/markdown-utils.ts +280 -0
- package/src/utils/path-resolver.ts +25 -9
- package/src/utils/path-validation.ts +113 -0
- package/tests/base-handler.test.ts +1 -1
- package/tests/cache.test.ts +2 -2
- package/tests/cartridge-handler.test.ts +4 -4
- package/tests/client-factory.test.ts +1 -1
- package/tests/code-version-handler.test.ts +3 -3
- package/tests/docs-handler.test.ts +2 -2
- package/tests/documentation-scanner.test.ts +4 -4
- package/tests/isml-client.test.ts +463 -0
- package/tests/isml-handler.test.ts +375 -0
- package/tests/job-log-handler.test.ts +1 -1
- package/tests/log-handler.test.ts +8 -8
- package/tests/log-validation.test.ts +149 -0
- package/tests/mcp/README.md +22 -18
- package/tests/mcp/node/activate-code-version-advanced.full-mode.programmatic.test.js +30 -12
- package/tests/mcp/node/evaluate-script.full-mode.programmatic.test.js +387 -0
- package/tests/mcp/node/generate-cartridge-structure.docs-only.programmatic.test.js +14 -8
- package/tests/mcp/node/get-isml-categories.programmatic.test.js +278 -0
- package/tests/mcp/node/get-isml-element.programmatic.test.js +278 -0
- package/tests/mcp/node/get-isml-elements-by-category.programmatic.test.js +363 -0
- package/tests/mcp/node/get-sfra-categories.docs-only.programmatic.test.js +24 -24
- package/tests/mcp/node/get-sfra-document.programmatic.test.js +4 -2
- package/tests/mcp/node/list-isml-elements.programmatic.test.js +311 -0
- package/tests/mcp/node/list-sfcc-classes.docs-only.programmatic.test.js +2 -33
- package/tests/mcp/node/search-isml-elements.programmatic.test.js +325 -0
- package/tests/mcp/node/search-sfcc-classes.docs-only.programmatic.test.js +5 -9
- package/tests/mcp/node/search-sfcc-methods.docs-only.programmatic.test.js +7 -9
- package/tests/mcp/node/tools.docs-only.programmatic.test.js +42 -65
- package/tests/mcp/node/tools.full-mode.programmatic.test.js +7 -8
- package/tests/mcp/yaml/activate-code-version.full-mode.test.mcp.yml +2 -2
- package/tests/mcp/yaml/evaluate-script.full-mode.test.mcp.yml +281 -0
- package/tests/mcp/yaml/get-isml-categories.docs-only.test.mcp.yml +330 -0
- package/tests/mcp/yaml/get-isml-element.docs-only.test.mcp.yml +294 -0
- package/tests/mcp/yaml/get-isml-elements-by-category.docs-only.test.mcp.yml +334 -0
- package/tests/mcp/yaml/get-sfcc-class-info.docs-only.test.mcp.yml +2 -2
- package/tests/mcp/yaml/get-sfra-categories.docs-only.test.mcp.yml +13 -13
- package/tests/mcp/yaml/get-sfra-categories.full-mode.test.mcp.yml +13 -13
- package/tests/mcp/yaml/get-system-object-definitions.docs-only.test.mcp.yml +1 -16
- package/tests/mcp/yaml/list-isml-elements.docs-only.test.mcp.yml +212 -0
- package/tests/mcp/yaml/search-isml-elements.docs-only.test.mcp.yml +312 -0
- package/tests/mcp/yaml/search-sfcc-classes.docs-only.test.mcp.yml +1 -1
- package/tests/mcp/yaml/search-sfcc-classes.full-mode.test.mcp.yml +1 -1
- package/tests/mcp/yaml/search-site-preferences.docs-only.test.mcp.yml +1 -1
- package/tests/mcp/yaml/tools.docs-only.test.mcp.yml +3 -57
- package/tests/mcp/yaml/tools.full-mode.test.mcp.yml +3 -3
- package/tests/oauth-token.test.ts +107 -12
- package/tests/ocapi-client.test.ts +53 -106
- package/tests/script-debugger-client.test.ts +430 -0
- package/tests/servers/sfcc-mock-server/src/app.js +15 -0
- package/tests/servers/sfcc-mock-server/src/routes/cartridge-webdav.js +258 -0
- package/tests/servers/sfcc-mock-server/src/routes/ocapi/debugger-handler.js +396 -0
- package/tests/servers/sfcc-mock-server/src/routes/ocapi.js +5 -0
- package/tests/servers/sfcc-mock-server/src/routes/storefront.js +86 -0
- package/tests/servers/sfcc-mock-server/src/routes/webdav.js +6 -4
- package/tests/validation-helpers.test.ts +0 -31
- package/tests/workspace-roots.test.ts +227 -0
- package/ai-instructions/claude-desktop/claude_custom_instructions.md +0 -321
- package/ai-instructions/cursor/.cursor/rules/debugging-workflows.mdc +0 -171
- package/ai-instructions/cursor/.cursor/rules/hooks-development.mdc +0 -168
- package/ai-instructions/cursor/.cursor/rules/isml-templates.mdc +0 -209
- package/ai-instructions/cursor/.cursor/rules/job-framework.mdc +0 -379
- package/ai-instructions/cursor/.cursor/rules/performance-optimization.mdc +0 -215
- package/ai-instructions/cursor/.cursor/rules/scapi-endpoints.mdc +0 -98
- package/ai-instructions/cursor/.cursor/rules/security-patterns.mdc +0 -375
- package/ai-instructions/cursor/.cursor/rules/sfcc-development.mdc +0 -144
- package/ai-instructions/cursor/.cursor/rules/sfra-controllers.mdc +0 -376
- package/ai-instructions/cursor/.cursor/rules/sfra-models.mdc +0 -412
- package/ai-instructions/cursor/.cursor/rules/system-objects.mdc +0 -383
- package/ai-instructions/cursor/.cursor/rules/testing-patterns.mdc +0 -418
- package/dist/clients/best-practices-client.d.ts +0 -57
- package/dist/clients/best-practices-client.d.ts.map +0 -1
- package/dist/clients/best-practices-client.js +0 -288
- package/dist/clients/best-practices-client.js.map +0 -1
- package/dist/clients/cartridge-generation-client.d.ts +0 -57
- package/dist/clients/cartridge-generation-client.d.ts.map +0 -1
- package/dist/clients/cartridge-generation-client.js +0 -384
- package/dist/clients/cartridge-generation-client.js.map +0 -1
- package/dist/clients/logs/index.d.ts +0 -13
- package/dist/clients/logs/index.d.ts.map +0 -1
- package/dist/clients/logs/index.js +0 -15
- package/dist/clients/logs/index.js.map +0 -1
- package/dist/clients/logs/log-analyzer.d.ts +0 -55
- package/dist/clients/logs/log-analyzer.d.ts.map +0 -1
- package/dist/clients/logs/log-analyzer.js +0 -228
- package/dist/clients/logs/log-analyzer.js.map +0 -1
- package/dist/clients/logs/log-client.d.ts +0 -87
- package/dist/clients/logs/log-client.d.ts.map +0 -1
- package/dist/clients/logs/log-client.js +0 -418
- package/dist/clients/logs/log-client.js.map +0 -1
- package/dist/clients/logs/log-constants.d.ts +0 -37
- package/dist/clients/logs/log-constants.d.ts.map +0 -1
- package/dist/clients/logs/log-constants.js +0 -37
- package/dist/clients/logs/log-constants.js.map +0 -1
- package/dist/clients/logs/log-file-discovery.d.ts +0 -62
- package/dist/clients/logs/log-file-discovery.d.ts.map +0 -1
- package/dist/clients/logs/log-file-discovery.js +0 -238
- package/dist/clients/logs/log-file-discovery.js.map +0 -1
- package/dist/clients/logs/log-file-reader.d.ts +0 -53
- package/dist/clients/logs/log-file-reader.d.ts.map +0 -1
- package/dist/clients/logs/log-file-reader.js +0 -194
- package/dist/clients/logs/log-file-reader.js.map +0 -1
- package/dist/clients/logs/log-formatter.d.ts +0 -90
- package/dist/clients/logs/log-formatter.d.ts.map +0 -1
- package/dist/clients/logs/log-formatter.js +0 -189
- package/dist/clients/logs/log-formatter.js.map +0 -1
- package/dist/clients/logs/log-processor.d.ts +0 -91
- package/dist/clients/logs/log-processor.d.ts.map +0 -1
- package/dist/clients/logs/log-processor.js +0 -328
- package/dist/clients/logs/log-processor.js.map +0 -1
- package/dist/clients/logs/log-types.d.ts +0 -69
- package/dist/clients/logs/log-types.d.ts.map +0 -1
- package/dist/clients/logs/log-types.js +0 -5
- package/dist/clients/logs/log-types.js.map +0 -1
- package/dist/clients/logs/webdav-client-manager.d.ts +0 -28
- package/dist/clients/logs/webdav-client-manager.d.ts.map +0 -1
- package/dist/clients/logs/webdav-client-manager.js +0 -77
- package/dist/clients/logs/webdav-client-manager.js.map +0 -1
- package/dist/core/handlers/abstract-log-tool-handler.d.ts +0 -35
- package/dist/core/handlers/abstract-log-tool-handler.d.ts.map +0 -1
- package/dist/core/handlers/abstract-log-tool-handler.js +0 -46
- package/dist/core/handlers/abstract-log-tool-handler.js.map +0 -1
- package/dist/core/handlers/best-practices-handler.d.ts +0 -17
- package/dist/core/handlers/best-practices-handler.d.ts.map +0 -1
- package/dist/core/handlers/best-practices-handler.js +0 -43
- package/dist/core/handlers/best-practices-handler.js.map +0 -1
- package/dist/core/handlers/job-log-tool-config.d.ts +0 -8
- package/dist/core/handlers/job-log-tool-config.d.ts.map +0 -1
- package/dist/core/handlers/job-log-tool-config.js +0 -76
- package/dist/core/handlers/job-log-tool-config.js.map +0 -1
- package/dist/core/handlers/log-tool-config.d.ts +0 -8
- package/dist/core/handlers/log-tool-config.d.ts.map +0 -1
- package/dist/core/handlers/log-tool-config.js +0 -73
- package/dist/core/handlers/log-tool-config.js.map +0 -1
- package/dist/docs/best-practices/isml_templates.md +0 -1933
- package/dist/docs/best-practices/job_framework.md +0 -1173
- package/dist/docs/best-practices/scapi_custom_endpoint.md +0 -963
- package/dist/docs/best-practices/sfra_client_side_js.md +0 -736
- package/dist/docs/best-practices/sfra_models.md +0 -1142
- package/dist/tool-configs/best-practices-tool-config.d.ts +0 -11
- package/dist/tool-configs/best-practices-tool-config.d.ts.map +0 -1
- package/dist/tool-configs/best-practices-tool-config.js +0 -59
- package/dist/tool-configs/best-practices-tool-config.js.map +0 -1
- package/dist/utils/job-log-tool-config.d.ts +0 -8
- package/dist/utils/job-log-tool-config.d.ts.map +0 -1
- package/dist/utils/job-log-tool-config.js +0 -76
- package/dist/utils/job-log-tool-config.js.map +0 -1
- package/dist/utils/job-log-utils.d.ts +0 -34
- package/dist/utils/job-log-utils.d.ts.map +0 -1
- package/dist/utils/job-log-utils.js +0 -60
- package/dist/utils/job-log-utils.js.map +0 -1
- package/dist/utils/log-cache.d.ts +0 -53
- package/dist/utils/log-cache.d.ts.map +0 -1
- package/dist/utils/log-cache.js +0 -114
- package/dist/utils/log-cache.js.map +0 -1
- package/dist/utils/log-tool-config.d.ts +0 -8
- package/dist/utils/log-tool-config.d.ts.map +0 -1
- package/dist/utils/log-tool-config.js +0 -73
- package/dist/utils/log-tool-config.js.map +0 -1
- package/dist/utils/log-tool-utils.d.ts +0 -39
- package/dist/utils/log-tool-utils.d.ts.map +0 -1
- package/dist/utils/log-tool-utils.js +0 -94
- package/dist/utils/log-tool-utils.js.map +0 -1
- package/docs/best-practices/isml_templates.md +0 -1933
- package/docs/best-practices/job_framework.md +0 -1173
- package/docs/best-practices/scapi_custom_endpoint.md +0 -963
- package/docs/best-practices/sfra_client_side_js.md +0 -736
- package/docs/best-practices/sfra_models.md +0 -1142
- package/docs-site/App.tsx +0 -103
- package/docs-site/README.md +0 -113
- package/docs-site/components/Badge.tsx +0 -38
- package/docs-site/components/BreadcrumbSchema.tsx +0 -34
- package/docs-site/components/CodeBlock.tsx +0 -132
- package/docs-site/components/Collapsible.tsx +0 -40
- package/docs-site/components/ConfigBuilder.tsx +0 -118
- package/docs-site/components/ConfigHero.tsx +0 -19
- package/docs-site/components/ConfigModeTabs.tsx +0 -42
- package/docs-site/components/Layout.tsx +0 -174
- package/docs-site/components/LightCodeContainer.tsx +0 -44
- package/docs-site/components/NewcomerCTA.tsx +0 -57
- package/docs-site/components/NextStepsStrip.tsx +0 -23
- package/docs-site/components/OnThisPage.tsx +0 -91
- package/docs-site/components/SEO.tsx +0 -79
- package/docs-site/components/Search.tsx +0 -207
- package/docs-site/components/Sidebar.tsx +0 -96
- package/docs-site/components/StructuredData.tsx +0 -72
- package/docs-site/components/ToolCard.tsx +0 -84
- package/docs-site/components/ToolFilters.tsx +0 -39
- package/docs-site/components/Typography.tsx +0 -30
- package/docs-site/components/VersionBadge.tsx +0 -18
- package/docs-site/components/icons.tsx +0 -37
- package/docs-site/constants.tsx +0 -34
- package/docs-site/index.html +0 -62
- package/docs-site/main.tsx +0 -16
- package/docs-site/metadata.json +0 -5
- package/docs-site/package-lock.json +0 -3966
- package/docs-site/package.json +0 -35
- package/docs-site/pages/AIInterfacesPage.tsx +0 -610
- package/docs-site/pages/ConfigurationPage.tsx +0 -315
- package/docs-site/pages/DevelopmentPage.tsx +0 -607
- package/docs-site/pages/ExamplesPage.tsx +0 -558
- package/docs-site/pages/FeaturesPage.tsx +0 -353
- package/docs-site/pages/HomePage.tsx +0 -1046
- package/docs-site/pages/SecurityPage.tsx +0 -372
- package/docs-site/pages/ToolsPage.tsx +0 -205
- package/docs-site/pages/TroubleshootingPage.tsx +0 -590
- package/docs-site/postcss.config.js +0 -6
- package/docs-site/public/.well-known/security.txt +0 -6
- package/docs-site/public/android-chrome-192x192.png +0 -0
- package/docs-site/public/android-chrome-512x512.png +0 -0
- package/docs-site/public/apple-touch-icon.png +0 -0
- package/docs-site/public/favicon-16x16.png +0 -0
- package/docs-site/public/favicon-32x32.png +0 -0
- package/docs-site/public/favicon.ico +0 -0
- package/docs-site/public/llms.txt +0 -47
- package/docs-site/scripts/generate-search-index.js +0 -323
- package/docs-site/scripts/generate-sitemap.js +0 -156
- package/docs-site/scripts/search-dev.js +0 -112
- package/docs-site/src/styles/input.css +0 -248
- package/docs-site/src/styles/prism-theme.css +0 -124
- package/docs-site/tailwind.config.js +0 -70
- package/docs-site/tsconfig.json +0 -29
- package/docs-site/types.ts +0 -16
- package/docs-site/utils/search.ts +0 -132
- package/docs-site/utils/toolsData.ts +0 -116
- package/docs-site/vite.config.ts +0 -63
- package/src/clients/best-practices-client.ts +0 -332
- package/src/clients/cartridge-generation-client.ts +0 -507
- package/src/clients/logs/index.ts +0 -18
- package/src/clients/logs/log-analyzer.ts +0 -289
- package/src/clients/logs/log-client.ts +0 -540
- package/src/clients/logs/log-constants.ts +0 -53
- package/src/clients/logs/log-file-discovery.ts +0 -299
- package/src/clients/logs/log-file-reader.ts +0 -227
- package/src/clients/logs/log-formatter.ts +0 -258
- package/src/clients/logs/log-processor.ts +0 -402
- package/src/clients/logs/log-types.ts +0 -80
- package/src/clients/logs/webdav-client-manager.ts +0 -93
- package/src/core/handlers/abstract-log-tool-handler.ts +0 -64
- package/src/core/handlers/best-practices-handler.ts +0 -55
- package/src/core/handlers/job-log-tool-config.ts +0 -89
- package/src/core/handlers/log-tool-config.ts +0 -98
- package/src/tool-configs/best-practices-tool-config.ts +0 -68
- package/src/utils/job-log-tool-config.ts +0 -89
- package/src/utils/job-log-utils.ts +0 -78
- package/src/utils/log-cache.ts +0 -134
- package/src/utils/log-tool-config.ts +0 -98
- package/src/utils/log-tool-utils.ts +0 -122
- package/tests/best-practices-handler.test.ts +0 -236
- package/tests/job-log-utils.test.ts +0 -182
- package/tests/mcp/node/get-available-best-practice-guides.docs-only.programmatic.test.js +0 -516
- package/tests/mcp/node/get-best-practice-guide.docs-only.programmatic.test.js +0 -733
- package/tests/mcp/node/get-hook-reference.docs-only.programmatic.test.js +0 -185
- package/tests/mcp/node/search-best-practices.docs-only.programmatic.test.js +0 -836
- package/tests/mcp/yaml/get-available-best-practice-guides.docs-only.test.mcp.yml +0 -885
- package/tests/mcp/yaml/get-available-best-practice-guides.full-mode.test.mcp.yml +0 -885
- package/tests/mcp/yaml/get-best-practice-guide.docs-only.test.mcp.yml +0 -462
- package/tests/mcp/yaml/get-best-practice-guide.full-mode.test.mcp.yml +0 -462
- package/tests/mcp/yaml/get-hook-reference.docs-only.test.mcp.yml +0 -321
- package/tests/mcp/yaml/get-hook-reference.full-mode.test.mcp.yml +0 -321
- package/tests/mcp/yaml/search-best-practices.docs-only.test.mcp.yml +0 -655
- package/tests/mcp/yaml/search-best-practices.full-mode.test.mcp.yml +0 -655
- /package/{docs-site → docs-site-v2}/public/404.html +0 -0
- /package/{docs-site → docs-site-v2}/public/explain-product-pricing-methods-no-mcp.png +0 -0
- /package/{docs-site → docs-site-v2}/public/explain-product-pricing-methods.png +0 -0
|
@@ -1,755 +1,27 @@
|
|
|
1
1
|
---
|
|
2
2
|
applyTo: "**/*.test.mcp.yml"
|
|
3
3
|
---
|
|
4
|
+
# MCP YAML Testing Instructions
|
|
4
5
|
|
|
5
|
-
|
|
6
|
+
For detailed guidance on writing YAML tests, use the `mcp-yaml-testing` skill located at `.github/skills/mcp-yaml-testing/SKILL.md`.
|
|
6
7
|
|
|
7
|
-
|
|
8
|
+
## Quick Reference
|
|
8
9
|
|
|
9
|
-
**
|
|
10
|
-
|
|
11
|
-
## 🆕 New Features: Pipe-Separated Parameters & Enhanced Testing
|
|
12
|
-
|
|
13
|
-
MCP Aegis now supports **CLI-friendly pipe-separated parameter format** alongside traditional JSON:
|
|
14
|
-
|
|
15
|
-
```bash
|
|
16
|
-
# 🆕 Pipe format (CLI-friendly): key:value|other:123
|
|
17
|
-
npx aegis query calculator 'operation:add|a:5|b:3' --config "config.json"
|
|
18
|
-
|
|
19
|
-
# Traditional JSON (still supported): {"key":"value","other":123}
|
|
20
|
-
npx aegis query calculator '{"operation": "add", "a": 5, "b": 3}' --config "config.json"
|
|
21
|
-
```
|
|
22
|
-
|
|
23
|
-
**Benefits**: ✅ No shell escaping ✅ Readable syntax ✅ Type inference ✅ Nested objects via dot notation ✅ Backward compatible
|
|
24
|
-
|
|
25
|
-
## 🥇 GOLDEN RULE: Always Discover Response Formats First
|
|
26
|
-
|
|
27
|
-
**CRITICAL**: Before writing ANY YAML test, you MUST use `aegis query` to discover actual response formats for both success and failure scenarios. Never assume response structure.
|
|
28
|
-
|
|
29
|
-
### Test Development Workflow (Discovery-First)
|
|
30
|
-
|
|
31
|
-
**Step 1: Discovery Commands (Mandatory)**
|
|
32
|
-
```bash
|
|
33
|
-
# Test successful execution
|
|
34
|
-
npx aegis query [tool_name] '[valid_params]' --config "config.json"
|
|
35
|
-
|
|
36
|
-
# Test failure scenarios
|
|
37
|
-
npx aegis query [tool_name] '[invalid_params]' --config "config.json"
|
|
38
|
-
npx aegis query [tool_name] '' --config "config.json" # Empty/missing params
|
|
39
|
-
```
|
|
40
|
-
|
|
41
|
-
**Step 2: Document Findings & Write Tests**
|
|
42
|
-
```yaml
|
|
43
|
-
# Document discovery results as comments
|
|
44
|
-
# Discovery: npx aegis query search_sfcc_classes 'query:catalog'
|
|
45
|
-
# Success: ["dw.catalog.Product", "dw.catalog.Catalog"] (simple array)
|
|
46
|
-
# Empty: [] (empty array)
|
|
47
|
-
# Error: {"content": [{"type": "text", "text": "Error: ..."}], "isError": true}
|
|
48
|
-
|
|
49
|
-
- it: "should return class array"
|
|
50
|
-
expect:
|
|
51
|
-
response:
|
|
52
|
-
result:
|
|
53
|
-
text: "match:regex:\\[[\\s\\S]*\\]" # Based on actual format
|
|
54
|
-
text: "match:contains:dw.catalog" # Contains expected content
|
|
55
|
-
```
|
|
56
|
-
|
|
57
|
-
**Step 3: Common Discovery Patterns**
|
|
10
|
+
**Golden Rule**: Always discover response formats first:
|
|
58
11
|
```bash
|
|
59
|
-
|
|
60
|
-
npx aegis query list_tools --config "config.json"
|
|
61
|
-
# → ["tool1", "tool2"] → YAML: text: "match:regex:\\[[\\s\\S]*\\]"
|
|
62
|
-
|
|
63
|
-
npx aegis query search_nothing 'query:zzznothingfound' --config "config.json"
|
|
64
|
-
# → [] → YAML: text: "match:regex:^\\[\\s*\\]$"
|
|
65
|
-
|
|
66
|
-
npx aegis query invalid_tool 'bad:params' --config "config.json"
|
|
67
|
-
# → {"content": [...], "isError": true} → YAML: text: "match:contains:Error"
|
|
68
|
-
```
|
|
69
|
-
|
|
70
|
-
## Configuration & Basic Usage
|
|
71
|
-
|
|
72
|
-
### Required Configuration (`*.config.json`)
|
|
73
|
-
```json
|
|
74
|
-
{
|
|
75
|
-
"name": "My MCP Server", // Human-readable name for reports
|
|
76
|
-
"command": "node", // Executable (node, python, ./binary)
|
|
77
|
-
"args": ["./server.js"], // Arguments array
|
|
78
|
-
"cwd": "./optional/directory", // Working directory (optional)
|
|
79
|
-
"env": {"CUSTOM_VAR": "value"}, // Environment variables (optional)
|
|
80
|
-
"startupTimeout": 5000, // Max startup wait (ms, default: 10000)
|
|
81
|
-
"readyPattern": "Server ready" // Stderr regex for ready state (optional)
|
|
82
|
-
}
|
|
83
|
-
```
|
|
84
|
-
|
|
85
|
-
### Common Configurations
|
|
86
|
-
```json
|
|
87
|
-
// Node.js Server
|
|
88
|
-
{"name": "Node.js MCP", "command": "node", "args": ["./dist/index.js"], "startupTimeout": 5000}
|
|
89
|
-
|
|
90
|
-
// Python Server
|
|
91
|
-
{"name": "Python MCP", "command": "python", "args": ["-m", "my_mcp_server"], "env": {"PYTHONPATH": "./src"}}
|
|
92
|
-
|
|
93
|
-
// Development Server
|
|
94
|
-
{"name": "Dev Server", "command": "npm", "args": ["run", "dev"], "startupTimeout": 15000}
|
|
95
|
-
```
|
|
96
|
-
### Basic Test Structure (`*.test.mcp.yml`)
|
|
97
|
-
```yaml
|
|
98
|
-
description: "Test suite description"
|
|
99
|
-
tests:
|
|
100
|
-
- it: "Test description"
|
|
101
|
-
request:
|
|
102
|
-
jsonrpc: "2.0"
|
|
103
|
-
id: "unique-id"
|
|
104
|
-
method: "tools/list|tools/call"
|
|
105
|
-
params: {} # or tool call params
|
|
106
|
-
expect:
|
|
107
|
-
response:
|
|
108
|
-
jsonrpc: "2.0"
|
|
109
|
-
id: "unique-id"
|
|
110
|
-
result: {} # expected response
|
|
111
|
-
stderr: "toBeEmpty" # optional
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
### Execute Tests
|
|
115
|
-
```bash
|
|
116
|
-
# 🥇 GOLDEN RULE: ALWAYS discover response formats first!
|
|
117
|
-
# Before writing any test, run these discovery commands:
|
|
118
|
-
npx aegis query [tool_name] '[success_params]' --config "config.json"
|
|
119
|
-
npx aegis query [tool_name] '[failure_params]' --config "config.json"
|
|
120
|
-
|
|
121
|
-
# Then run your tests based on discovered formats
|
|
122
|
-
npx aegis "tests/**/*.test.mcp.yml" --config "config.json"
|
|
123
|
-
npx aegis "tests/*.yml" --config "config.json" --verbose --filter "tools"
|
|
124
|
-
```
|
|
125
|
-
|
|
126
|
-
## Parameter Formats: Pipe vs JSON
|
|
127
|
-
|
|
128
|
-
### Pipe Format (Recommended for CLI)
|
|
129
|
-
```bash
|
|
130
|
-
# Simple: No parameters
|
|
131
|
-
npx aegis query get_code_versions --config "config.json"
|
|
132
|
-
|
|
133
|
-
# Simple: key:value|other:123
|
|
134
|
-
npx aegis query read_file 'path:test.txt' --config "config.json"
|
|
135
|
-
|
|
136
|
-
# Nested via dot notation: config.host:localhost|config.port:8080
|
|
137
|
-
npx aegis query api_client 'config.host:localhost|config.port:8080|timeout:30' --config "config.json"
|
|
138
|
-
|
|
139
|
-
# Method syntax: name:tool|arguments.key:value
|
|
140
|
-
npx aegis query --method tools/call --params 'name:read_file|arguments.path:test.txt' --config "config.json"
|
|
12
|
+
npx aegis query [tool_name] '[params]' --config ./aegis.config.docs-only.json
|
|
141
13
|
```
|
|
142
14
|
|
|
143
|
-
|
|
15
|
+
**Test Execution**:
|
|
144
16
|
```bash
|
|
145
|
-
|
|
17
|
+
npm run test:mcp:yaml # docs-only mode
|
|
18
|
+
npm run test:mcp:yaml:full # full mode with credentials
|
|
146
19
|
```
|
|
147
20
|
|
|
148
|
-
**
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
```yaml
|
|
154
|
-
# 1. DEEP EQUALITY (default) - Exact match
|
|
155
|
-
result: {tools: [{name: "read_file", description: "Reads a file"}]}
|
|
156
|
-
|
|
157
|
-
# 2. TYPE VALIDATION
|
|
158
|
-
result:
|
|
159
|
-
tools: "match:type:array"
|
|
160
|
-
count: "match:type:number"
|
|
161
|
-
name: "match:type:string"
|
|
162
|
-
|
|
163
|
-
# 3. STRING PATTERNS
|
|
164
|
-
result:
|
|
165
|
-
text: "match:contains:substring"
|
|
166
|
-
name: "match:startsWith:prefix"
|
|
167
|
-
file: "match:endsWith:.txt"
|
|
168
|
-
pattern: "match:regex:\\d{4}-\\d{2}-\\d{2}" # YAML: escape backslashes
|
|
169
|
-
|
|
170
|
-
# String length validation
|
|
171
|
-
title: "match:stringLength:10" # Exactly 10 characters
|
|
172
|
-
description: "match:stringLengthGreaterThan:5" # More than 5 chars
|
|
173
|
-
summary: "match:stringLengthLessThan:100" # Less than 100 chars
|
|
174
|
-
content: "match:stringLengthBetween:10:200" # Between 10-200 chars
|
|
175
|
-
error: "match:stringEmpty" # Must be empty
|
|
176
|
-
text: "match:stringNotEmpty" # Must not be empty
|
|
177
|
-
|
|
178
|
-
# 4. ARRAY PATTERNS
|
|
179
|
-
result:
|
|
180
|
-
tools: "match:arrayLength:3"
|
|
181
|
-
data: "match:arrayContains:value"
|
|
182
|
-
tools: "match:arrayContains:name:read_file" # Object field matching
|
|
183
|
-
tools:
|
|
184
|
-
match:arrayElements: # All elements must match
|
|
185
|
-
name: "match:type:string"
|
|
186
|
-
description: "match:contains:tool"
|
|
187
|
-
|
|
188
|
-
# 5. FIELD EXTRACTION (dot notation)
|
|
189
|
-
result:
|
|
190
|
-
match:extractField: "tools.*.name" # Extract all tool names
|
|
191
|
-
value: ["read_file", "write_file"]
|
|
192
|
-
|
|
193
|
-
# 6. NUMERIC COMPARISONS
|
|
194
|
-
result:
|
|
195
|
-
count: "match:greaterThan:5"
|
|
196
|
-
price: "match:lessThanOrEqual:100.50"
|
|
197
|
-
amount: "match:greaterThanOrEqual:0"
|
|
198
|
-
score: "match:between:0:100"
|
|
199
|
-
exact: "match:equals:42"
|
|
200
|
-
not_equal: "match:notEquals:0"
|
|
201
|
-
approximate: "match:approximately:3.14159:0.001" # tolerance
|
|
202
|
-
decimal: "match:decimalPlaces:2" # exactly 2 decimal places
|
|
203
|
-
multiple: "match:multipleOf:5" # divisible by 5
|
|
204
|
-
|
|
205
|
-
# 7. DATE/TIMESTAMP PATTERNS
|
|
206
|
-
result:
|
|
207
|
-
createdAt: "match:dateValid"
|
|
208
|
-
publishDate: "match:dateAfter:2023-01-01"
|
|
209
|
-
expireDate: "match:dateBefore:2025-01-01"
|
|
210
|
-
eventDate: "match:dateBetween:2023-01-01:2024-12-31"
|
|
211
|
-
lastUpdate: "match:dateAge:1d" # within last day
|
|
212
|
-
|
|
213
|
-
# 8. CROSS-FIELD VALIDATION
|
|
214
|
-
result:
|
|
215
|
-
"match:crossField": "price > minPrice" # Field comparison
|
|
216
|
-
"match:crossField": "endDate >= startDate"
|
|
217
|
-
|
|
218
|
-
# 9. PATTERN NEGATION (prefix with "not:")
|
|
219
|
-
result:
|
|
220
|
-
tools: "match:not:arrayLength:0" # NOT empty
|
|
221
|
-
text: "match:not:contains:error" # NOT containing error
|
|
222
|
-
|
|
223
|
-
# 10. PARTIAL MATCHING
|
|
224
|
-
result:
|
|
225
|
-
match:partial: # Only check specified fields
|
|
226
|
-
tools:
|
|
227
|
-
- name: "read_file"
|
|
228
|
-
description: "match:contains:Reads"
|
|
229
|
-
|
|
230
|
-
# 11. COMBINED PATTERNS - arrayElements + partial (POWERFUL!)
|
|
231
|
-
result:
|
|
232
|
-
tools:
|
|
233
|
-
match:arrayElements: # Apply to ALL array elements
|
|
234
|
-
match:partial: # But only validate specified fields
|
|
235
|
-
name: "match:regex:^[a-z_]+$"
|
|
236
|
-
description: "match:contains:tool"
|
|
237
|
-
# Ignores any other fields like inputSchema, etc.
|
|
238
|
-
|
|
239
|
-
# 12. ADVANCED PATTERNS
|
|
240
|
-
result:
|
|
241
|
-
email: "match:regex:[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}"
|
|
242
|
-
name: "match:equalsIgnoreCase:Hello World"
|
|
243
|
-
text: "match:containsIgnoreCase:ERROR"
|
|
244
|
-
value: "match:range:0:100" # Between 0-100 inclusive
|
|
245
|
-
score: "match:between:60:90" # Between 60-90 exclusive
|
|
246
|
-
match:extractField: "tools.*.inputSchema.properties.*.type"
|
|
247
|
-
value: ["string", "number", "object"]
|
|
248
|
-
```
|
|
249
|
-
|
|
250
|
-
## YAML Syntax Rules & Real-World Examples
|
|
251
|
-
|
|
252
|
-
### ❌ Common Errors to Avoid
|
|
253
|
-
```yaml
|
|
254
|
-
# WRONG - Duplicate YAML keys (overwrites previous)
|
|
255
|
-
result:
|
|
256
|
-
tools: "match:arrayLength:1"
|
|
257
|
-
tools: ["read_file"] # OVERWRITES above line!
|
|
258
|
-
|
|
259
|
-
# WRONG - Invalid escaping in regex
|
|
260
|
-
result:
|
|
261
|
-
text: "match:regex:\d+" # Missing double backslash
|
|
262
|
-
|
|
263
|
-
# WRONG - Mixing patterns in same object
|
|
264
|
-
result:
|
|
265
|
-
tools: "match:arrayLength:1"
|
|
266
|
-
match:extractField: "tools.*.name" # Can't mix in same object
|
|
267
|
-
```
|
|
268
|
-
|
|
269
|
-
### ✅ Correct Best Practices
|
|
270
|
-
```yaml
|
|
271
|
-
# CORRECT - Separate pattern validations into different tests
|
|
272
|
-
- it: "should have exactly one tool"
|
|
273
|
-
expect:
|
|
274
|
-
response:
|
|
275
|
-
result:
|
|
276
|
-
tools: "match:arrayLength:1"
|
|
277
|
-
|
|
278
|
-
- it: "should extract correct tool name"
|
|
279
|
-
expect:
|
|
280
|
-
response:
|
|
281
|
-
result:
|
|
282
|
-
match:extractField: "tools.*.name"
|
|
283
|
-
value: ["read_file"]
|
|
284
|
-
|
|
285
|
-
# CORRECT - Proper regex escaping in YAML
|
|
286
|
-
result:
|
|
287
|
-
text: "match:regex:\\d{4}-\\d{2}-\\d{2}" # Double backslashes
|
|
288
|
-
|
|
289
|
-
# CORRECT - Flexible arrayElements with partial matching
|
|
290
|
-
result:
|
|
291
|
-
tools:
|
|
292
|
-
match:arrayElements:
|
|
293
|
-
match:partial: # 🔥 Only validate what matters, ignore extra fields
|
|
294
|
-
name: "match:regex:^[a-z][a-z0-9_]*$"
|
|
295
|
-
description: "match:regex:.{10,}"
|
|
296
|
-
```
|
|
297
|
-
|
|
298
|
-
### Real-World Test Examples
|
|
299
|
-
|
|
300
|
-
#### Tool Discovery Test
|
|
301
|
-
```yaml
|
|
302
|
-
- it: "should list available tools with correct structure"
|
|
303
|
-
request:
|
|
304
|
-
jsonrpc: "2.0"
|
|
305
|
-
id: "list-1"
|
|
306
|
-
method: "tools/list"
|
|
307
|
-
params: {}
|
|
308
|
-
expect:
|
|
309
|
-
response:
|
|
310
|
-
jsonrpc: "2.0"
|
|
311
|
-
id: "list-1"
|
|
312
|
-
result:
|
|
313
|
-
tools:
|
|
314
|
-
match:arrayElements:
|
|
315
|
-
match:partial: # Flexible - recommended approach
|
|
316
|
-
name: "match:regex:^[a-z][a-z0-9_]*$" # snake_case
|
|
317
|
-
description: "match:regex:.{10,}" # min 10 chars
|
|
318
|
-
```
|
|
319
|
-
|
|
320
|
-
#### Tool Execution Test
|
|
321
|
-
```yaml
|
|
322
|
-
- it: "should execute tool successfully"
|
|
323
|
-
request:
|
|
324
|
-
jsonrpc: "2.0"
|
|
325
|
-
id: "exec-1"
|
|
326
|
-
method: "tools/call"
|
|
327
|
-
params:
|
|
328
|
-
name: "read_file"
|
|
329
|
-
arguments:
|
|
330
|
-
path: "test.txt"
|
|
331
|
-
expect:
|
|
332
|
-
response:
|
|
333
|
-
jsonrpc: "2.0"
|
|
334
|
-
id: "exec-1"
|
|
335
|
-
result:
|
|
336
|
-
content:
|
|
337
|
-
- type: "text"
|
|
338
|
-
text: "match:contains:expected content"
|
|
339
|
-
isError: false
|
|
340
|
-
stderr: "toBeEmpty"
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
#### Error Handling Test
|
|
344
|
-
```yaml
|
|
345
|
-
- it: "should handle invalid file gracefully"
|
|
346
|
-
request:
|
|
347
|
-
jsonrpc: "2.0"
|
|
348
|
-
id: "error-1"
|
|
349
|
-
method: "tools/call"
|
|
350
|
-
params:
|
|
351
|
-
name: "read_file"
|
|
352
|
-
arguments:
|
|
353
|
-
path: "nonexistent.txt"
|
|
354
|
-
expect:
|
|
355
|
-
response:
|
|
356
|
-
jsonrpc: "2.0"
|
|
357
|
-
id: "error-1"
|
|
358
|
-
result:
|
|
359
|
-
content:
|
|
360
|
-
- type: "text"
|
|
361
|
-
text: "match:contains:not found"
|
|
362
|
-
isError: true
|
|
363
|
-
```
|
|
364
|
-
|
|
365
|
-
#### Performance Testing with SLA Validation
|
|
366
|
-
```yaml
|
|
367
|
-
- it: "should meet performance SLA"
|
|
368
|
-
request:
|
|
369
|
-
jsonrpc: "2.0"
|
|
370
|
-
id: "perf-1"
|
|
371
|
-
method: "tools/call"
|
|
372
|
-
params:
|
|
373
|
-
name: "search_tools"
|
|
374
|
-
arguments:
|
|
375
|
-
category: "documentation"
|
|
376
|
-
expect:
|
|
377
|
-
response:
|
|
378
|
-
result:
|
|
379
|
-
tools:
|
|
380
|
-
match:arrayElements:
|
|
381
|
-
match:partial:
|
|
382
|
-
name: "match:regex:^[a-z][a-z0-9_]*$"
|
|
383
|
-
description: "match:regex:.{10,}"
|
|
384
|
-
count: "match:type:number"
|
|
385
|
-
performance:
|
|
386
|
-
maxResponseTime: "1500ms" # SLA requirement
|
|
387
|
-
stderr: "toBeEmpty"
|
|
388
|
-
```
|
|
389
|
-
|
|
390
|
-
## CLI Commands & Interactive Testing
|
|
391
|
-
|
|
392
|
-
### Test Execution
|
|
393
|
-
```bash
|
|
394
|
-
# Basic testing
|
|
395
|
-
npx aegis "tests/**/*.test.mcp.yml" --config "config.json"
|
|
396
|
-
|
|
397
|
-
# Debug modes & filtering
|
|
398
|
-
npx aegis "tests/*.yml" --config "config.json" --verbose --debug --timing
|
|
399
|
-
npx aegis "tests/*.yml" --config "config.json" --errors-only --filter "tools"
|
|
400
|
-
npx aegis "tests/*.yml" --config "config.json" --filter "should validate" --json
|
|
401
|
-
```
|
|
21
|
+
**Common Patterns**:
|
|
22
|
+
- `"match:contains:substring"` - Contains text
|
|
23
|
+
- `"match:regex:\\d+"` - Regex (double-escape backslashes)
|
|
24
|
+
- `"match:type:array"` - Type validation
|
|
25
|
+
- `"match:arrayElements:"` with `"match:partial:"` - Flexible array validation
|
|
402
26
|
|
|
403
|
-
|
|
404
|
-
```bash
|
|
405
|
-
# List all tools
|
|
406
|
-
npx aegis query --config "config.json"
|
|
407
|
-
|
|
408
|
-
# Pipe format (recommended) - ALWAYS test success AND failure
|
|
409
|
-
npx aegis query read_file 'path:test.txt' --config "config.json" # Success case
|
|
410
|
-
npx aegis query read_file 'path:nonexistent.txt' --config "config.json" # Failure case
|
|
411
|
-
|
|
412
|
-
# JSON format for complex structures
|
|
413
|
-
npx aegis query complex_tool '{"config": {"host": "localhost"}, "data": [1,2,3]}' --config "config.json"
|
|
414
|
-
|
|
415
|
-
# Discovery examples for edge cases
|
|
416
|
-
npx aegis query search_tool 'query:' --config "config.json" # Empty input
|
|
417
|
-
npx aegis query search_tool 'query:zzznothingfound' --config "config.json" # No results
|
|
418
|
-
```
|
|
419
|
-
|
|
420
|
-
### Performance Testing Guidelines
|
|
421
|
-
| Operation Type | Recommended Timeout | Use Case |
|
|
422
|
-
|----------------|-------------------|----------|
|
|
423
|
-
| Tool Listing | `200-500ms` | Metadata operations |
|
|
424
|
-
| Simple File Ops | `1000ms` | Basic I/O |
|
|
425
|
-
| Complex Operations | `2000ms` | Search, computation |
|
|
426
|
-
| Error Responses | `800ms` | Should be faster than success |
|
|
427
|
-
| Heavy Operations | `5000ms` | Database, large files |
|
|
428
|
-
|
|
429
|
-
**Always use `--timing` flag** to see actual response times and adjust expectations.
|
|
430
|
-
|
|
431
|
-
## Pattern Selection Guide & Advanced Combinations
|
|
432
|
-
|
|
433
|
-
### When to Use Each Pattern
|
|
434
|
-
- **Deep Equality**: Exact value matching (default)
|
|
435
|
-
- **Type Validation**: Verify data types (`match:type:`)
|
|
436
|
-
- **String Patterns**: Text validation (`contains`, `startsWith`, `endsWith`, `regex`, `stringLength`)
|
|
437
|
-
- **Array Patterns**: Array validation (`arrayLength`, `arrayContains`, `arrayElements`)
|
|
438
|
-
- **Field Extraction**: Extract nested values (`match:extractField`)
|
|
439
|
-
- **Numeric**: Math comparisons (`greaterThan`, `approximately`, `decimalPlaces`)
|
|
440
|
-
- **Date/Time**: Date validation (`dateValid`, `dateAfter`, `dateAge`)
|
|
441
|
-
- **Cross-Field**: Compare fields (`match:crossField`)
|
|
442
|
-
- **Negation**: Exclude patterns (`match:not:*`)
|
|
443
|
-
- **Partial**: Subset validation (`match:partial`)
|
|
444
|
-
- **🔥 Combined arrayElements + partial**: Validate specific fields across ALL array elements while ignoring others - extremely powerful for flexible schema validation!
|
|
445
|
-
|
|
446
|
-
### Multi-Step Validation Pattern (Recommended)
|
|
447
|
-
```yaml
|
|
448
|
-
# Test 1: Basic structure
|
|
449
|
-
- it: "should return array of tools"
|
|
450
|
-
expect:
|
|
451
|
-
response:
|
|
452
|
-
result:
|
|
453
|
-
tools: "match:type:array"
|
|
454
|
-
|
|
455
|
-
# Test 2: Array length
|
|
456
|
-
- it: "should have expected number of tools"
|
|
457
|
-
expect:
|
|
458
|
-
response:
|
|
459
|
-
result:
|
|
460
|
-
tools: "match:arrayLength:3"
|
|
461
|
-
|
|
462
|
-
# Test 3: Extract and validate specific fields
|
|
463
|
-
- it: "should have correct tool names"
|
|
464
|
-
expect:
|
|
465
|
-
response:
|
|
466
|
-
result:
|
|
467
|
-
match:extractField: "tools.*.name"
|
|
468
|
-
value: ["read_file", "write_file", "list_files"]
|
|
469
|
-
```
|
|
470
|
-
|
|
471
|
-
### Comprehensive Tool Validation (Best Practice)
|
|
472
|
-
```yaml
|
|
473
|
-
- it: "should validate tools with flexible schema handling"
|
|
474
|
-
expect:
|
|
475
|
-
response:
|
|
476
|
-
result:
|
|
477
|
-
tools:
|
|
478
|
-
match:arrayElements:
|
|
479
|
-
match:partial: # 🔥 RECOMMENDED: Combines power with flexibility
|
|
480
|
-
name: "match:regex:^[a-z][a-z0-9_]*$" # snake_case names
|
|
481
|
-
description: "match:regex:.{10,200}" # 10-200 chars
|
|
482
|
-
inputSchema:
|
|
483
|
-
type: "object"
|
|
484
|
-
properties: "match:type:object"
|
|
485
|
-
```
|
|
486
|
-
|
|
487
|
-
## MCP Protocol Basics
|
|
488
|
-
|
|
489
|
-
### Standard JSON-RPC 2.0 Methods
|
|
490
|
-
|
|
491
|
-
#### Initialize Request (Required for handshake)
|
|
492
|
-
```yaml
|
|
493
|
-
request:
|
|
494
|
-
jsonrpc: "2.0"
|
|
495
|
-
id: "init-1"
|
|
496
|
-
method: "initialize"
|
|
497
|
-
params:
|
|
498
|
-
protocolVersion: "2025-06-18"
|
|
499
|
-
capabilities: {"tools": {}}
|
|
500
|
-
clientInfo: {"name": "MCP Aegis", "version": "1.0.0"}
|
|
501
|
-
```
|
|
502
|
-
|
|
503
|
-
#### Tools List Request
|
|
504
|
-
```yaml
|
|
505
|
-
request:
|
|
506
|
-
jsonrpc: "2.0"
|
|
507
|
-
id: "list-1"
|
|
508
|
-
method: "tools/list"
|
|
509
|
-
params: {}
|
|
510
|
-
```
|
|
511
|
-
|
|
512
|
-
#### Tool Call Request
|
|
513
|
-
```yaml
|
|
514
|
-
request:
|
|
515
|
-
jsonrpc: "2.0"
|
|
516
|
-
id: "call-1"
|
|
517
|
-
method: "tools/call"
|
|
518
|
-
params:
|
|
519
|
-
name: "tool_name"
|
|
520
|
-
arguments:
|
|
521
|
-
key: "value"
|
|
522
|
-
```
|
|
523
|
-
|
|
524
|
-
### Standard Response Structure
|
|
525
|
-
```yaml
|
|
526
|
-
expect:
|
|
527
|
-
response:
|
|
528
|
-
jsonrpc: "2.0"
|
|
529
|
-
id: "matching-request-id"
|
|
530
|
-
result: # For successful responses
|
|
531
|
-
# Response data
|
|
532
|
-
# OR for errors:
|
|
533
|
-
error:
|
|
534
|
-
code: -32601 # Standard JSON-RPC error codes
|
|
535
|
-
message: "Method not found"
|
|
536
|
-
stderr: "toBeEmpty" # Optional stderr validation
|
|
537
|
-
```
|
|
538
|
-
|
|
539
|
-
## MCP Protocol Basics & Troubleshooting
|
|
540
|
-
|
|
541
|
-
### Standard JSON-RPC 2.0 Methods
|
|
542
|
-
```yaml
|
|
543
|
-
# Initialize Request (Required for handshake)
|
|
544
|
-
request:
|
|
545
|
-
jsonrpc: "2.0"
|
|
546
|
-
id: "init-1"
|
|
547
|
-
method: "initialize"
|
|
548
|
-
params:
|
|
549
|
-
protocolVersion: "2025-06-18"
|
|
550
|
-
capabilities: {"tools": {}}
|
|
551
|
-
clientInfo: {"name": "MCP Aegis", "version": "1.0.0"}
|
|
552
|
-
|
|
553
|
-
# Tools List Request
|
|
554
|
-
request:
|
|
555
|
-
jsonrpc: "2.0"
|
|
556
|
-
id: "list-1"
|
|
557
|
-
method: "tools/list"
|
|
558
|
-
params: {}
|
|
559
|
-
|
|
560
|
-
# Tool Call Request
|
|
561
|
-
request:
|
|
562
|
-
jsonrpc: "2.0"
|
|
563
|
-
id: "call-1"
|
|
564
|
-
method: "tools/call"
|
|
565
|
-
params:
|
|
566
|
-
name: "tool_name"
|
|
567
|
-
arguments:
|
|
568
|
-
key: "value"
|
|
569
|
-
|
|
570
|
-
# Standard Response Structure
|
|
571
|
-
expect:
|
|
572
|
-
response:
|
|
573
|
-
jsonrpc: "2.0"
|
|
574
|
-
id: "matching-request-id"
|
|
575
|
-
result: {} # For successful responses
|
|
576
|
-
# OR for errors:
|
|
577
|
-
error:
|
|
578
|
-
code: -32601 # Standard JSON-RPC error codes
|
|
579
|
-
message: "Method not found"
|
|
580
|
-
stderr: "toBeEmpty" # Optional stderr validation
|
|
581
|
-
```
|
|
582
|
-
|
|
583
|
-
## Quick Debugging Workflow
|
|
584
|
-
|
|
585
|
-
### 🥇 Discovery-First Development (Essential)
|
|
586
|
-
|
|
587
|
-
**Before ANY test writing, run discovery commands:**
|
|
588
|
-
```bash
|
|
589
|
-
# Success case
|
|
590
|
-
npx aegis query [tool_name] '[valid_params]' --config "config.json"
|
|
591
|
-
# Failure case
|
|
592
|
-
npx aegis query [tool_name] '[invalid_params]' --config "config.json"
|
|
593
|
-
```
|
|
594
|
-
|
|
595
|
-
### Common Issues & Solutions
|
|
596
|
-
|
|
597
|
-
#### Server Won't Start
|
|
598
|
-
```bash
|
|
599
|
-
npx aegis "test.yml" --config "config.json" --debug # Check startup issues
|
|
600
|
-
# Increase startupTimeout if server is slow
|
|
601
|
-
# Verify command/args in config are correct
|
|
602
|
-
```
|
|
603
|
-
|
|
604
|
-
#### Pattern Not Matching
|
|
605
|
-
```yaml
|
|
606
|
-
# ❌ WRONG - Assuming structure without discovery
|
|
607
|
-
- it: "should return tools object"
|
|
608
|
-
expect:
|
|
609
|
-
response:
|
|
610
|
-
result:
|
|
611
|
-
tools: "match:arrayLength:3" # Assumes 'tools' field exists
|
|
612
|
-
count: "match:type:number" # Assumes 'count' field exists
|
|
613
|
-
|
|
614
|
-
# ✅ CORRECT - Based on actual npx aegis query discovery
|
|
615
|
-
# First run: npx aegis query list_tools --config "config.json"
|
|
616
|
-
# Result: ["tool1", "tool2", "tool3"] # Simple array, no wrapper object!
|
|
617
|
-
- it: "should return tools array"
|
|
618
|
-
expect:
|
|
619
|
-
response:
|
|
620
|
-
result:
|
|
621
|
-
text: "match:regex:\\[[\\s\\S]*\\]" # Match JSON array format
|
|
622
|
-
text: "match:contains:tool1" # Check content exists
|
|
623
|
-
```
|
|
624
|
-
|
|
625
|
-
#### Regex Patterns Failing
|
|
626
|
-
```yaml
|
|
627
|
-
# YAML requires double escaping backslashes
|
|
628
|
-
text: "match:regex:\\d+" # ✅ Correct
|
|
629
|
-
text: "match:regex:\d+" # ❌ Wrong
|
|
630
|
-
```
|
|
631
|
-
|
|
632
|
-
#### Array Pattern Issues
|
|
633
|
-
```yaml
|
|
634
|
-
# ❌ Duplicate YAML keys (overwrites previous)
|
|
635
|
-
result:
|
|
636
|
-
tools: "match:arrayLength:1"
|
|
637
|
-
tools: ["exact_tool"] # OVERWRITES above!
|
|
638
|
-
|
|
639
|
-
# ✅ Use flexible arrayElements with partial matching instead
|
|
640
|
-
result:
|
|
641
|
-
tools:
|
|
642
|
-
match:arrayElements:
|
|
643
|
-
match:partial: # Only validate what you care about
|
|
644
|
-
name: "match:type:string"
|
|
645
|
-
description: "match:type:string"
|
|
646
|
-
```
|
|
647
|
-
|
|
648
|
-
### 2. Test Filtering for Focus Development
|
|
649
|
-
```bash
|
|
650
|
-
# Filter by suite/test description (case-insensitive)
|
|
651
|
-
npx aegis "tests/**/*.yml" --config "config.json" --filter "Tools validation"
|
|
652
|
-
npx aegis "tests/**/*.yml" --config "config.json" --filter "should handle errors"
|
|
653
|
-
|
|
654
|
-
# Use regex patterns for advanced filtering
|
|
655
|
-
npx aegis "tests/**/*.yml" --config "config.json" --filter "/should (read|write|validate)/"
|
|
656
|
-
|
|
657
|
-
# Combine with debugging options
|
|
658
|
-
npx aegis "tests/**/*.yml" --config "config.json" --filter "tools" --errors-only --timing
|
|
659
|
-
```
|
|
660
|
-
|
|
661
|
-
### 3. Pipe Format Quick Reference
|
|
662
|
-
```bash
|
|
663
|
-
# Basic syntax: key:value|other:123
|
|
664
|
-
'path:test.txt|encoding:utf8'
|
|
665
|
-
|
|
666
|
-
# Nested objects: config.host:localhost|config.port:8080
|
|
667
|
-
'database.host:localhost|database.port:5432|cache.enabled:true'
|
|
668
|
-
|
|
669
|
-
# Auto data types: text:hello|count:42|enabled:true|data:null
|
|
670
|
-
'operation:add|a:5|b:3|precise:true'
|
|
671
|
-
|
|
672
|
-
# JSON values within pipe: simple:value|complex:{"nested":"object"}
|
|
673
|
-
'metadata:{"version":"1.0"}|tags:["test","demo"]|count:5'
|
|
674
|
-
```
|
|
675
|
-
|
|
676
|
-
### 3. Pipe Format Quick Reference
|
|
677
|
-
```bash
|
|
678
|
-
# Basic: key:value|other:123
|
|
679
|
-
'path:test.txt|encoding:utf8'
|
|
680
|
-
|
|
681
|
-
# Discovery examples:
|
|
682
|
-
'query:catalog|limit:10' # Success case
|
|
683
|
-
'query:zzznothingfound' # No results
|
|
684
|
-
'query:' # Validation error
|
|
685
|
-
'fileName:nonexistent.txt' # File not found
|
|
686
|
-
```
|
|
687
|
-
|
|
688
|
-
### 4. Performance Testing Guidelines
|
|
689
|
-
- **Tool Listing**: 200-500ms (metadata - should be fast)
|
|
690
|
-
- **Simple File Ops**: 1000ms (basic I/O operations)
|
|
691
|
-
- **Complex Operations**: 2000ms (search, computation, API calls)
|
|
692
|
-
- **Error Responses**: 800ms (often faster than successful operations)
|
|
693
|
-
- **Heavy Operations**: 5000ms (database queries, large file processing)
|
|
694
|
-
|
|
695
|
-
Use `--timing` flag to see actual response times and adjust expectations based on your environment.
|
|
696
|
-
|
|
697
|
-
## Complete Pattern Reference (35+ Patterns)
|
|
698
|
-
|
|
699
|
-
```yaml
|
|
700
|
-
# STRING PATTERNS
|
|
701
|
-
"match:contains:substring"
|
|
702
|
-
"match:startsWith:prefix"
|
|
703
|
-
"match:endsWith:suffix"
|
|
704
|
-
"match:containsIgnoreCase:TEXT"
|
|
705
|
-
"match:equalsIgnoreCase:value"
|
|
706
|
-
"match:regex:pattern"
|
|
707
|
-
"match:stringLength:10"
|
|
708
|
-
"match:stringLengthGreaterThan:5"
|
|
709
|
-
"match:stringLengthLessThan:100"
|
|
710
|
-
"match:stringLengthBetween:10:200"
|
|
711
|
-
"match:stringEmpty|stringNotEmpty"
|
|
712
|
-
|
|
713
|
-
# TYPE & STRUCTURE
|
|
714
|
-
"match:type:string|number|boolean|object|array"
|
|
715
|
-
"match:exists"
|
|
716
|
-
"match:length:5"
|
|
717
|
-
|
|
718
|
-
# NUMERIC PATTERNS
|
|
719
|
-
"match:greaterThan:10"
|
|
720
|
-
"match:lessThanOrEqual:50"
|
|
721
|
-
"match:between:10:90"
|
|
722
|
-
"match:equals:42"
|
|
723
|
-
"match:notEquals:0"
|
|
724
|
-
"match:approximately:3.14:0.01"
|
|
725
|
-
"match:multipleOf:5"
|
|
726
|
-
"match:decimalPlaces:2"
|
|
727
|
-
|
|
728
|
-
# ARRAY PATTERNS
|
|
729
|
-
"match:arrayLength:3"
|
|
730
|
-
"match:arrayContains:value"
|
|
731
|
-
match:arrayElements:
|
|
732
|
-
field: "match:type:string"
|
|
733
|
-
|
|
734
|
-
# DATE PATTERNS
|
|
735
|
-
"match:dateValid"
|
|
736
|
-
"match:dateAfter:2023-01-01"
|
|
737
|
-
"match:dateBetween:2023-01-01:2024-12-31"
|
|
738
|
-
"match:dateAge:1d"
|
|
739
|
-
|
|
740
|
-
# ADVANCED PATTERNS
|
|
741
|
-
"match:crossField": "field1 > field2"
|
|
742
|
-
"match:not:pattern" # Negate any pattern
|
|
743
|
-
match:extractField: "path.*.field"
|
|
744
|
-
match:partial: # Check subset of fields
|
|
745
|
-
match:arrayElements: # Validate ALL array elements
|
|
746
|
-
match:partial: # 🔥 POWERFUL COMBO
|
|
747
|
-
field: "pattern"
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
### Installation & Getting Started
|
|
751
|
-
```bash
|
|
752
|
-
npm install -g mcp-aegis
|
|
753
|
-
npx aegis init # Create sample config and tests
|
|
754
|
-
npx aegis "tests/*.yml" --config "config.json"
|
|
755
|
-
```
|
|
27
|
+
For complete pattern reference and troubleshooting, see the skill file.
|