@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,520 +1,520 @@
1
- # Graph-Augmented MCP Example: Supply Chain Analysis
2
-
3
- ## Use Case
4
-
5
- A supply chain analysis system that uses knowledge graphs to track entities (suppliers, products, warehouses) and their relationships for complex queries and reasoning.
6
-
7
- **Challenges**:
8
- - Model complex entity relationships
9
- - Support multi-hop reasoning
10
- - Handle graph traversal efficiently
11
- - Integrate graph context with LLM generation
12
-
13
- ---
14
-
15
- ## Configuration
16
-
17
- ```json
18
- {
19
- "mcp": {
20
- "type": "graph",
21
- "graphDatabase": {
22
- "backend": "neo4j",
23
- "uri": "bolt://localhost:7687",
24
- "database": "supply-chain"
25
- },
26
- "entityExtraction": {
27
- "enabled": true,
28
- "model": "gpt-4o",
29
- "entityTypes": ["SUPPLIER", "PRODUCT", "WAREHOUSE", "CUSTOMER", "ORDER"]
30
- },
31
- "relationshipTypes": [
32
- "SUPPLIES",
33
- "STORED_IN",
34
- "ORDERED_BY",
35
- "SHIPS_TO",
36
- "DEPENDS_ON"
37
- ],
38
- "traversal": {
39
- "maxDepth": 3,
40
- "maxNodes": 100,
41
- "algorithm": "bidirectional_bfs"
42
- }
43
- }
44
- }
45
- ```
46
-
47
- ---
48
-
49
- ## Architecture
50
-
51
- ```
52
- ┌─────────────────────────────────────────────────────────────┐
53
- │ Supply Chain Query │
54
- │ "Which suppliers can fulfill order #12345?" │
55
- └─────────────────────────────────────────────────────────────┘
56
-
57
-
58
- ┌─────────────────────────────────────────────────────────────┐
59
- │ Entity Extraction │
60
- │ Entities: [Order #12345] │
61
- │ Intent: Find suppliers │
62
- └─────────────────────────────────────────────────────────────┘
63
-
64
-
65
- ┌─────────────────────────────────────────────────────────────┐
66
- │ Knowledge Graph (Neo4j) │
67
- │ │
68
- │ (Order #12345) -[CONTAINS]→ (Product A) │
69
- │ ↓ │
70
- │ [SUPPLIED_BY] │
71
- │ ↓ │
72
- │ (Supplier X, Y, Z) │
73
- │ ↓ │
74
- │ [STORED_IN] │
75
- │ ↓ │
76
- │ (Warehouse 1, 2) │
77
- └─────────────────────────────────────────────────────────────┘
78
-
79
-
80
- ┌─────────────────────────────────────────────────────────────┐
81
- │ Graph Traversal │
82
- │ Path: Order → Product → Supplier → Warehouse │
83
- │ Depth: 3 hops │
84
- │ Nodes: 15 entities │
85
- └─────────────────────────────────────────────────────────────┘
86
-
87
-
88
- ┌─────────────────────────────────────────────────────────────┐
89
- │ Context Serialization │
90
- │ Graph → Natural Language Description │
91
- └─────────────────────────────────────────────────────────────┘
92
-
93
-
94
- ┌─────────────────────────────────────────────────────────────┐
95
- │ LLM Generation │
96
- │ Graph Context → GPT-4o → Answer │
97
- └─────────────────────────────────────────────────────────────┘
98
- ```
99
-
100
- ---
101
-
102
- ## Implementation
103
-
104
- ### Step 1: Graph Manager
105
-
106
- ```python
107
- from neo4j import GraphDatabase
108
- from typing import List, Dict, Any, Optional
109
- import openai
110
-
111
- class GraphManager:
112
- def __init__(self, uri: str, user: str, password: str):
113
- self.driver = GraphDatabase.driver(uri, auth=(user, password))
114
-
115
- def close(self):
116
- self.driver.close()
117
-
118
- def create_entity(self, entity_type: str, properties: Dict[str, Any]) -> str:
119
- """Create entity node in graph"""
120
- with self.driver.session() as session:
121
- result = session.run(
122
- f"""
123
- CREATE (e:{entity_type} $properties)
124
- RETURN elementId(e) as id
125
- """,
126
- properties=properties
127
- )
128
- return result.single()["id"]
129
-
130
- def create_relationship(
131
- self,
132
- from_id: str,
133
- to_id: str,
134
- rel_type: str,
135
- properties: Optional[Dict[str, Any]] = None
136
- ) -> None:
137
- """Create relationship between entities"""
138
- with self.driver.session() as session:
139
- session.run(
140
- f"""
141
- MATCH (a), (b)
142
- WHERE elementId(a) = $from_id AND elementId(b) = $to_id
143
- CREATE (a)-[r:{rel_type} $properties]->(b)
144
- """,
145
- from_id=from_id,
146
- to_id=to_id,
147
- properties=properties or {}
148
- )
149
-
150
- def find_paths(
151
- self,
152
- start_entity: Dict[str, Any],
153
- end_entity: Dict[str, Any],
154
- max_depth: int = 3
155
- ) -> List[Dict[str, Any]]:
156
- """Find paths between entities"""
157
- with self.driver.session() as session:
158
- result = session.run(
159
- """
160
- MATCH path = (start)-[*1..$max_depth]-(end)
161
- WHERE start.id = $start_id AND end.id = $end_id
162
- RETURN path
163
- LIMIT 10
164
- """,
165
- start_id=start_entity["id"],
166
- end_id=end_entity["id"],
167
- max_depth=max_depth
168
- )
169
-
170
- paths = []
171
- for record in result:
172
- path = record["path"]
173
- paths.append(self._serialize_path(path))
174
-
175
- return paths
176
-
177
- def traverse_from_entity(
178
- self,
179
- entity_id: str,
180
- max_depth: int = 2,
181
- max_nodes: int = 100
182
- ) -> Dict[str, Any]:
183
- """Traverse graph from entity"""
184
- with self.driver.session() as session:
185
- result = session.run(
186
- """
187
- MATCH path = (start)-[*1..$max_depth]-(connected)
188
- WHERE elementId(start) = $entity_id
189
- RETURN path
190
- LIMIT $max_nodes
191
- """,
192
- entity_id=entity_id,
193
- max_depth=max_depth,
194
- max_nodes=max_nodes
195
- )
196
-
197
- nodes = []
198
- relationships = []
199
-
200
- for record in result:
201
- path = record["path"]
202
- for node in path.nodes:
203
- nodes.append({
204
- "id": node.element_id,
205
- "labels": list(node.labels),
206
- "properties": dict(node)
207
- })
208
-
209
- for rel in path.relationships:
210
- relationships.append({
211
- "type": rel.type,
212
- "start": rel.start_node.element_id,
213
- "end": rel.end_node.element_id,
214
- "properties": dict(rel)
215
- })
216
-
217
- return {
218
- "nodes": nodes,
219
- "relationships": relationships
220
- }
221
-
222
- def _serialize_path(self, path) -> Dict[str, Any]:
223
- """Serialize Neo4j path to dict"""
224
- nodes = [
225
- {
226
- "id": node.element_id,
227
- "labels": list(node.labels),
228
- "properties": dict(node)
229
- }
230
- for node in path.nodes
231
- ]
232
-
233
- relationships = [
234
- {
235
- "type": rel.type,
236
- "properties": dict(rel)
237
- }
238
- for rel in path.relationships
239
- ]
240
-
241
- return {
242
- "nodes": nodes,
243
- "relationships": relationships
244
- }
245
-
246
- class SupplyChainAnalyzer:
247
- def __init__(self, graph_manager: GraphManager, openai_api_key: str):
248
- self.graph = graph_manager
249
- self.client = openai.OpenAI(api_key=openai_api_key)
250
-
251
- def extract_entities(self, query: str) -> List[Dict[str, Any]]:
252
- """Extract entities from query using LLM"""
253
- response = self.client.chat.completions.create(
254
- model="gpt-4o",
255
- messages=[
256
- {
257
- "role": "system",
258
- "content": """Extract entities from the query.
259
-
260
- Entity types: SUPPLIER, PRODUCT, WAREHOUSE, CUSTOMER, ORDER
261
-
262
- Return JSON array of entities:
263
- [{"type": "ORDER", "value": "#12345"}, ...]"""
264
- },
265
- {
266
- "role": "user",
267
- "content": query
268
- }
269
- ],
270
- response_format={"type": "json_object"}
271
- )
272
-
273
- import json
274
- result = json.loads(response.choices[0].message.content)
275
- return result.get("entities", [])
276
-
277
- def analyze_query(self, query: str) -> Dict[str, Any]:
278
- """Analyze supply chain query using graph"""
279
- # Extract entities from query
280
- entities = self.extract_entities(query)
281
-
282
- if not entities:
283
- return {"answer": "No entities found in query", "graph_context": None}
284
-
285
- # Get graph context for entities
286
- graph_contexts = []
287
- for entity in entities:
288
- # Find entity in graph
289
- entity_id = self._find_entity_id(entity)
290
-
291
- if entity_id:
292
- # Traverse graph from entity
293
- subgraph = self.graph.traverse_from_entity(
294
- entity_id=entity_id,
295
- max_depth=3,
296
- max_nodes=100
297
- )
298
- graph_contexts.append(subgraph)
299
-
300
- # Serialize graph to natural language
301
- graph_description = self._serialize_graph_to_text(graph_contexts)
302
-
303
- # Generate answer using LLM
304
- answer = self._generate_answer(query, graph_description)
305
-
306
- return {
307
- "answer": answer,
308
- "graph_context": graph_contexts,
309
- "entities_found": entities
310
- }
311
-
312
- def _find_entity_id(self, entity: Dict[str, Any]) -> Optional[str]:
313
- """Find entity ID in graph"""
314
- with self.graph.driver.session() as session:
315
- result = session.run(
316
- f"""
317
- MATCH (e:{entity['type']})
318
- WHERE e.id = $value OR e.name = $value
319
- RETURN elementId(e) as id
320
- LIMIT 1
321
- """,
322
- value=entity["value"]
323
- )
324
-
325
- record = result.single()
326
- return record["id"] if record else None
327
-
328
- def _serialize_graph_to_text(self, graph_contexts: List[Dict[str, Any]]) -> str:
329
- """Convert graph structure to natural language"""
330
- parts = []
331
-
332
- for i, context in enumerate(graph_contexts, 1):
333
- parts.append(f"=== Subgraph {i} ===")
334
-
335
- # Describe nodes
336
- parts.append("Entities:")
337
- for node in context["nodes"][:20]: # Limit to 20 nodes
338
- labels = ", ".join(node["labels"])
339
- props = ", ".join(f"{k}={v}" for k, v in node["properties"].items())
340
- parts.append(f" - {labels}: {props}")
341
-
342
- # Describe relationships
343
- parts.append("\nRelationships:")
344
- for rel in context["relationships"][:20]: # Limit to 20 relationships
345
- parts.append(f" - {rel['type']}")
346
-
347
- parts.append("")
348
-
349
- return "\n".join(parts)
350
-
351
- def _generate_answer(self, query: str, graph_context: str) -> str:
352
- """Generate answer using graph context"""
353
- response = self.client.chat.completions.create(
354
- model="gpt-4o",
355
- messages=[
356
- {
357
- "role": "system",
358
- "content": """You are a supply chain analyst.
359
-
360
- Use the provided graph context to answer questions about:
361
- - Supplier relationships
362
- - Product availability
363
- - Warehouse locations
364
- - Order fulfillment
365
- - Dependencies
366
-
367
- Be specific and cite entities from the graph."""
368
- },
369
- {
370
- "role": "user",
371
- "content": f"""Graph Context:
372
- {graph_context}
373
-
374
- Query: {query}
375
-
376
- Answer:"""
377
- }
378
- ],
379
- temperature=0.3
380
- )
381
-
382
- return response.choices[0].message.content
383
- ```
384
-
385
- ---
386
-
387
- ## Usage Example
388
-
389
- ```python
390
- # Initialize graph manager
391
- graph = GraphManager(
392
- uri="bolt://localhost:7687",
393
- user="neo4j",
394
- password="password"
395
- )
396
-
397
- # Create sample supply chain graph
398
- supplier_id = graph.create_entity("SUPPLIER", {"id": "SUP-001", "name": "Acme Corp"})
399
- product_id = graph.create_entity("PRODUCT", {"id": "PROD-123", "name": "Widget A"})
400
- warehouse_id = graph.create_entity("WAREHOUSE", {"id": "WH-001", "location": "New York"})
401
- order_id = graph.create_entity("ORDER", {"id": "#12345", "status": "pending"})
402
-
403
- # Create relationships
404
- graph.create_relationship(supplier_id, product_id, "SUPPLIES", {"quantity": 1000})
405
- graph.create_relationship(product_id, warehouse_id, "STORED_IN", {"quantity": 500})
406
- graph.create_relationship(order_id, product_id, "CONTAINS", {"quantity": 10})
407
-
408
- # Initialize analyzer
409
- analyzer = SupplyChainAnalyzer(graph, "your-openai-key")
410
-
411
- # Analyze query
412
- result = analyzer.analyze_query("Which suppliers can fulfill order #12345?")
413
-
414
- print(f"Answer: {result['answer']}")
415
- print(f"\nEntities Found: {result['entities_found']}")
416
- print(f"Graph Nodes: {len(result['graph_context'][0]['nodes']) if result['graph_context'] else 0}")
417
-
418
- # Clean up
419
- graph.close()
420
- ```
421
-
422
- ---
423
-
424
- ## Key Features
425
-
426
- ### 1. Entity Extraction
427
- - LLM-based entity recognition
428
- - Support for multiple entity types
429
- - Flexible matching (ID or name)
430
-
431
- ### 2. Graph Traversal
432
- - Bidirectional BFS algorithm
433
- - Configurable depth and node limits
434
- - Path finding between entities
435
-
436
- ### 3. Relationship Modeling
437
- - Typed relationships (SUPPLIES, STORED_IN, etc.)
438
- - Relationship properties
439
- - Multi-hop reasoning
440
-
441
- ### 4. Context Serialization
442
- - Graph → Natural language conversion
443
- - Structured entity descriptions
444
- - Relationship summaries
445
-
446
- ---
447
-
448
- ## Testing
449
-
450
- ```python
451
- import pytest
452
-
453
- def test_entity_creation():
454
- graph = GraphManager("bolt://localhost:7687", "neo4j", "password")
455
-
456
- entity_id = graph.create_entity("SUPPLIER", {"id": "TEST-001", "name": "Test Corp"})
457
- assert entity_id is not None
458
-
459
- graph.close()
460
-
461
- def test_graph_traversal():
462
- graph = GraphManager("bolt://localhost:7687", "neo4j", "password")
463
-
464
- # Create test entities
465
- supplier_id = graph.create_entity("SUPPLIER", {"id": "SUP-TEST"})
466
- product_id = graph.create_entity("PRODUCT", {"id": "PROD-TEST"})
467
- graph.create_relationship(supplier_id, product_id, "SUPPLIES")
468
-
469
- # Traverse
470
- subgraph = graph.traverse_from_entity(supplier_id, max_depth=2)
471
-
472
- assert len(subgraph["nodes"]) > 0
473
- assert len(subgraph["relationships"]) > 0
474
-
475
- graph.close()
476
-
477
- def test_entity_extraction():
478
- analyzer = SupplyChainAnalyzer(None, "your-openai-key")
479
-
480
- entities = analyzer.extract_entities("Which suppliers can fulfill order #12345?")
481
-
482
- assert len(entities) > 0
483
- assert any(e["type"] == "ORDER" for e in entities)
484
- ```
485
-
486
- ---
487
-
488
- ## Best Practices
489
-
490
- 1. **Entity Modeling**: Define clear entity types and properties
491
- 2. **Relationship Types**: Use descriptive relationship names
492
- 3. **Graph Indexing**: Index frequently queried properties
493
- 4. **Traversal Limits**: Set appropriate depth and node limits
494
- 5. **Caching**: Cache frequently accessed subgraphs
495
- 6. **Batch Operations**: Batch entity/relationship creation
496
- 7. **Schema Validation**: Validate graph schema consistency
497
- 8. **Monitoring**: Track query performance and graph size
498
-
499
- ---
500
-
501
- ## Performance Optimization
502
-
503
- - **Indexing**: Create indexes on entity IDs and names
504
- - **Query Optimization**: Use Cypher query profiling
505
- - **Connection Pooling**: Reuse Neo4j connections
506
- - **Caching**: Cache subgraph results
507
- - **Pagination**: Paginate large result sets
508
- - **Parallel Queries**: Execute independent queries in parallel
509
-
510
- ---
511
-
512
- ## Security
513
-
514
- - **Access Control**: Implement role-based access control
515
- - **Query Validation**: Sanitize Cypher queries
516
- - **Encryption**: Encrypt graph data at rest
517
- - **Audit Logging**: Log all graph modifications
518
- - **Rate Limiting**: Limit traversal depth and nodes per query
519
- ```
520
-
1
+ # Graph-Augmented MCP Example: Supply Chain Analysis
2
+
3
+ ## Use Case
4
+
5
+ A supply chain analysis system that uses knowledge graphs to track entities (suppliers, products, warehouses) and their relationships for complex queries and reasoning.
6
+
7
+ **Challenges**:
8
+ - Model complex entity relationships
9
+ - Support multi-hop reasoning
10
+ - Handle graph traversal efficiently
11
+ - Integrate graph context with LLM generation
12
+
13
+ ---
14
+
15
+ ## Configuration
16
+
17
+ ```json
18
+ {
19
+ "mcp": {
20
+ "type": "graph",
21
+ "graphDatabase": {
22
+ "backend": "neo4j",
23
+ "uri": "bolt://localhost:7687",
24
+ "database": "supply-chain"
25
+ },
26
+ "entityExtraction": {
27
+ "enabled": true,
28
+ "model": "gpt-4o",
29
+ "entityTypes": ["SUPPLIER", "PRODUCT", "WAREHOUSE", "CUSTOMER", "ORDER"]
30
+ },
31
+ "relationshipTypes": [
32
+ "SUPPLIES",
33
+ "STORED_IN",
34
+ "ORDERED_BY",
35
+ "SHIPS_TO",
36
+ "DEPENDS_ON"
37
+ ],
38
+ "traversal": {
39
+ "maxDepth": 3,
40
+ "maxNodes": 100,
41
+ "algorithm": "bidirectional_bfs"
42
+ }
43
+ }
44
+ }
45
+ ```
46
+
47
+ ---
48
+
49
+ ## Architecture
50
+
51
+ ```
52
+ ┌─────────────────────────────────────────────────────────────┐
53
+ │ Supply Chain Query │
54
+ │ "Which suppliers can fulfill order #12345?" │
55
+ └─────────────────────────────────────────────────────────────┘
56
+
57
+
58
+ ┌─────────────────────────────────────────────────────────────┐
59
+ │ Entity Extraction │
60
+ │ Entities: [Order #12345] │
61
+ │ Intent: Find suppliers │
62
+ └─────────────────────────────────────────────────────────────┘
63
+
64
+
65
+ ┌─────────────────────────────────────────────────────────────┐
66
+ │ Knowledge Graph (Neo4j) │
67
+ │ │
68
+ │ (Order #12345) -[CONTAINS]→ (Product A) │
69
+ │ ↓ │
70
+ │ [SUPPLIED_BY] │
71
+ │ ↓ │
72
+ │ (Supplier X, Y, Z) │
73
+ │ ↓ │
74
+ │ [STORED_IN] │
75
+ │ ↓ │
76
+ │ (Warehouse 1, 2) │
77
+ └─────────────────────────────────────────────────────────────┘
78
+
79
+
80
+ ┌─────────────────────────────────────────────────────────────┐
81
+ │ Graph Traversal │
82
+ │ Path: Order → Product → Supplier → Warehouse │
83
+ │ Depth: 3 hops │
84
+ │ Nodes: 15 entities │
85
+ └─────────────────────────────────────────────────────────────┘
86
+
87
+
88
+ ┌─────────────────────────────────────────────────────────────┐
89
+ │ Context Serialization │
90
+ │ Graph → Natural Language Description │
91
+ └─────────────────────────────────────────────────────────────┘
92
+
93
+
94
+ ┌─────────────────────────────────────────────────────────────┐
95
+ │ LLM Generation │
96
+ │ Graph Context → GPT-4o → Answer │
97
+ └─────────────────────────────────────────────────────────────┘
98
+ ```
99
+
100
+ ---
101
+
102
+ ## Implementation
103
+
104
+ ### Step 1: Graph Manager
105
+
106
+ ```python
107
+ from neo4j import GraphDatabase
108
+ from typing import List, Dict, Any, Optional
109
+ import openai
110
+
111
+ class GraphManager:
112
+ def __init__(self, uri: str, user: str, password: str):
113
+ self.driver = GraphDatabase.driver(uri, auth=(user, password))
114
+
115
+ def close(self):
116
+ self.driver.close()
117
+
118
+ def create_entity(self, entity_type: str, properties: Dict[str, Any]) -> str:
119
+ """Create entity node in graph"""
120
+ with self.driver.session() as session:
121
+ result = session.run(
122
+ f"""
123
+ CREATE (e:{entity_type} $properties)
124
+ RETURN elementId(e) as id
125
+ """,
126
+ properties=properties
127
+ )
128
+ return result.single()["id"]
129
+
130
+ def create_relationship(
131
+ self,
132
+ from_id: str,
133
+ to_id: str,
134
+ rel_type: str,
135
+ properties: Optional[Dict[str, Any]] = None
136
+ ) -> None:
137
+ """Create relationship between entities"""
138
+ with self.driver.session() as session:
139
+ session.run(
140
+ f"""
141
+ MATCH (a), (b)
142
+ WHERE elementId(a) = $from_id AND elementId(b) = $to_id
143
+ CREATE (a)-[r:{rel_type} $properties]->(b)
144
+ """,
145
+ from_id=from_id,
146
+ to_id=to_id,
147
+ properties=properties or {}
148
+ )
149
+
150
+ def find_paths(
151
+ self,
152
+ start_entity: Dict[str, Any],
153
+ end_entity: Dict[str, Any],
154
+ max_depth: int = 3
155
+ ) -> List[Dict[str, Any]]:
156
+ """Find paths between entities"""
157
+ with self.driver.session() as session:
158
+ result = session.run(
159
+ """
160
+ MATCH path = (start)-[*1..$max_depth]-(end)
161
+ WHERE start.id = $start_id AND end.id = $end_id
162
+ RETURN path
163
+ LIMIT 10
164
+ """,
165
+ start_id=start_entity["id"],
166
+ end_id=end_entity["id"],
167
+ max_depth=max_depth
168
+ )
169
+
170
+ paths = []
171
+ for record in result:
172
+ path = record["path"]
173
+ paths.append(self._serialize_path(path))
174
+
175
+ return paths
176
+
177
+ def traverse_from_entity(
178
+ self,
179
+ entity_id: str,
180
+ max_depth: int = 2,
181
+ max_nodes: int = 100
182
+ ) -> Dict[str, Any]:
183
+ """Traverse graph from entity"""
184
+ with self.driver.session() as session:
185
+ result = session.run(
186
+ """
187
+ MATCH path = (start)-[*1..$max_depth]-(connected)
188
+ WHERE elementId(start) = $entity_id
189
+ RETURN path
190
+ LIMIT $max_nodes
191
+ """,
192
+ entity_id=entity_id,
193
+ max_depth=max_depth,
194
+ max_nodes=max_nodes
195
+ )
196
+
197
+ nodes = []
198
+ relationships = []
199
+
200
+ for record in result:
201
+ path = record["path"]
202
+ for node in path.nodes:
203
+ nodes.append({
204
+ "id": node.element_id,
205
+ "labels": list(node.labels),
206
+ "properties": dict(node)
207
+ })
208
+
209
+ for rel in path.relationships:
210
+ relationships.append({
211
+ "type": rel.type,
212
+ "start": rel.start_node.element_id,
213
+ "end": rel.end_node.element_id,
214
+ "properties": dict(rel)
215
+ })
216
+
217
+ return {
218
+ "nodes": nodes,
219
+ "relationships": relationships
220
+ }
221
+
222
+ def _serialize_path(self, path) -> Dict[str, Any]:
223
+ """Serialize Neo4j path to dict"""
224
+ nodes = [
225
+ {
226
+ "id": node.element_id,
227
+ "labels": list(node.labels),
228
+ "properties": dict(node)
229
+ }
230
+ for node in path.nodes
231
+ ]
232
+
233
+ relationships = [
234
+ {
235
+ "type": rel.type,
236
+ "properties": dict(rel)
237
+ }
238
+ for rel in path.relationships
239
+ ]
240
+
241
+ return {
242
+ "nodes": nodes,
243
+ "relationships": relationships
244
+ }
245
+
246
+ class SupplyChainAnalyzer:
247
+ def __init__(self, graph_manager: GraphManager, openai_api_key: str):
248
+ self.graph = graph_manager
249
+ self.client = openai.OpenAI(api_key=openai_api_key)
250
+
251
+ def extract_entities(self, query: str) -> List[Dict[str, Any]]:
252
+ """Extract entities from query using LLM"""
253
+ response = self.client.chat.completions.create(
254
+ model="gpt-4o",
255
+ messages=[
256
+ {
257
+ "role": "system",
258
+ "content": """Extract entities from the query.
259
+
260
+ Entity types: SUPPLIER, PRODUCT, WAREHOUSE, CUSTOMER, ORDER
261
+
262
+ Return JSON array of entities:
263
+ [{"type": "ORDER", "value": "#12345"}, ...]"""
264
+ },
265
+ {
266
+ "role": "user",
267
+ "content": query
268
+ }
269
+ ],
270
+ response_format={"type": "json_object"}
271
+ )
272
+
273
+ import json
274
+ result = json.loads(response.choices[0].message.content)
275
+ return result.get("entities", [])
276
+
277
+ def analyze_query(self, query: str) -> Dict[str, Any]:
278
+ """Analyze supply chain query using graph"""
279
+ # Extract entities from query
280
+ entities = self.extract_entities(query)
281
+
282
+ if not entities:
283
+ return {"answer": "No entities found in query", "graph_context": None}
284
+
285
+ # Get graph context for entities
286
+ graph_contexts = []
287
+ for entity in entities:
288
+ # Find entity in graph
289
+ entity_id = self._find_entity_id(entity)
290
+
291
+ if entity_id:
292
+ # Traverse graph from entity
293
+ subgraph = self.graph.traverse_from_entity(
294
+ entity_id=entity_id,
295
+ max_depth=3,
296
+ max_nodes=100
297
+ )
298
+ graph_contexts.append(subgraph)
299
+
300
+ # Serialize graph to natural language
301
+ graph_description = self._serialize_graph_to_text(graph_contexts)
302
+
303
+ # Generate answer using LLM
304
+ answer = self._generate_answer(query, graph_description)
305
+
306
+ return {
307
+ "answer": answer,
308
+ "graph_context": graph_contexts,
309
+ "entities_found": entities
310
+ }
311
+
312
+ def _find_entity_id(self, entity: Dict[str, Any]) -> Optional[str]:
313
+ """Find entity ID in graph"""
314
+ with self.graph.driver.session() as session:
315
+ result = session.run(
316
+ f"""
317
+ MATCH (e:{entity['type']})
318
+ WHERE e.id = $value OR e.name = $value
319
+ RETURN elementId(e) as id
320
+ LIMIT 1
321
+ """,
322
+ value=entity["value"]
323
+ )
324
+
325
+ record = result.single()
326
+ return record["id"] if record else None
327
+
328
+ def _serialize_graph_to_text(self, graph_contexts: List[Dict[str, Any]]) -> str:
329
+ """Convert graph structure to natural language"""
330
+ parts = []
331
+
332
+ for i, context in enumerate(graph_contexts, 1):
333
+ parts.append(f"=== Subgraph {i} ===")
334
+
335
+ # Describe nodes
336
+ parts.append("Entities:")
337
+ for node in context["nodes"][:20]: # Limit to 20 nodes
338
+ labels = ", ".join(node["labels"])
339
+ props = ", ".join(f"{k}={v}" for k, v in node["properties"].items())
340
+ parts.append(f" - {labels}: {props}")
341
+
342
+ # Describe relationships
343
+ parts.append("\nRelationships:")
344
+ for rel in context["relationships"][:20]: # Limit to 20 relationships
345
+ parts.append(f" - {rel['type']}")
346
+
347
+ parts.append("")
348
+
349
+ return "\n".join(parts)
350
+
351
+ def _generate_answer(self, query: str, graph_context: str) -> str:
352
+ """Generate answer using graph context"""
353
+ response = self.client.chat.completions.create(
354
+ model="gpt-4o",
355
+ messages=[
356
+ {
357
+ "role": "system",
358
+ "content": """You are a supply chain analyst.
359
+
360
+ Use the provided graph context to answer questions about:
361
+ - Supplier relationships
362
+ - Product availability
363
+ - Warehouse locations
364
+ - Order fulfillment
365
+ - Dependencies
366
+
367
+ Be specific and cite entities from the graph."""
368
+ },
369
+ {
370
+ "role": "user",
371
+ "content": f"""Graph Context:
372
+ {graph_context}
373
+
374
+ Query: {query}
375
+
376
+ Answer:"""
377
+ }
378
+ ],
379
+ temperature=0.3
380
+ )
381
+
382
+ return response.choices[0].message.content
383
+ ```
384
+
385
+ ---
386
+
387
+ ## Usage Example
388
+
389
+ ```python
390
+ # Initialize graph manager
391
+ graph = GraphManager(
392
+ uri="bolt://localhost:7687",
393
+ user="neo4j",
394
+ password="password"
395
+ )
396
+
397
+ # Create sample supply chain graph
398
+ supplier_id = graph.create_entity("SUPPLIER", {"id": "SUP-001", "name": "Acme Corp"})
399
+ product_id = graph.create_entity("PRODUCT", {"id": "PROD-123", "name": "Widget A"})
400
+ warehouse_id = graph.create_entity("WAREHOUSE", {"id": "WH-001", "location": "New York"})
401
+ order_id = graph.create_entity("ORDER", {"id": "#12345", "status": "pending"})
402
+
403
+ # Create relationships
404
+ graph.create_relationship(supplier_id, product_id, "SUPPLIES", {"quantity": 1000})
405
+ graph.create_relationship(product_id, warehouse_id, "STORED_IN", {"quantity": 500})
406
+ graph.create_relationship(order_id, product_id, "CONTAINS", {"quantity": 10})
407
+
408
+ # Initialize analyzer
409
+ analyzer = SupplyChainAnalyzer(graph, "your-openai-key")
410
+
411
+ # Analyze query
412
+ result = analyzer.analyze_query("Which suppliers can fulfill order #12345?")
413
+
414
+ print(f"Answer: {result['answer']}")
415
+ print(f"\nEntities Found: {result['entities_found']}")
416
+ print(f"Graph Nodes: {len(result['graph_context'][0]['nodes']) if result['graph_context'] else 0}")
417
+
418
+ # Clean up
419
+ graph.close()
420
+ ```
421
+
422
+ ---
423
+
424
+ ## Key Features
425
+
426
+ ### 1. Entity Extraction
427
+ - LLM-based entity recognition
428
+ - Support for multiple entity types
429
+ - Flexible matching (ID or name)
430
+
431
+ ### 2. Graph Traversal
432
+ - Bidirectional BFS algorithm
433
+ - Configurable depth and node limits
434
+ - Path finding between entities
435
+
436
+ ### 3. Relationship Modeling
437
+ - Typed relationships (SUPPLIES, STORED_IN, etc.)
438
+ - Relationship properties
439
+ - Multi-hop reasoning
440
+
441
+ ### 4. Context Serialization
442
+ - Graph → Natural language conversion
443
+ - Structured entity descriptions
444
+ - Relationship summaries
445
+
446
+ ---
447
+
448
+ ## Testing
449
+
450
+ ```python
451
+ import pytest
452
+
453
+ def test_entity_creation():
454
+ graph = GraphManager("bolt://localhost:7687", "neo4j", "password")
455
+
456
+ entity_id = graph.create_entity("SUPPLIER", {"id": "TEST-001", "name": "Test Corp"})
457
+ assert entity_id is not None
458
+
459
+ graph.close()
460
+
461
+ def test_graph_traversal():
462
+ graph = GraphManager("bolt://localhost:7687", "neo4j", "password")
463
+
464
+ # Create test entities
465
+ supplier_id = graph.create_entity("SUPPLIER", {"id": "SUP-TEST"})
466
+ product_id = graph.create_entity("PRODUCT", {"id": "PROD-TEST"})
467
+ graph.create_relationship(supplier_id, product_id, "SUPPLIES")
468
+
469
+ # Traverse
470
+ subgraph = graph.traverse_from_entity(supplier_id, max_depth=2)
471
+
472
+ assert len(subgraph["nodes"]) > 0
473
+ assert len(subgraph["relationships"]) > 0
474
+
475
+ graph.close()
476
+
477
+ def test_entity_extraction():
478
+ analyzer = SupplyChainAnalyzer(None, "your-openai-key")
479
+
480
+ entities = analyzer.extract_entities("Which suppliers can fulfill order #12345?")
481
+
482
+ assert len(entities) > 0
483
+ assert any(e["type"] == "ORDER" for e in entities)
484
+ ```
485
+
486
+ ---
487
+
488
+ ## Best Practices
489
+
490
+ 1. **Entity Modeling**: Define clear entity types and properties
491
+ 2. **Relationship Types**: Use descriptive relationship names
492
+ 3. **Graph Indexing**: Index frequently queried properties
493
+ 4. **Traversal Limits**: Set appropriate depth and node limits
494
+ 5. **Caching**: Cache frequently accessed subgraphs
495
+ 6. **Batch Operations**: Batch entity/relationship creation
496
+ 7. **Schema Validation**: Validate graph schema consistency
497
+ 8. **Monitoring**: Track query performance and graph size
498
+
499
+ ---
500
+
501
+ ## Performance Optimization
502
+
503
+ - **Indexing**: Create indexes on entity IDs and names
504
+ - **Query Optimization**: Use Cypher query profiling
505
+ - **Connection Pooling**: Reuse Neo4j connections
506
+ - **Caching**: Cache subgraph results
507
+ - **Pagination**: Paginate large result sets
508
+ - **Parallel Queries**: Execute independent queries in parallel
509
+
510
+ ---
511
+
512
+ ## Security
513
+
514
+ - **Access Control**: Implement role-based access control
515
+ - **Query Validation**: Sanitize Cypher queries
516
+ - **Encryption**: Encrypt graph data at rest
517
+ - **Audit Logging**: Log all graph modifications
518
+ - **Rate Limiting**: Limit traversal depth and nodes per query
519
+ ```
520
+