@mytechtoday/augment-extensions 0.7.0 → 1.2.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.
Files changed (483) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +109 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +11 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +120 -0
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  476. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  477. package/cli/dist/utils/extractCommandHelp.js +250 -0
  478. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  479. package/cli/dist/utils/install-rules.js +55 -55
  480. package/cli/dist/utils/mcp-integration.js +44 -44
  481. package/cli/dist/utils/rule-install-hooks.js +8 -8
  482. package/modules.md +667 -630
  483. package/package.json +85 -85
@@ -1,636 +1,636 @@
1
- # Hybrid MCP Guidelines
2
-
3
- ## Overview
4
-
5
- **Hybrid MCP** combines multiple memory types (token, state, vector, graph, compressed) to create sophisticated multi-memory architectures. This enables optimal context management across diverse use cases.
6
-
7
- **Key Challenge**: Orchestrating multiple memory systems with different characteristics, budgets, and retrieval patterns while maintaining coherence and performance.
8
-
9
- ---
10
-
11
- ## 1. Multi-Memory Architecture
12
-
13
- ### Memory Type Characteristics
14
-
15
- | Memory Type | Latency | Capacity | Precision | Cost | Use Case |
16
- |-------------|---------|----------|-----------|------|----------|
17
- | **Token** | Instant | Limited (200k) | Perfect | High | Immediate context |
18
- | **State** | Low | Medium | Perfect | Low | Session continuity |
19
- | **Vector** | Medium | High | Approximate | Medium | Semantic search |
20
- | **Graph** | Medium | High | Structured | Medium | Relationships |
21
- | **Compressed** | Low | High | Lossy | Low | Long-term memory |
22
-
23
- ### Architecture Patterns
24
-
25
- **Tiered Memory**:
26
-
27
- ```python
28
- class TieredMemory:
29
- """Multi-tier memory with hot/warm/cold storage"""
30
-
31
- def __init__(self):
32
- # Tier 1: Hot (token-based, immediate context)
33
- self.hot_memory = TokenMemory(max_tokens=4096)
34
-
35
- # Tier 2: Warm (state-based, session context)
36
- self.warm_memory = StateMemory()
37
-
38
- # Tier 3: Cold (vector-based, long-term knowledge)
39
- self.cold_memory = VectorMemory()
40
-
41
- def retrieve(self, query: str, token_budget=4096):
42
- """Retrieve from all tiers with budget allocation"""
43
- # Allocate budget across tiers
44
- hot_budget = int(token_budget * 0.5) # 50% for immediate context
45
- warm_budget = int(token_budget * 0.3) # 30% for session context
46
- cold_budget = int(token_budget * 0.2) # 20% for knowledge base
47
-
48
- # Retrieve from each tier
49
- hot_context = self.hot_memory.get_recent(hot_budget)
50
- warm_context = self.warm_memory.get_session(warm_budget)
51
- cold_context = self.cold_memory.search(query, cold_budget)
52
-
53
- # Combine contexts
54
- return self.merge_contexts(hot_context, warm_context, cold_context)
55
-
56
- def merge_contexts(self, hot, warm, cold):
57
- """Merge contexts with deduplication"""
58
- # Deduplicate and prioritize by tier
59
- seen = set()
60
- merged = []
61
-
62
- for context in [hot, warm, cold]:
63
- for item in context:
64
- key = self.get_key(item)
65
- if key not in seen:
66
- merged.append(item)
67
- seen.add(key)
68
-
69
- return merged
70
- ```
71
-
72
- **Specialized Memory**:
73
-
74
- ```python
75
- class SpecializedMemory:
76
- """Different memory types for different content"""
77
-
78
- def __init__(self):
79
- # Vector memory for documents
80
- self.document_memory = VectorMemory()
81
-
82
- # Graph memory for entities and relationships
83
- self.entity_memory = GraphMemory()
84
-
85
- # State memory for conversation
86
- self.conversation_memory = StateMemory()
87
-
88
- # Compressed memory for long-term history
89
- self.history_memory = CompressedMemory()
90
-
91
- def retrieve(self, query: str, query_type: str):
92
- """Route to appropriate memory based on query type"""
93
- if query_type == "factual":
94
- return self.document_memory.search(query)
95
- elif query_type == "relational":
96
- return self.entity_memory.traverse(query)
97
- elif query_type == "conversational":
98
- return self.conversation_memory.get_context()
99
- elif query_type == "historical":
100
- return self.history_memory.recall(query)
101
- else:
102
- # Hybrid retrieval
103
- return self.hybrid_retrieve(query)
104
- ```
105
-
106
- **Best Practices**:
107
- - Allocate token budget across memory types
108
- - Use tiered memory for general-purpose agents
109
- - Use specialized memory for domain-specific agents
110
- - Implement fallback strategies
111
-
112
- ---
113
-
114
- ## 2. Budget Allocation
115
-
116
- ### Static Allocation
117
-
118
- Fixed budget per memory type:
119
-
120
- ```python
121
- class StaticBudgetAllocator:
122
- """Fixed budget allocation across memory types"""
123
-
124
- def __init__(self, total_budget=4096):
125
- self.total_budget = total_budget
126
- self.allocations = {
127
- 'token': 0.4, # 40% for immediate context
128
- 'state': 0.2, # 20% for session state
129
- 'vector': 0.3, # 30% for semantic search
130
- 'graph': 0.1 # 10% for relationships
131
- }
132
-
133
- def allocate(self):
134
- """Return budget for each memory type"""
135
- return {
136
- memory_type: int(self.total_budget * ratio)
137
- for memory_type, ratio in self.allocations.items()
138
- }
139
- ```
140
-
141
- ### Dynamic Allocation
142
-
143
- Adaptive budget based on query:
144
-
145
- ```python
146
- class DynamicBudgetAllocator:
147
- """Adaptive budget allocation based on query characteristics"""
148
-
149
- def __init__(self, total_budget=4096):
150
- self.total_budget = total_budget
151
-
152
- def allocate(self, query: str, query_type: str):
153
- """Allocate budget based on query type"""
154
- if query_type == "factual":
155
- # Prioritize vector search
156
- return {
157
- 'token': int(self.total_budget * 0.2),
158
- 'vector': int(self.total_budget * 0.6),
159
- 'graph': int(self.total_budget * 0.2)
160
- }
161
- elif query_type == "conversational":
162
- # Prioritize conversation history
163
- return {
164
- 'token': int(self.total_budget * 0.5),
165
- 'state': int(self.total_budget * 0.4),
166
- 'vector': int(self.total_budget * 0.1)
167
- }
168
- elif query_type == "analytical":
169
- # Prioritize graph traversal
170
- return {
171
- 'token': int(self.total_budget * 0.2),
172
- 'graph': int(self.total_budget * 0.5),
173
- 'vector': int(self.total_budget * 0.3)
174
- }
175
- else:
176
- # Balanced allocation
177
- return {
178
- 'token': int(self.total_budget * 0.3),
179
- 'state': int(self.total_budget * 0.2),
180
- 'vector': int(self.total_budget * 0.3),
181
- 'graph': int(self.total_budget * 0.2)
182
- }
183
- ```
184
-
185
- **Best Practices**:
186
- - Start with static allocation for simplicity
187
- - Use dynamic allocation for complex agents
188
- - Monitor actual usage vs allocation
189
- - Adjust based on performance metrics
190
-
191
- ---
192
-
193
- ## 3. Orchestration Patterns
194
-
195
- ### Sequential Orchestration
196
-
197
- Retrieve from memory types in sequence:
198
-
199
- ```python
200
- class SequentialOrchestrator:
201
- """Retrieve from memory types sequentially"""
202
-
203
- def __init__(self, memories: dict):
204
- self.memories = memories
205
-
206
- def retrieve(self, query: str, budget_allocation: dict):
207
- """Retrieve sequentially with early stopping"""
208
- results = []
209
- total_tokens = 0
210
-
211
- # Define retrieval order
212
- order = ['token', 'state', 'vector', 'graph']
213
-
214
- for memory_type in order:
215
- if memory_type not in self.memories:
216
- continue
217
-
218
- budget = budget_allocation.get(memory_type, 0)
219
- if budget == 0:
220
- continue
221
-
222
- # Retrieve from this memory type
223
- memory_results = self.memories[memory_type].retrieve(query, budget)
224
-
225
- # Add to results
226
- for result in memory_results:
227
- result_tokens = count_tokens(result)
228
- if total_tokens + result_tokens <= sum(budget_allocation.values()):
229
- results.append(result)
230
- total_tokens += result_tokens
231
- else:
232
- # Budget exhausted
233
- return results
234
-
235
- return results
236
- ```
237
-
238
- ### Parallel Orchestration
239
-
240
- Retrieve from all memory types simultaneously:
241
-
242
- ```python
243
- import asyncio
244
-
245
- class ParallelOrchestrator:
246
- """Retrieve from memory types in parallel"""
247
-
248
- def __init__(self, memories: dict):
249
- self.memories = memories
250
-
251
- async def retrieve(self, query: str, budget_allocation: dict):
252
- """Retrieve in parallel and merge"""
253
- # Create retrieval tasks
254
- tasks = []
255
- for memory_type, memory in self.memories.items():
256
- budget = budget_allocation.get(memory_type, 0)
257
- if budget > 0:
258
- task = memory.retrieve_async(query, budget)
259
- tasks.append((memory_type, task))
260
-
261
- # Execute in parallel
262
- results_by_type = {}
263
- for memory_type, task in tasks:
264
- results_by_type[memory_type] = await task
265
-
266
- # Merge and deduplicate
267
- return self.merge_results(results_by_type, budget_allocation)
268
-
269
- def merge_results(self, results_by_type: dict, budget_allocation: dict):
270
- """Merge results with priority weighting"""
271
- merged = []
272
- seen = set()
273
-
274
- # Priority order
275
- priority = ['token', 'state', 'vector', 'graph']
276
-
277
- for memory_type in priority:
278
- if memory_type not in results_by_type:
279
- continue
280
-
281
- for result in results_by_type[memory_type]:
282
- key = self.get_key(result)
283
- if key not in seen:
284
- merged.append(result)
285
- seen.add(key)
286
-
287
- return merged
288
- ```
289
-
290
- ### Hierarchical Orchestration
291
-
292
- Use coarse-to-fine retrieval:
293
-
294
- ```python
295
- class HierarchicalOrchestrator:
296
- """Hierarchical retrieval with refinement"""
297
-
298
- def __init__(self, memories: dict):
299
- self.memories = memories
300
-
301
- def retrieve(self, query: str, budget_allocation: dict):
302
- """Retrieve hierarchically"""
303
- # Stage 1: Coarse retrieval (compressed memory)
304
- if 'compressed' in self.memories:
305
- coarse_results = self.memories['compressed'].retrieve(
306
- query,
307
- budget_allocation.get('compressed', 512)
308
- )
309
-
310
- # Extract relevant topics/entities
311
- topics = self.extract_topics(coarse_results)
312
- else:
313
- topics = [query]
314
-
315
- # Stage 2: Medium retrieval (vector memory)
316
- if 'vector' in self.memories:
317
- medium_results = []
318
- for topic in topics:
319
- results = self.memories['vector'].retrieve(
320
- topic,
321
- budget_allocation.get('vector', 2048) // len(topics)
322
- )
323
- medium_results.extend(results)
324
-
325
- # Extract specific entities
326
- entities = self.extract_entities(medium_results)
327
- else:
328
- entities = []
329
-
330
- # Stage 3: Fine retrieval (graph memory)
331
- if 'graph' in self.memories and entities:
332
- fine_results = self.memories['graph'].traverse(
333
- entities,
334
- budget_allocation.get('graph', 1024)
335
- )
336
- else:
337
- fine_results = []
338
-
339
- # Combine all stages
340
- return self.combine_stages(coarse_results, medium_results, fine_results)
341
- ```
342
-
343
- **Best Practices**:
344
- - Use sequential for simple agents
345
- - Use parallel for low-latency requirements
346
- - Use hierarchical for complex queries
347
- - Monitor latency and adjust
348
-
349
- ---
350
-
351
- ## 4. Conflict Resolution
352
-
353
- ### Deduplication
354
-
355
- Remove duplicate information:
356
-
357
- ```python
358
- def deduplicate_results(results: list, similarity_threshold=0.9):
359
- """Remove duplicate results based on semantic similarity"""
360
- unique_results = []
361
- embeddings = generate_embeddings([r['text'] for r in results])
362
-
363
- for i, result in enumerate(results):
364
- is_duplicate = False
365
-
366
- for j, unique_result in enumerate(unique_results):
367
- similarity = cosine_similarity(embeddings[i], embeddings[j])
368
- if similarity > similarity_threshold:
369
- is_duplicate = True
370
- break
371
-
372
- if not is_duplicate:
373
- unique_results.append(result)
374
-
375
- return unique_results
376
- ```
377
-
378
- ### Contradiction Detection
379
-
380
- Identify conflicting information:
381
-
382
- ```python
383
- def detect_contradictions(results: list):
384
- """Detect contradictions in retrieved results"""
385
- contradictions = []
386
-
387
- for i, result1 in enumerate(results):
388
- for j, result2 in enumerate(results[i+1:], start=i+1):
389
- # Use LLM to detect contradiction
390
- prompt = f"""
391
- Do these two statements contradict each other?
392
-
393
- Statement 1: {result1['text']}
394
- Statement 2: {result2['text']}
395
-
396
- Answer with YES or NO and explain briefly.
397
- """
398
-
399
- response = llm_call(prompt)
400
- if response.startswith("YES"):
401
- contradictions.append({
402
- 'result1': result1,
403
- 'result2': result2,
404
- 'explanation': response
405
- })
406
-
407
- return contradictions
408
- ```
409
-
410
- ### Priority-Based Resolution
411
-
412
- Resolve conflicts using priority:
413
-
414
- ```python
415
- def resolve_conflicts(results: list, priority_order: list):
416
- """Resolve conflicts using memory type priority"""
417
- # Group by memory type
418
- by_type = {}
419
- for result in results:
420
- memory_type = result['memory_type']
421
- if memory_type not in by_type:
422
- by_type[memory_type] = []
423
- by_type[memory_type].append(result)
424
-
425
- # Detect contradictions
426
- contradictions = detect_contradictions(results)
427
-
428
- # Resolve using priority
429
- resolved = []
430
- for contradiction in contradictions:
431
- result1 = contradiction['result1']
432
- result2 = contradiction['result2']
433
-
434
- # Choose based on priority
435
- type1_priority = priority_order.index(result1['memory_type'])
436
- type2_priority = priority_order.index(result2['memory_type'])
437
-
438
- if type1_priority < type2_priority:
439
- resolved.append(result1)
440
- else:
441
- resolved.append(result2)
442
-
443
- # Add non-conflicting results
444
- conflicting_ids = set()
445
- for c in contradictions:
446
- conflicting_ids.add(c['result1']['id'])
447
- conflicting_ids.add(c['result2']['id'])
448
-
449
- for result in results:
450
- if result['id'] not in conflicting_ids:
451
- resolved.append(result)
452
-
453
- return resolved
454
- ```
455
-
456
- **Best Practices**:
457
- - Always deduplicate results
458
- - Detect contradictions for critical applications
459
- - Use priority-based resolution (token > state > vector > graph)
460
- - Log conflicts for debugging
461
-
462
- ---
463
-
464
- ## 5. Best Practices
465
-
466
- ### DO
467
-
468
- ✅ **Allocate budget strategically**: Prioritize based on query type
469
- ✅ **Use parallel retrieval**: Reduce latency
470
- ✅ **Deduplicate results**: Avoid redundant context
471
- ✅ **Detect contradictions**: Ensure consistency
472
- ✅ **Monitor performance**: Track latency and quality
473
- ✅ **Implement fallbacks**: Handle memory failures gracefully
474
- ✅ **Version memory schemas**: Support evolution
475
- ✅ **Cache frequently accessed data**: Improve performance
476
-
477
- ### DON'T
478
-
479
- ❌ **Don't use all memory types for every query**: Be selective
480
- ❌ **Don't ignore conflicts**: Contradictions confuse LLMs
481
- ❌ **Don't over-allocate**: Respect token budgets
482
- ❌ **Don't forget to deduplicate**: Wastes tokens
483
- ❌ **Don't use sequential when parallel is better**: Optimize latency
484
- ❌ **Don't hard-code allocations**: Make them configurable
485
- ❌ **Don't ignore memory type characteristics**: Match to use case
486
-
487
- ---
488
-
489
- ## 6. Common Pitfalls
490
-
491
- ### Over-Complexity
492
-
493
- **Problem**: Too many memory types, complex orchestration
494
-
495
- **Solution**:
496
- - Start simple (2-3 memory types)
497
- - Add complexity only when needed
498
- - Measure impact of each memory type
499
-
500
- ### Budget Imbalance
501
-
502
- **Problem**: Poor allocation leads to suboptimal retrieval
503
-
504
- **Solution**:
505
- - Monitor actual usage
506
- - Adjust allocations based on query patterns
507
- - Use dynamic allocation for diverse queries
508
-
509
- ### Latency Issues
510
-
511
- **Problem**: Sequential retrieval too slow
512
-
513
- **Solution**:
514
- - Use parallel orchestration
515
- - Implement caching
516
- - Optimize each memory type independently
517
-
518
- ### Conflict Proliferation
519
-
520
- **Problem**: Too many contradictions, unclear resolution
521
-
522
- **Solution**:
523
- - Establish clear priority order
524
- - Use recency as tiebreaker
525
- - Log and review conflicts regularly
526
-
527
- ---
528
-
529
- ## 7. Integration Example
530
-
531
- Complete hybrid MCP implementation:
532
-
533
- ```python
534
- class HybridMCP:
535
- """Complete hybrid MCP with multiple memory types"""
536
-
537
- def __init__(self, config: dict):
538
- # Initialize memory types
539
- self.token_memory = TokenMemory(config['token'])
540
- self.state_memory = StateMemory(config['state'])
541
- self.vector_memory = VectorMemory(config['vector'])
542
- self.graph_memory = GraphMemory(config['graph'])
543
-
544
- # Initialize orchestrator
545
- memories = {
546
- 'token': self.token_memory,
547
- 'state': self.state_memory,
548
- 'vector': self.vector_memory,
549
- 'graph': self.graph_memory
550
- }
551
- self.orchestrator = ParallelOrchestrator(memories)
552
-
553
- # Initialize budget allocator
554
- self.allocator = DynamicBudgetAllocator(config['total_budget'])
555
-
556
- async def retrieve(self, query: str, query_type: str = "general"):
557
- """Retrieve context from all memory types"""
558
- # Allocate budget
559
- budget = self.allocator.allocate(query, query_type)
560
-
561
- # Retrieve in parallel
562
- results = await self.orchestrator.retrieve(query, budget)
563
-
564
- # Deduplicate
565
- results = deduplicate_results(results)
566
-
567
- # Detect and resolve conflicts
568
- contradictions = detect_contradictions(results)
569
- if contradictions:
570
- priority_order = ['token', 'state', 'vector', 'graph']
571
- results = resolve_conflicts(results, priority_order)
572
-
573
- return results
574
-
575
- def update(self, content: str, memory_types: list):
576
- """Update multiple memory types"""
577
- for memory_type in memory_types:
578
- if memory_type == 'token':
579
- self.token_memory.add(content)
580
- elif memory_type == 'state':
581
- self.state_memory.update(content)
582
- elif memory_type == 'vector':
583
- self.vector_memory.index(content)
584
- elif memory_type == 'graph':
585
- self.graph_memory.add_entities(content)
586
- ```
587
-
588
- ---
589
-
590
- ## Configuration Example
591
-
592
- ```json
593
- {
594
- "mcp": {
595
- "type": "hybrid",
596
- "total_budget": 8192,
597
- "memories": {
598
- "token": {
599
- "max_tokens": 4096,
600
- "sliding_window": true
601
- },
602
- "state": {
603
- "persistence": "redis",
604
- "ttl": 3600
605
- },
606
- "vector": {
607
- "provider": "pinecone",
608
- "embedding_model": "text-embedding-3-small",
609
- "chunk_size": 512
610
- },
611
- "graph": {
612
- "provider": "neo4j",
613
- "entity_extraction": "llm"
614
- }
615
- },
616
- "orchestration": {
617
- "mode": "parallel",
618
- "deduplication": true,
619
- "conflict_detection": true,
620
- "priority_order": ["token", "state", "vector", "graph"]
621
- },
622
- "allocation": {
623
- "mode": "dynamic",
624
- "default": {
625
- "token": 0.3,
626
- "state": 0.2,
627
- "vector": 0.3,
628
- "graph": 0.2
629
- }
630
- }
631
- }
632
- }
633
- ```
634
-
635
- ---
636
-
1
+ # Hybrid MCP Guidelines
2
+
3
+ ## Overview
4
+
5
+ **Hybrid MCP** combines multiple memory types (token, state, vector, graph, compressed) to create sophisticated multi-memory architectures. This enables optimal context management across diverse use cases.
6
+
7
+ **Key Challenge**: Orchestrating multiple memory systems with different characteristics, budgets, and retrieval patterns while maintaining coherence and performance.
8
+
9
+ ---
10
+
11
+ ## 1. Multi-Memory Architecture
12
+
13
+ ### Memory Type Characteristics
14
+
15
+ | Memory Type | Latency | Capacity | Precision | Cost | Use Case |
16
+ |-------------|---------|----------|-----------|------|----------|
17
+ | **Token** | Instant | Limited (200k) | Perfect | High | Immediate context |
18
+ | **State** | Low | Medium | Perfect | Low | Session continuity |
19
+ | **Vector** | Medium | High | Approximate | Medium | Semantic search |
20
+ | **Graph** | Medium | High | Structured | Medium | Relationships |
21
+ | **Compressed** | Low | High | Lossy | Low | Long-term memory |
22
+
23
+ ### Architecture Patterns
24
+
25
+ **Tiered Memory**:
26
+
27
+ ```python
28
+ class TieredMemory:
29
+ """Multi-tier memory with hot/warm/cold storage"""
30
+
31
+ def __init__(self):
32
+ # Tier 1: Hot (token-based, immediate context)
33
+ self.hot_memory = TokenMemory(max_tokens=4096)
34
+
35
+ # Tier 2: Warm (state-based, session context)
36
+ self.warm_memory = StateMemory()
37
+
38
+ # Tier 3: Cold (vector-based, long-term knowledge)
39
+ self.cold_memory = VectorMemory()
40
+
41
+ def retrieve(self, query: str, token_budget=4096):
42
+ """Retrieve from all tiers with budget allocation"""
43
+ # Allocate budget across tiers
44
+ hot_budget = int(token_budget * 0.5) # 50% for immediate context
45
+ warm_budget = int(token_budget * 0.3) # 30% for session context
46
+ cold_budget = int(token_budget * 0.2) # 20% for knowledge base
47
+
48
+ # Retrieve from each tier
49
+ hot_context = self.hot_memory.get_recent(hot_budget)
50
+ warm_context = self.warm_memory.get_session(warm_budget)
51
+ cold_context = self.cold_memory.search(query, cold_budget)
52
+
53
+ # Combine contexts
54
+ return self.merge_contexts(hot_context, warm_context, cold_context)
55
+
56
+ def merge_contexts(self, hot, warm, cold):
57
+ """Merge contexts with deduplication"""
58
+ # Deduplicate and prioritize by tier
59
+ seen = set()
60
+ merged = []
61
+
62
+ for context in [hot, warm, cold]:
63
+ for item in context:
64
+ key = self.get_key(item)
65
+ if key not in seen:
66
+ merged.append(item)
67
+ seen.add(key)
68
+
69
+ return merged
70
+ ```
71
+
72
+ **Specialized Memory**:
73
+
74
+ ```python
75
+ class SpecializedMemory:
76
+ """Different memory types for different content"""
77
+
78
+ def __init__(self):
79
+ # Vector memory for documents
80
+ self.document_memory = VectorMemory()
81
+
82
+ # Graph memory for entities and relationships
83
+ self.entity_memory = GraphMemory()
84
+
85
+ # State memory for conversation
86
+ self.conversation_memory = StateMemory()
87
+
88
+ # Compressed memory for long-term history
89
+ self.history_memory = CompressedMemory()
90
+
91
+ def retrieve(self, query: str, query_type: str):
92
+ """Route to appropriate memory based on query type"""
93
+ if query_type == "factual":
94
+ return self.document_memory.search(query)
95
+ elif query_type == "relational":
96
+ return self.entity_memory.traverse(query)
97
+ elif query_type == "conversational":
98
+ return self.conversation_memory.get_context()
99
+ elif query_type == "historical":
100
+ return self.history_memory.recall(query)
101
+ else:
102
+ # Hybrid retrieval
103
+ return self.hybrid_retrieve(query)
104
+ ```
105
+
106
+ **Best Practices**:
107
+ - Allocate token budget across memory types
108
+ - Use tiered memory for general-purpose agents
109
+ - Use specialized memory for domain-specific agents
110
+ - Implement fallback strategies
111
+
112
+ ---
113
+
114
+ ## 2. Budget Allocation
115
+
116
+ ### Static Allocation
117
+
118
+ Fixed budget per memory type:
119
+
120
+ ```python
121
+ class StaticBudgetAllocator:
122
+ """Fixed budget allocation across memory types"""
123
+
124
+ def __init__(self, total_budget=4096):
125
+ self.total_budget = total_budget
126
+ self.allocations = {
127
+ 'token': 0.4, # 40% for immediate context
128
+ 'state': 0.2, # 20% for session state
129
+ 'vector': 0.3, # 30% for semantic search
130
+ 'graph': 0.1 # 10% for relationships
131
+ }
132
+
133
+ def allocate(self):
134
+ """Return budget for each memory type"""
135
+ return {
136
+ memory_type: int(self.total_budget * ratio)
137
+ for memory_type, ratio in self.allocations.items()
138
+ }
139
+ ```
140
+
141
+ ### Dynamic Allocation
142
+
143
+ Adaptive budget based on query:
144
+
145
+ ```python
146
+ class DynamicBudgetAllocator:
147
+ """Adaptive budget allocation based on query characteristics"""
148
+
149
+ def __init__(self, total_budget=4096):
150
+ self.total_budget = total_budget
151
+
152
+ def allocate(self, query: str, query_type: str):
153
+ """Allocate budget based on query type"""
154
+ if query_type == "factual":
155
+ # Prioritize vector search
156
+ return {
157
+ 'token': int(self.total_budget * 0.2),
158
+ 'vector': int(self.total_budget * 0.6),
159
+ 'graph': int(self.total_budget * 0.2)
160
+ }
161
+ elif query_type == "conversational":
162
+ # Prioritize conversation history
163
+ return {
164
+ 'token': int(self.total_budget * 0.5),
165
+ 'state': int(self.total_budget * 0.4),
166
+ 'vector': int(self.total_budget * 0.1)
167
+ }
168
+ elif query_type == "analytical":
169
+ # Prioritize graph traversal
170
+ return {
171
+ 'token': int(self.total_budget * 0.2),
172
+ 'graph': int(self.total_budget * 0.5),
173
+ 'vector': int(self.total_budget * 0.3)
174
+ }
175
+ else:
176
+ # Balanced allocation
177
+ return {
178
+ 'token': int(self.total_budget * 0.3),
179
+ 'state': int(self.total_budget * 0.2),
180
+ 'vector': int(self.total_budget * 0.3),
181
+ 'graph': int(self.total_budget * 0.2)
182
+ }
183
+ ```
184
+
185
+ **Best Practices**:
186
+ - Start with static allocation for simplicity
187
+ - Use dynamic allocation for complex agents
188
+ - Monitor actual usage vs allocation
189
+ - Adjust based on performance metrics
190
+
191
+ ---
192
+
193
+ ## 3. Orchestration Patterns
194
+
195
+ ### Sequential Orchestration
196
+
197
+ Retrieve from memory types in sequence:
198
+
199
+ ```python
200
+ class SequentialOrchestrator:
201
+ """Retrieve from memory types sequentially"""
202
+
203
+ def __init__(self, memories: dict):
204
+ self.memories = memories
205
+
206
+ def retrieve(self, query: str, budget_allocation: dict):
207
+ """Retrieve sequentially with early stopping"""
208
+ results = []
209
+ total_tokens = 0
210
+
211
+ # Define retrieval order
212
+ order = ['token', 'state', 'vector', 'graph']
213
+
214
+ for memory_type in order:
215
+ if memory_type not in self.memories:
216
+ continue
217
+
218
+ budget = budget_allocation.get(memory_type, 0)
219
+ if budget == 0:
220
+ continue
221
+
222
+ # Retrieve from this memory type
223
+ memory_results = self.memories[memory_type].retrieve(query, budget)
224
+
225
+ # Add to results
226
+ for result in memory_results:
227
+ result_tokens = count_tokens(result)
228
+ if total_tokens + result_tokens <= sum(budget_allocation.values()):
229
+ results.append(result)
230
+ total_tokens += result_tokens
231
+ else:
232
+ # Budget exhausted
233
+ return results
234
+
235
+ return results
236
+ ```
237
+
238
+ ### Parallel Orchestration
239
+
240
+ Retrieve from all memory types simultaneously:
241
+
242
+ ```python
243
+ import asyncio
244
+
245
+ class ParallelOrchestrator:
246
+ """Retrieve from memory types in parallel"""
247
+
248
+ def __init__(self, memories: dict):
249
+ self.memories = memories
250
+
251
+ async def retrieve(self, query: str, budget_allocation: dict):
252
+ """Retrieve in parallel and merge"""
253
+ # Create retrieval tasks
254
+ tasks = []
255
+ for memory_type, memory in self.memories.items():
256
+ budget = budget_allocation.get(memory_type, 0)
257
+ if budget > 0:
258
+ task = memory.retrieve_async(query, budget)
259
+ tasks.append((memory_type, task))
260
+
261
+ # Execute in parallel
262
+ results_by_type = {}
263
+ for memory_type, task in tasks:
264
+ results_by_type[memory_type] = await task
265
+
266
+ # Merge and deduplicate
267
+ return self.merge_results(results_by_type, budget_allocation)
268
+
269
+ def merge_results(self, results_by_type: dict, budget_allocation: dict):
270
+ """Merge results with priority weighting"""
271
+ merged = []
272
+ seen = set()
273
+
274
+ # Priority order
275
+ priority = ['token', 'state', 'vector', 'graph']
276
+
277
+ for memory_type in priority:
278
+ if memory_type not in results_by_type:
279
+ continue
280
+
281
+ for result in results_by_type[memory_type]:
282
+ key = self.get_key(result)
283
+ if key not in seen:
284
+ merged.append(result)
285
+ seen.add(key)
286
+
287
+ return merged
288
+ ```
289
+
290
+ ### Hierarchical Orchestration
291
+
292
+ Use coarse-to-fine retrieval:
293
+
294
+ ```python
295
+ class HierarchicalOrchestrator:
296
+ """Hierarchical retrieval with refinement"""
297
+
298
+ def __init__(self, memories: dict):
299
+ self.memories = memories
300
+
301
+ def retrieve(self, query: str, budget_allocation: dict):
302
+ """Retrieve hierarchically"""
303
+ # Stage 1: Coarse retrieval (compressed memory)
304
+ if 'compressed' in self.memories:
305
+ coarse_results = self.memories['compressed'].retrieve(
306
+ query,
307
+ budget_allocation.get('compressed', 512)
308
+ )
309
+
310
+ # Extract relevant topics/entities
311
+ topics = self.extract_topics(coarse_results)
312
+ else:
313
+ topics = [query]
314
+
315
+ # Stage 2: Medium retrieval (vector memory)
316
+ if 'vector' in self.memories:
317
+ medium_results = []
318
+ for topic in topics:
319
+ results = self.memories['vector'].retrieve(
320
+ topic,
321
+ budget_allocation.get('vector', 2048) // len(topics)
322
+ )
323
+ medium_results.extend(results)
324
+
325
+ # Extract specific entities
326
+ entities = self.extract_entities(medium_results)
327
+ else:
328
+ entities = []
329
+
330
+ # Stage 3: Fine retrieval (graph memory)
331
+ if 'graph' in self.memories and entities:
332
+ fine_results = self.memories['graph'].traverse(
333
+ entities,
334
+ budget_allocation.get('graph', 1024)
335
+ )
336
+ else:
337
+ fine_results = []
338
+
339
+ # Combine all stages
340
+ return self.combine_stages(coarse_results, medium_results, fine_results)
341
+ ```
342
+
343
+ **Best Practices**:
344
+ - Use sequential for simple agents
345
+ - Use parallel for low-latency requirements
346
+ - Use hierarchical for complex queries
347
+ - Monitor latency and adjust
348
+
349
+ ---
350
+
351
+ ## 4. Conflict Resolution
352
+
353
+ ### Deduplication
354
+
355
+ Remove duplicate information:
356
+
357
+ ```python
358
+ def deduplicate_results(results: list, similarity_threshold=0.9):
359
+ """Remove duplicate results based on semantic similarity"""
360
+ unique_results = []
361
+ embeddings = generate_embeddings([r['text'] for r in results])
362
+
363
+ for i, result in enumerate(results):
364
+ is_duplicate = False
365
+
366
+ for j, unique_result in enumerate(unique_results):
367
+ similarity = cosine_similarity(embeddings[i], embeddings[j])
368
+ if similarity > similarity_threshold:
369
+ is_duplicate = True
370
+ break
371
+
372
+ if not is_duplicate:
373
+ unique_results.append(result)
374
+
375
+ return unique_results
376
+ ```
377
+
378
+ ### Contradiction Detection
379
+
380
+ Identify conflicting information:
381
+
382
+ ```python
383
+ def detect_contradictions(results: list):
384
+ """Detect contradictions in retrieved results"""
385
+ contradictions = []
386
+
387
+ for i, result1 in enumerate(results):
388
+ for j, result2 in enumerate(results[i+1:], start=i+1):
389
+ # Use LLM to detect contradiction
390
+ prompt = f"""
391
+ Do these two statements contradict each other?
392
+
393
+ Statement 1: {result1['text']}
394
+ Statement 2: {result2['text']}
395
+
396
+ Answer with YES or NO and explain briefly.
397
+ """
398
+
399
+ response = llm_call(prompt)
400
+ if response.startswith("YES"):
401
+ contradictions.append({
402
+ 'result1': result1,
403
+ 'result2': result2,
404
+ 'explanation': response
405
+ })
406
+
407
+ return contradictions
408
+ ```
409
+
410
+ ### Priority-Based Resolution
411
+
412
+ Resolve conflicts using priority:
413
+
414
+ ```python
415
+ def resolve_conflicts(results: list, priority_order: list):
416
+ """Resolve conflicts using memory type priority"""
417
+ # Group by memory type
418
+ by_type = {}
419
+ for result in results:
420
+ memory_type = result['memory_type']
421
+ if memory_type not in by_type:
422
+ by_type[memory_type] = []
423
+ by_type[memory_type].append(result)
424
+
425
+ # Detect contradictions
426
+ contradictions = detect_contradictions(results)
427
+
428
+ # Resolve using priority
429
+ resolved = []
430
+ for contradiction in contradictions:
431
+ result1 = contradiction['result1']
432
+ result2 = contradiction['result2']
433
+
434
+ # Choose based on priority
435
+ type1_priority = priority_order.index(result1['memory_type'])
436
+ type2_priority = priority_order.index(result2['memory_type'])
437
+
438
+ if type1_priority < type2_priority:
439
+ resolved.append(result1)
440
+ else:
441
+ resolved.append(result2)
442
+
443
+ # Add non-conflicting results
444
+ conflicting_ids = set()
445
+ for c in contradictions:
446
+ conflicting_ids.add(c['result1']['id'])
447
+ conflicting_ids.add(c['result2']['id'])
448
+
449
+ for result in results:
450
+ if result['id'] not in conflicting_ids:
451
+ resolved.append(result)
452
+
453
+ return resolved
454
+ ```
455
+
456
+ **Best Practices**:
457
+ - Always deduplicate results
458
+ - Detect contradictions for critical applications
459
+ - Use priority-based resolution (token > state > vector > graph)
460
+ - Log conflicts for debugging
461
+
462
+ ---
463
+
464
+ ## 5. Best Practices
465
+
466
+ ### DO
467
+
468
+ ✅ **Allocate budget strategically**: Prioritize based on query type
469
+ ✅ **Use parallel retrieval**: Reduce latency
470
+ ✅ **Deduplicate results**: Avoid redundant context
471
+ ✅ **Detect contradictions**: Ensure consistency
472
+ ✅ **Monitor performance**: Track latency and quality
473
+ ✅ **Implement fallbacks**: Handle memory failures gracefully
474
+ ✅ **Version memory schemas**: Support evolution
475
+ ✅ **Cache frequently accessed data**: Improve performance
476
+
477
+ ### DON'T
478
+
479
+ ❌ **Don't use all memory types for every query**: Be selective
480
+ ❌ **Don't ignore conflicts**: Contradictions confuse LLMs
481
+ ❌ **Don't over-allocate**: Respect token budgets
482
+ ❌ **Don't forget to deduplicate**: Wastes tokens
483
+ ❌ **Don't use sequential when parallel is better**: Optimize latency
484
+ ❌ **Don't hard-code allocations**: Make them configurable
485
+ ❌ **Don't ignore memory type characteristics**: Match to use case
486
+
487
+ ---
488
+
489
+ ## 6. Common Pitfalls
490
+
491
+ ### Over-Complexity
492
+
493
+ **Problem**: Too many memory types, complex orchestration
494
+
495
+ **Solution**:
496
+ - Start simple (2-3 memory types)
497
+ - Add complexity only when needed
498
+ - Measure impact of each memory type
499
+
500
+ ### Budget Imbalance
501
+
502
+ **Problem**: Poor allocation leads to suboptimal retrieval
503
+
504
+ **Solution**:
505
+ - Monitor actual usage
506
+ - Adjust allocations based on query patterns
507
+ - Use dynamic allocation for diverse queries
508
+
509
+ ### Latency Issues
510
+
511
+ **Problem**: Sequential retrieval too slow
512
+
513
+ **Solution**:
514
+ - Use parallel orchestration
515
+ - Implement caching
516
+ - Optimize each memory type independently
517
+
518
+ ### Conflict Proliferation
519
+
520
+ **Problem**: Too many contradictions, unclear resolution
521
+
522
+ **Solution**:
523
+ - Establish clear priority order
524
+ - Use recency as tiebreaker
525
+ - Log and review conflicts regularly
526
+
527
+ ---
528
+
529
+ ## 7. Integration Example
530
+
531
+ Complete hybrid MCP implementation:
532
+
533
+ ```python
534
+ class HybridMCP:
535
+ """Complete hybrid MCP with multiple memory types"""
536
+
537
+ def __init__(self, config: dict):
538
+ # Initialize memory types
539
+ self.token_memory = TokenMemory(config['token'])
540
+ self.state_memory = StateMemory(config['state'])
541
+ self.vector_memory = VectorMemory(config['vector'])
542
+ self.graph_memory = GraphMemory(config['graph'])
543
+
544
+ # Initialize orchestrator
545
+ memories = {
546
+ 'token': self.token_memory,
547
+ 'state': self.state_memory,
548
+ 'vector': self.vector_memory,
549
+ 'graph': self.graph_memory
550
+ }
551
+ self.orchestrator = ParallelOrchestrator(memories)
552
+
553
+ # Initialize budget allocator
554
+ self.allocator = DynamicBudgetAllocator(config['total_budget'])
555
+
556
+ async def retrieve(self, query: str, query_type: str = "general"):
557
+ """Retrieve context from all memory types"""
558
+ # Allocate budget
559
+ budget = self.allocator.allocate(query, query_type)
560
+
561
+ # Retrieve in parallel
562
+ results = await self.orchestrator.retrieve(query, budget)
563
+
564
+ # Deduplicate
565
+ results = deduplicate_results(results)
566
+
567
+ # Detect and resolve conflicts
568
+ contradictions = detect_contradictions(results)
569
+ if contradictions:
570
+ priority_order = ['token', 'state', 'vector', 'graph']
571
+ results = resolve_conflicts(results, priority_order)
572
+
573
+ return results
574
+
575
+ def update(self, content: str, memory_types: list):
576
+ """Update multiple memory types"""
577
+ for memory_type in memory_types:
578
+ if memory_type == 'token':
579
+ self.token_memory.add(content)
580
+ elif memory_type == 'state':
581
+ self.state_memory.update(content)
582
+ elif memory_type == 'vector':
583
+ self.vector_memory.index(content)
584
+ elif memory_type == 'graph':
585
+ self.graph_memory.add_entities(content)
586
+ ```
587
+
588
+ ---
589
+
590
+ ## Configuration Example
591
+
592
+ ```json
593
+ {
594
+ "mcp": {
595
+ "type": "hybrid",
596
+ "total_budget": 8192,
597
+ "memories": {
598
+ "token": {
599
+ "max_tokens": 4096,
600
+ "sliding_window": true
601
+ },
602
+ "state": {
603
+ "persistence": "redis",
604
+ "ttl": 3600
605
+ },
606
+ "vector": {
607
+ "provider": "pinecone",
608
+ "embedding_model": "text-embedding-3-small",
609
+ "chunk_size": 512
610
+ },
611
+ "graph": {
612
+ "provider": "neo4j",
613
+ "entity_extraction": "llm"
614
+ }
615
+ },
616
+ "orchestration": {
617
+ "mode": "parallel",
618
+ "deduplication": true,
619
+ "conflict_detection": true,
620
+ "priority_order": ["token", "state", "vector", "graph"]
621
+ },
622
+ "allocation": {
623
+ "mode": "dynamic",
624
+ "default": {
625
+ "token": 0.3,
626
+ "state": 0.2,
627
+ "vector": 0.3,
628
+ "graph": 0.2
629
+ }
630
+ }
631
+ }
632
+ }
633
+ ```
634
+
635
+ ---
636
+