@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,687 +1,687 @@
1
- # Graph-Augmented MCP Guidelines
2
-
3
- ## Overview
4
-
5
- **Graph-augmented MCP** uses knowledge graphs to model entities, relationships, and temporal dynamics. This enables structured reasoning, relationship traversal, and context-aware retrieval.
6
-
7
- **Key Challenge**: Extracting entities and relationships accurately, maintaining graph consistency, and efficiently traversing large graphs.
8
-
9
- ---
10
-
11
- ## 1. Entity Extraction
12
-
13
- ### Named Entity Recognition (NER)
14
-
15
- Extract entities using NER models:
16
-
17
- ```python
18
- import spacy
19
-
20
- def extract_entities_ner(text: str):
21
- """Extract entities using spaCy NER"""
22
- nlp = spacy.load("en_core_web_sm")
23
- doc = nlp(text)
24
-
25
- entities = []
26
- for ent in doc.ents:
27
- entities.append({
28
- 'text': ent.text,
29
- 'type': ent.label_,
30
- 'start': ent.start_char,
31
- 'end': ent.end_char
32
- })
33
-
34
- return entities
35
- ```
36
-
37
- ### LLM-Based Extraction
38
-
39
- Use LLMs for complex entity extraction:
40
-
41
- ```python
42
- def extract_entities_llm(text: str):
43
- """Extract entities using LLM"""
44
- prompt = f"""
45
- Extract all entities from the following text.
46
- For each entity, provide:
47
- - name: The entity name
48
- - type: The entity type (PERSON, ORG, LOCATION, PRODUCT, etc.)
49
- - description: Brief description
50
-
51
- Text: {text}
52
-
53
- Return as JSON array: [{{"name": "...", "type": "...", "description": "..."}}, ...]
54
- """
55
-
56
- response = llm_call(prompt)
57
- entities = json.loads(response)
58
-
59
- return entities
60
- ```
61
-
62
- ### Hybrid Extraction
63
-
64
- Combine NER and LLM:
65
-
66
- ```python
67
- def extract_entities_hybrid(text: str):
68
- """Hybrid entity extraction"""
69
- # Stage 1: NER for common entities
70
- ner_entities = extract_entities_ner(text)
71
-
72
- # Stage 2: LLM for domain-specific entities
73
- llm_entities = extract_entities_llm(text)
74
-
75
- # Merge and deduplicate
76
- all_entities = {}
77
-
78
- for entity in ner_entities:
79
- key = entity['text'].lower()
80
- all_entities[key] = entity
81
-
82
- for entity in llm_entities:
83
- key = entity['name'].lower()
84
- if key not in all_entities:
85
- all_entities[key] = {
86
- 'text': entity['name'],
87
- 'type': entity['type'],
88
- 'description': entity.get('description', '')
89
- }
90
-
91
- return list(all_entities.values())
92
- ```
93
-
94
- **Best Practices**:
95
- - Use NER for speed and common entities
96
- - Use LLM for domain-specific entities
97
- - Combine both for best results
98
- - Validate and deduplicate entities
99
-
100
- ---
101
-
102
- ## 2. Relationship Extraction
103
-
104
- ### Pattern-Based Extraction
105
-
106
- Use dependency parsing:
107
-
108
- ```python
109
- def extract_relationships_pattern(text: str):
110
- """Extract relationships using dependency parsing"""
111
- nlp = spacy.load("en_core_web_sm")
112
- doc = nlp(text)
113
-
114
- relationships = []
115
-
116
- for token in doc:
117
- if token.dep_ in ['nsubj', 'dobj']:
118
- # Subject-Verb-Object pattern
119
- subject = token.text
120
- verb = token.head.text
121
-
122
- # Find object
123
- for child in token.head.children:
124
- if child.dep_ == 'dobj':
125
- obj = child.text
126
- relationships.append({
127
- 'subject': subject,
128
- 'predicate': verb,
129
- 'object': obj
130
- })
131
-
132
- return relationships
133
- ```
134
-
135
- ### LLM-Based Extraction
136
-
137
- Use LLMs for complex relationships:
138
-
139
- ```python
140
- def extract_relationships_llm(text: str, entities: list):
141
- """Extract relationships using LLM"""
142
- entity_names = [e['text'] for e in entities]
143
-
144
- prompt = f"""
145
- Given these entities: {', '.join(entity_names)}
146
-
147
- Extract all relationships from the text.
148
- For each relationship, provide:
149
- - subject: Entity 1
150
- - predicate: Relationship type
151
- - object: Entity 2
152
- - confidence: 0-1 score
153
-
154
- Text: {text}
155
-
156
- Return as JSON array: [{{"subject": "...", "predicate": "...", "object": "...", "confidence": 0.9}}, ...]
157
- """
158
-
159
- response = llm_call(prompt)
160
- relationships = json.loads(response)
161
-
162
- return relationships
163
- ```
164
-
165
- **Best Practices**:
166
- - Extract entities first, then relationships
167
- - Use pattern-based for simple relationships
168
- - Use LLM for complex, domain-specific relationships
169
- - Validate relationship consistency
170
-
171
- ---
172
-
173
- ## 3. Graph Modeling
174
-
175
- ### Graph Schema
176
-
177
- Define graph schema:
178
-
179
- ```python
180
- from pydantic import BaseModel
181
- from typing import List, Dict, Optional
182
- from datetime import datetime
183
-
184
- class Entity(BaseModel):
185
- id: str
186
- name: str
187
- type: str
188
- properties: Dict[str, any] = {}
189
- created_at: datetime
190
- updated_at: datetime
191
-
192
- class Relationship(BaseModel):
193
- id: str
194
- subject_id: str
195
- predicate: str
196
- object_id: str
197
- properties: Dict[str, any] = {}
198
- confidence: float = 1.0
199
- created_at: datetime
200
- updated_at: datetime
201
-
202
- class KnowledgeGraph(BaseModel):
203
- entities: Dict[str, Entity] = {}
204
- relationships: List[Relationship] = []
205
- ```
206
-
207
- ### Graph Construction
208
-
209
- Build graph from text:
210
-
211
- ```python
212
- class GraphBuilder:
213
- """Build knowledge graph from text"""
214
-
215
- def __init__(self):
216
- self.graph = KnowledgeGraph()
217
-
218
- def add_text(self, text: str):
219
- """Add text to graph"""
220
- # Extract entities
221
- entities = extract_entities_hybrid(text)
222
-
223
- # Add entities to graph
224
- for entity in entities:
225
- entity_id = self.generate_id(entity['text'])
226
- if entity_id not in self.graph.entities:
227
- self.graph.entities[entity_id] = Entity(
228
- id=entity_id,
229
- name=entity['text'],
230
- type=entity['type'],
231
- created_at=datetime.now(),
232
- updated_at=datetime.now()
233
- )
234
-
235
- # Extract relationships
236
- relationships = extract_relationships_llm(text, entities)
237
-
238
- # Add relationships to graph
239
- for rel in relationships:
240
- subject_id = self.generate_id(rel['subject'])
241
- object_id = self.generate_id(rel['object'])
242
-
243
- if subject_id in self.graph.entities and object_id in self.graph.entities:
244
- self.graph.relationships.append(Relationship(
245
- id=self.generate_id(f"{subject_id}-{rel['predicate']}-{object_id}"),
246
- subject_id=subject_id,
247
- predicate=rel['predicate'],
248
- object_id=object_id,
249
- confidence=rel.get('confidence', 1.0),
250
- created_at=datetime.now(),
251
- updated_at=datetime.now()
252
- ))
253
-
254
- def generate_id(self, text: str) -> str:
255
- """Generate stable ID from text"""
256
- import hashlib
257
- return hashlib.md5(text.lower().encode()).hexdigest()[:8]
258
- ```
259
-
260
- **Best Practices**:
261
- - Use stable IDs (hash-based)
262
- - Version graph schema
263
- - Validate graph consistency
264
- - Support incremental updates
265
-
266
- ---
267
-
268
- ## 4. Graph Traversal
269
-
270
- ### Breadth-First Search (BFS)
271
-
272
- Find related entities:
273
-
274
- ```python
275
- from collections import deque
276
-
277
- def bfs_traverse(graph: KnowledgeGraph, start_entity_id: str, max_depth=2):
278
- """BFS traversal from start entity"""
279
- visited = set()
280
- queue = deque([(start_entity_id, 0)])
281
- results = []
282
-
283
- while queue:
284
- entity_id, depth = queue.popleft()
285
-
286
- if entity_id in visited or depth > max_depth:
287
- continue
288
-
289
- visited.add(entity_id)
290
-
291
- # Add entity to results
292
- if entity_id in graph.entities:
293
- results.append({
294
- 'entity': graph.entities[entity_id],
295
- 'depth': depth
296
- })
297
-
298
- # Find connected entities
299
- for rel in graph.relationships:
300
- if rel.subject_id == entity_id and rel.object_id not in visited:
301
- queue.append((rel.object_id, depth + 1))
302
- elif rel.object_id == entity_id and rel.subject_id not in visited:
303
- queue.append((rel.subject_id, depth + 1))
304
-
305
- return results
306
- ```
307
-
308
- ### Path Finding
309
-
310
- Find paths between entities:
311
-
312
- ```python
313
- def find_paths(graph: KnowledgeGraph, start_id: str, end_id: str, max_depth=3):
314
- """Find all paths between two entities"""
315
- paths = []
316
-
317
- def dfs(current_id, target_id, path, visited, depth):
318
- if depth > max_depth:
319
- return
320
-
321
- if current_id == target_id:
322
- paths.append(path.copy())
323
- return
324
-
325
- visited.add(current_id)
326
-
327
- # Explore neighbors
328
- for rel in graph.relationships:
329
- next_id = None
330
- if rel.subject_id == current_id and rel.object_id not in visited:
331
- next_id = rel.object_id
332
- elif rel.object_id == current_id and rel.subject_id not in visited:
333
- next_id = rel.subject_id
334
-
335
- if next_id:
336
- path.append((rel, next_id))
337
- dfs(next_id, target_id, path, visited, depth + 1)
338
- path.pop()
339
-
340
- visited.remove(current_id)
341
-
342
- dfs(start_id, end_id, [], set(), 0)
343
- return paths
344
- ```
345
-
346
- ### Subgraph Extraction
347
-
348
- Extract relevant subgraph:
349
-
350
- ```python
351
- def extract_subgraph(graph: KnowledgeGraph, entity_ids: list, max_depth=1):
352
- """Extract subgraph around entities"""
353
- subgraph_entities = set(entity_ids)
354
- subgraph_relationships = []
355
-
356
- # BFS from each entity
357
- for entity_id in entity_ids:
358
- neighbors = bfs_traverse(graph, entity_id, max_depth)
359
- for neighbor in neighbors:
360
- subgraph_entities.add(neighbor['entity'].id)
361
-
362
- # Extract relationships within subgraph
363
- for rel in graph.relationships:
364
- if rel.subject_id in subgraph_entities and rel.object_id in subgraph_entities:
365
- subgraph_relationships.append(rel)
366
-
367
- return KnowledgeGraph(
368
- entities={eid: graph.entities[eid] for eid in subgraph_entities if eid in graph.entities},
369
- relationships=subgraph_relationships
370
- )
371
- ```
372
-
373
- **Best Practices**:
374
- - Limit traversal depth to avoid explosion
375
- - Use BFS for finding nearby entities
376
- - Use DFS for path finding
377
- - Extract subgraphs for context
378
-
379
- ---
380
-
381
- ## 5. Retrieval Strategies
382
-
383
- ### Entity-Based Retrieval
384
-
385
- Retrieve by entity:
386
-
387
- ```python
388
- def retrieve_by_entity(graph: KnowledgeGraph, entity_name: str, max_depth=2):
389
- """Retrieve context around an entity"""
390
- # Find entity
391
- entity_id = None
392
- for eid, entity in graph.entities.items():
393
- if entity.name.lower() == entity_name.lower():
394
- entity_id = eid
395
- break
396
-
397
- if not entity_id:
398
- return []
399
-
400
- # Traverse graph
401
- results = bfs_traverse(graph, entity_id, max_depth)
402
-
403
- # Format results
404
- context = []
405
- for result in results:
406
- entity = result['entity']
407
- depth = result['depth']
408
-
409
- # Find relationships
410
- rels = [r for r in graph.relationships
411
- if r.subject_id == entity.id or r.object_id == entity.id]
412
-
413
- context.append({
414
- 'entity': entity.name,
415
- 'type': entity.type,
416
- 'depth': depth,
417
- 'relationships': [
418
- f"{graph.entities[r.subject_id].name} {r.predicate} {graph.entities[r.object_id].name}"
419
- for r in rels
420
- if r.subject_id in graph.entities and r.object_id in graph.entities
421
- ]
422
- })
423
-
424
- return context
425
- ```
426
-
427
- ### Relationship-Based Retrieval
428
-
429
- Retrieve by relationship type:
430
-
431
- ```python
432
- def retrieve_by_relationship(graph: KnowledgeGraph, predicate: str, limit=10):
433
- """Retrieve entities connected by relationship type"""
434
- results = []
435
-
436
- for rel in graph.relationships:
437
- if rel.predicate.lower() == predicate.lower():
438
- subject = graph.entities.get(rel.subject_id)
439
- obj = graph.entities.get(rel.object_id)
440
-
441
- if subject and obj:
442
- results.append({
443
- 'subject': subject.name,
444
- 'predicate': rel.predicate,
445
- 'object': obj.name,
446
- 'confidence': rel.confidence
447
- })
448
-
449
- if len(results) >= limit:
450
- break
451
-
452
- return results
453
- ```
454
-
455
- **Best Practices**:
456
- - Use entity-based retrieval for specific queries
457
- - Use relationship-based retrieval for pattern queries
458
- - Combine with vector search for best results
459
- - Limit depth and breadth to control context size
460
-
461
- ---
462
-
463
- ## 6. Temporal Decay
464
-
465
- ### Time-Based Weighting
466
-
467
- Weight entities by recency:
468
-
469
- ```python
470
- from datetime import datetime, timedelta
471
- import math
472
-
473
- def apply_temporal_decay(entities: list, decay_rate=0.1):
474
- """Apply temporal decay to entity scores"""
475
- now = datetime.now()
476
-
477
- for entity in entities:
478
- # Calculate age in days
479
- age_days = (now - entity['updated_at']).days
480
-
481
- # Apply exponential decay
482
- decay_factor = math.exp(-decay_rate * age_days)
483
-
484
- # Update score
485
- entity['score'] = entity.get('score', 1.0) * decay_factor
486
-
487
- return sorted(entities, key=lambda x: x['score'], reverse=True)
488
- ```
489
-
490
- ### Sliding Window
491
-
492
- Keep only recent entities:
493
-
494
- ```python
495
- def sliding_window_filter(graph: KnowledgeGraph, window_days=30):
496
- """Filter graph to recent entities"""
497
- cutoff = datetime.now() - timedelta(days=window_days)
498
-
499
- # Filter entities
500
- recent_entities = {
501
- eid: entity
502
- for eid, entity in graph.entities.items()
503
- if entity.updated_at >= cutoff
504
- }
505
-
506
- # Filter relationships
507
- recent_relationships = [
508
- rel for rel in graph.relationships
509
- if rel.updated_at >= cutoff
510
- and rel.subject_id in recent_entities
511
- and rel.object_id in recent_entities
512
- ]
513
-
514
- return KnowledgeGraph(
515
- entities=recent_entities,
516
- relationships=recent_relationships
517
- )
518
- ```
519
-
520
- **Best Practices**:
521
- - Apply temporal decay for long-running agents
522
- - Use sliding windows to limit graph size
523
- - Adjust decay rate based on domain
524
- - Preserve important entities regardless of age
525
-
526
- ---
527
-
528
- ## 7. Graph Database Options
529
-
530
- ### Comparison
531
-
532
- | Database | Type | Scale | Query Language | Features |
533
- |----------|------|-------|----------------|----------|
534
- | **Neo4j** | Native graph | Billions | Cypher | ACID, clustering, visualization |
535
- | **Amazon Neptune** | Managed | Billions | Gremlin/SPARQL | Serverless, high availability |
536
- | **ArangoDB** | Multi-model | Millions | AQL | Document + Graph, flexible |
537
- | **NetworkX** | In-memory | Thousands | Python API | Simple, local, analysis |
538
-
539
- ### Neo4j Example
540
-
541
- ```python
542
- from neo4j import GraphDatabase
543
-
544
- class Neo4jGraph:
545
- def __init__(self, uri, user, password):
546
- self.driver = GraphDatabase.driver(uri, auth=(user, password))
547
-
548
- def add_entity(self, entity: Entity):
549
- """Add entity to Neo4j"""
550
- with self.driver.session() as session:
551
- session.run(
552
- "MERGE (e:Entity {id: $id}) "
553
- "SET e.name = $name, e.type = $type, e.updated_at = datetime()",
554
- id=entity.id, name=entity.name, type=entity.type
555
- )
556
-
557
- def add_relationship(self, rel: Relationship):
558
- """Add relationship to Neo4j"""
559
- with self.driver.session() as session:
560
- session.run(
561
- "MATCH (a:Entity {id: $subject_id}), (b:Entity {id: $object_id}) "
562
- "MERGE (a)-[r:RELATES {predicate: $predicate}]->(b) "
563
- "SET r.confidence = $confidence, r.updated_at = datetime()",
564
- subject_id=rel.subject_id,
565
- object_id=rel.object_id,
566
- predicate=rel.predicate,
567
- confidence=rel.confidence
568
- )
569
-
570
- def traverse(self, entity_id: str, max_depth=2):
571
- """Traverse graph from entity"""
572
- with self.driver.session() as session:
573
- result = session.run(
574
- "MATCH path = (start:Entity {id: $id})-[*1..$depth]-(end:Entity) "
575
- "RETURN path",
576
- id=entity_id, depth=max_depth
577
- )
578
- return [record["path"] for record in result]
579
- ```
580
-
581
- **Best Practices**:
582
- - Use Neo4j for production graph workloads
583
- - Use NetworkX for prototyping and analysis
584
- - Use managed services (Neptune) for scale
585
- - Optimize queries with indexes
586
-
587
- ---
588
-
589
- ## 8. Best Practices
590
-
591
- ### DO
592
-
593
- ✅ **Extract entities accurately**: Use hybrid NER + LLM
594
- ✅ **Validate relationships**: Ensure consistency
595
- ✅ **Limit traversal depth**: Avoid graph explosion
596
- ✅ **Apply temporal decay**: Keep graph relevant
597
- ✅ **Use graph databases**: For large-scale graphs
598
- ✅ **Combine with vector search**: Best of both worlds
599
- ✅ **Version graph schema**: Support evolution
600
- ✅ **Monitor graph size**: Prune periodically
601
-
602
- ### DON'T
603
-
604
- ❌ **Don't extract all entities**: Be selective
605
- ❌ **Don't ignore confidence scores**: Use for filtering
606
- ❌ **Don't traverse entire graph**: Limit scope
607
- ❌ **Don't keep stale entities**: Apply decay
608
- ❌ **Don't use in-memory for large graphs**: Use database
609
- ❌ **Don't forget to deduplicate**: Entities and relationships
610
- ❌ **Don't ignore graph structure**: Leverage relationships
611
-
612
- ---
613
-
614
- ## 9. Common Pitfalls
615
-
616
- ### Graph Explosion
617
-
618
- **Problem**: Graph grows too large, traversal too slow
619
-
620
- **Solution**:
621
- - Limit traversal depth (1-3 hops)
622
- - Apply temporal decay
623
- - Prune low-confidence relationships
624
- - Use subgraph extraction
625
-
626
- ### Poor Entity Extraction
627
-
628
- **Problem**: Missing or incorrect entities
629
-
630
- **Solution**:
631
- - Use hybrid NER + LLM extraction
632
- - Validate entities against schema
633
- - Implement entity resolution (deduplication)
634
- - Use domain-specific models
635
-
636
- ### Relationship Noise
637
-
638
- **Problem**: Too many low-quality relationships
639
-
640
- **Solution**:
641
- - Filter by confidence threshold
642
- - Validate relationship types
643
- - Use pattern-based extraction for precision
644
- - Review and prune periodically
645
-
646
- ---
647
-
648
- ## Configuration Example
649
-
650
- ```json
651
- {
652
- "mcp": {
653
- "type": "graph",
654
- "entityExtraction": {
655
- "method": "hybrid",
656
- "nerModel": "en_core_web_sm",
657
- "llmModel": "gpt-4o-mini",
658
- "confidenceThreshold": 0.7
659
- },
660
- "relationshipExtraction": {
661
- "method": "llm",
662
- "llmModel": "gpt-4o-mini",
663
- "confidenceThreshold": 0.8
664
- },
665
- "graphDatabase": {
666
- "provider": "neo4j",
667
- "uri": "bolt://localhost:7687",
668
- "maxConnections": 50
669
- },
670
- "traversal": {
671
- "maxDepth": 2,
672
- "maxResults": 50
673
- },
674
- "temporalDecay": {
675
- "enabled": true,
676
- "decayRate": 0.1,
677
- "slidingWindowDays": 30
678
- },
679
- "tokenBudget": {
680
- "maxGraphTokens": 2048
681
- }
682
- }
683
- }
684
- ```
685
-
686
- ---
687
-
1
+ # Graph-Augmented MCP Guidelines
2
+
3
+ ## Overview
4
+
5
+ **Graph-augmented MCP** uses knowledge graphs to model entities, relationships, and temporal dynamics. This enables structured reasoning, relationship traversal, and context-aware retrieval.
6
+
7
+ **Key Challenge**: Extracting entities and relationships accurately, maintaining graph consistency, and efficiently traversing large graphs.
8
+
9
+ ---
10
+
11
+ ## 1. Entity Extraction
12
+
13
+ ### Named Entity Recognition (NER)
14
+
15
+ Extract entities using NER models:
16
+
17
+ ```python
18
+ import spacy
19
+
20
+ def extract_entities_ner(text: str):
21
+ """Extract entities using spaCy NER"""
22
+ nlp = spacy.load("en_core_web_sm")
23
+ doc = nlp(text)
24
+
25
+ entities = []
26
+ for ent in doc.ents:
27
+ entities.append({
28
+ 'text': ent.text,
29
+ 'type': ent.label_,
30
+ 'start': ent.start_char,
31
+ 'end': ent.end_char
32
+ })
33
+
34
+ return entities
35
+ ```
36
+
37
+ ### LLM-Based Extraction
38
+
39
+ Use LLMs for complex entity extraction:
40
+
41
+ ```python
42
+ def extract_entities_llm(text: str):
43
+ """Extract entities using LLM"""
44
+ prompt = f"""
45
+ Extract all entities from the following text.
46
+ For each entity, provide:
47
+ - name: The entity name
48
+ - type: The entity type (PERSON, ORG, LOCATION, PRODUCT, etc.)
49
+ - description: Brief description
50
+
51
+ Text: {text}
52
+
53
+ Return as JSON array: [{{"name": "...", "type": "...", "description": "..."}}, ...]
54
+ """
55
+
56
+ response = llm_call(prompt)
57
+ entities = json.loads(response)
58
+
59
+ return entities
60
+ ```
61
+
62
+ ### Hybrid Extraction
63
+
64
+ Combine NER and LLM:
65
+
66
+ ```python
67
+ def extract_entities_hybrid(text: str):
68
+ """Hybrid entity extraction"""
69
+ # Stage 1: NER for common entities
70
+ ner_entities = extract_entities_ner(text)
71
+
72
+ # Stage 2: LLM for domain-specific entities
73
+ llm_entities = extract_entities_llm(text)
74
+
75
+ # Merge and deduplicate
76
+ all_entities = {}
77
+
78
+ for entity in ner_entities:
79
+ key = entity['text'].lower()
80
+ all_entities[key] = entity
81
+
82
+ for entity in llm_entities:
83
+ key = entity['name'].lower()
84
+ if key not in all_entities:
85
+ all_entities[key] = {
86
+ 'text': entity['name'],
87
+ 'type': entity['type'],
88
+ 'description': entity.get('description', '')
89
+ }
90
+
91
+ return list(all_entities.values())
92
+ ```
93
+
94
+ **Best Practices**:
95
+ - Use NER for speed and common entities
96
+ - Use LLM for domain-specific entities
97
+ - Combine both for best results
98
+ - Validate and deduplicate entities
99
+
100
+ ---
101
+
102
+ ## 2. Relationship Extraction
103
+
104
+ ### Pattern-Based Extraction
105
+
106
+ Use dependency parsing:
107
+
108
+ ```python
109
+ def extract_relationships_pattern(text: str):
110
+ """Extract relationships using dependency parsing"""
111
+ nlp = spacy.load("en_core_web_sm")
112
+ doc = nlp(text)
113
+
114
+ relationships = []
115
+
116
+ for token in doc:
117
+ if token.dep_ in ['nsubj', 'dobj']:
118
+ # Subject-Verb-Object pattern
119
+ subject = token.text
120
+ verb = token.head.text
121
+
122
+ # Find object
123
+ for child in token.head.children:
124
+ if child.dep_ == 'dobj':
125
+ obj = child.text
126
+ relationships.append({
127
+ 'subject': subject,
128
+ 'predicate': verb,
129
+ 'object': obj
130
+ })
131
+
132
+ return relationships
133
+ ```
134
+
135
+ ### LLM-Based Extraction
136
+
137
+ Use LLMs for complex relationships:
138
+
139
+ ```python
140
+ def extract_relationships_llm(text: str, entities: list):
141
+ """Extract relationships using LLM"""
142
+ entity_names = [e['text'] for e in entities]
143
+
144
+ prompt = f"""
145
+ Given these entities: {', '.join(entity_names)}
146
+
147
+ Extract all relationships from the text.
148
+ For each relationship, provide:
149
+ - subject: Entity 1
150
+ - predicate: Relationship type
151
+ - object: Entity 2
152
+ - confidence: 0-1 score
153
+
154
+ Text: {text}
155
+
156
+ Return as JSON array: [{{"subject": "...", "predicate": "...", "object": "...", "confidence": 0.9}}, ...]
157
+ """
158
+
159
+ response = llm_call(prompt)
160
+ relationships = json.loads(response)
161
+
162
+ return relationships
163
+ ```
164
+
165
+ **Best Practices**:
166
+ - Extract entities first, then relationships
167
+ - Use pattern-based for simple relationships
168
+ - Use LLM for complex, domain-specific relationships
169
+ - Validate relationship consistency
170
+
171
+ ---
172
+
173
+ ## 3. Graph Modeling
174
+
175
+ ### Graph Schema
176
+
177
+ Define graph schema:
178
+
179
+ ```python
180
+ from pydantic import BaseModel
181
+ from typing import List, Dict, Optional
182
+ from datetime import datetime
183
+
184
+ class Entity(BaseModel):
185
+ id: str
186
+ name: str
187
+ type: str
188
+ properties: Dict[str, any] = {}
189
+ created_at: datetime
190
+ updated_at: datetime
191
+
192
+ class Relationship(BaseModel):
193
+ id: str
194
+ subject_id: str
195
+ predicate: str
196
+ object_id: str
197
+ properties: Dict[str, any] = {}
198
+ confidence: float = 1.0
199
+ created_at: datetime
200
+ updated_at: datetime
201
+
202
+ class KnowledgeGraph(BaseModel):
203
+ entities: Dict[str, Entity] = {}
204
+ relationships: List[Relationship] = []
205
+ ```
206
+
207
+ ### Graph Construction
208
+
209
+ Build graph from text:
210
+
211
+ ```python
212
+ class GraphBuilder:
213
+ """Build knowledge graph from text"""
214
+
215
+ def __init__(self):
216
+ self.graph = KnowledgeGraph()
217
+
218
+ def add_text(self, text: str):
219
+ """Add text to graph"""
220
+ # Extract entities
221
+ entities = extract_entities_hybrid(text)
222
+
223
+ # Add entities to graph
224
+ for entity in entities:
225
+ entity_id = self.generate_id(entity['text'])
226
+ if entity_id not in self.graph.entities:
227
+ self.graph.entities[entity_id] = Entity(
228
+ id=entity_id,
229
+ name=entity['text'],
230
+ type=entity['type'],
231
+ created_at=datetime.now(),
232
+ updated_at=datetime.now()
233
+ )
234
+
235
+ # Extract relationships
236
+ relationships = extract_relationships_llm(text, entities)
237
+
238
+ # Add relationships to graph
239
+ for rel in relationships:
240
+ subject_id = self.generate_id(rel['subject'])
241
+ object_id = self.generate_id(rel['object'])
242
+
243
+ if subject_id in self.graph.entities and object_id in self.graph.entities:
244
+ self.graph.relationships.append(Relationship(
245
+ id=self.generate_id(f"{subject_id}-{rel['predicate']}-{object_id}"),
246
+ subject_id=subject_id,
247
+ predicate=rel['predicate'],
248
+ object_id=object_id,
249
+ confidence=rel.get('confidence', 1.0),
250
+ created_at=datetime.now(),
251
+ updated_at=datetime.now()
252
+ ))
253
+
254
+ def generate_id(self, text: str) -> str:
255
+ """Generate stable ID from text"""
256
+ import hashlib
257
+ return hashlib.md5(text.lower().encode()).hexdigest()[:8]
258
+ ```
259
+
260
+ **Best Practices**:
261
+ - Use stable IDs (hash-based)
262
+ - Version graph schema
263
+ - Validate graph consistency
264
+ - Support incremental updates
265
+
266
+ ---
267
+
268
+ ## 4. Graph Traversal
269
+
270
+ ### Breadth-First Search (BFS)
271
+
272
+ Find related entities:
273
+
274
+ ```python
275
+ from collections import deque
276
+
277
+ def bfs_traverse(graph: KnowledgeGraph, start_entity_id: str, max_depth=2):
278
+ """BFS traversal from start entity"""
279
+ visited = set()
280
+ queue = deque([(start_entity_id, 0)])
281
+ results = []
282
+
283
+ while queue:
284
+ entity_id, depth = queue.popleft()
285
+
286
+ if entity_id in visited or depth > max_depth:
287
+ continue
288
+
289
+ visited.add(entity_id)
290
+
291
+ # Add entity to results
292
+ if entity_id in graph.entities:
293
+ results.append({
294
+ 'entity': graph.entities[entity_id],
295
+ 'depth': depth
296
+ })
297
+
298
+ # Find connected entities
299
+ for rel in graph.relationships:
300
+ if rel.subject_id == entity_id and rel.object_id not in visited:
301
+ queue.append((rel.object_id, depth + 1))
302
+ elif rel.object_id == entity_id and rel.subject_id not in visited:
303
+ queue.append((rel.subject_id, depth + 1))
304
+
305
+ return results
306
+ ```
307
+
308
+ ### Path Finding
309
+
310
+ Find paths between entities:
311
+
312
+ ```python
313
+ def find_paths(graph: KnowledgeGraph, start_id: str, end_id: str, max_depth=3):
314
+ """Find all paths between two entities"""
315
+ paths = []
316
+
317
+ def dfs(current_id, target_id, path, visited, depth):
318
+ if depth > max_depth:
319
+ return
320
+
321
+ if current_id == target_id:
322
+ paths.append(path.copy())
323
+ return
324
+
325
+ visited.add(current_id)
326
+
327
+ # Explore neighbors
328
+ for rel in graph.relationships:
329
+ next_id = None
330
+ if rel.subject_id == current_id and rel.object_id not in visited:
331
+ next_id = rel.object_id
332
+ elif rel.object_id == current_id and rel.subject_id not in visited:
333
+ next_id = rel.subject_id
334
+
335
+ if next_id:
336
+ path.append((rel, next_id))
337
+ dfs(next_id, target_id, path, visited, depth + 1)
338
+ path.pop()
339
+
340
+ visited.remove(current_id)
341
+
342
+ dfs(start_id, end_id, [], set(), 0)
343
+ return paths
344
+ ```
345
+
346
+ ### Subgraph Extraction
347
+
348
+ Extract relevant subgraph:
349
+
350
+ ```python
351
+ def extract_subgraph(graph: KnowledgeGraph, entity_ids: list, max_depth=1):
352
+ """Extract subgraph around entities"""
353
+ subgraph_entities = set(entity_ids)
354
+ subgraph_relationships = []
355
+
356
+ # BFS from each entity
357
+ for entity_id in entity_ids:
358
+ neighbors = bfs_traverse(graph, entity_id, max_depth)
359
+ for neighbor in neighbors:
360
+ subgraph_entities.add(neighbor['entity'].id)
361
+
362
+ # Extract relationships within subgraph
363
+ for rel in graph.relationships:
364
+ if rel.subject_id in subgraph_entities and rel.object_id in subgraph_entities:
365
+ subgraph_relationships.append(rel)
366
+
367
+ return KnowledgeGraph(
368
+ entities={eid: graph.entities[eid] for eid in subgraph_entities if eid in graph.entities},
369
+ relationships=subgraph_relationships
370
+ )
371
+ ```
372
+
373
+ **Best Practices**:
374
+ - Limit traversal depth to avoid explosion
375
+ - Use BFS for finding nearby entities
376
+ - Use DFS for path finding
377
+ - Extract subgraphs for context
378
+
379
+ ---
380
+
381
+ ## 5. Retrieval Strategies
382
+
383
+ ### Entity-Based Retrieval
384
+
385
+ Retrieve by entity:
386
+
387
+ ```python
388
+ def retrieve_by_entity(graph: KnowledgeGraph, entity_name: str, max_depth=2):
389
+ """Retrieve context around an entity"""
390
+ # Find entity
391
+ entity_id = None
392
+ for eid, entity in graph.entities.items():
393
+ if entity.name.lower() == entity_name.lower():
394
+ entity_id = eid
395
+ break
396
+
397
+ if not entity_id:
398
+ return []
399
+
400
+ # Traverse graph
401
+ results = bfs_traverse(graph, entity_id, max_depth)
402
+
403
+ # Format results
404
+ context = []
405
+ for result in results:
406
+ entity = result['entity']
407
+ depth = result['depth']
408
+
409
+ # Find relationships
410
+ rels = [r for r in graph.relationships
411
+ if r.subject_id == entity.id or r.object_id == entity.id]
412
+
413
+ context.append({
414
+ 'entity': entity.name,
415
+ 'type': entity.type,
416
+ 'depth': depth,
417
+ 'relationships': [
418
+ f"{graph.entities[r.subject_id].name} {r.predicate} {graph.entities[r.object_id].name}"
419
+ for r in rels
420
+ if r.subject_id in graph.entities and r.object_id in graph.entities
421
+ ]
422
+ })
423
+
424
+ return context
425
+ ```
426
+
427
+ ### Relationship-Based Retrieval
428
+
429
+ Retrieve by relationship type:
430
+
431
+ ```python
432
+ def retrieve_by_relationship(graph: KnowledgeGraph, predicate: str, limit=10):
433
+ """Retrieve entities connected by relationship type"""
434
+ results = []
435
+
436
+ for rel in graph.relationships:
437
+ if rel.predicate.lower() == predicate.lower():
438
+ subject = graph.entities.get(rel.subject_id)
439
+ obj = graph.entities.get(rel.object_id)
440
+
441
+ if subject and obj:
442
+ results.append({
443
+ 'subject': subject.name,
444
+ 'predicate': rel.predicate,
445
+ 'object': obj.name,
446
+ 'confidence': rel.confidence
447
+ })
448
+
449
+ if len(results) >= limit:
450
+ break
451
+
452
+ return results
453
+ ```
454
+
455
+ **Best Practices**:
456
+ - Use entity-based retrieval for specific queries
457
+ - Use relationship-based retrieval for pattern queries
458
+ - Combine with vector search for best results
459
+ - Limit depth and breadth to control context size
460
+
461
+ ---
462
+
463
+ ## 6. Temporal Decay
464
+
465
+ ### Time-Based Weighting
466
+
467
+ Weight entities by recency:
468
+
469
+ ```python
470
+ from datetime import datetime, timedelta
471
+ import math
472
+
473
+ def apply_temporal_decay(entities: list, decay_rate=0.1):
474
+ """Apply temporal decay to entity scores"""
475
+ now = datetime.now()
476
+
477
+ for entity in entities:
478
+ # Calculate age in days
479
+ age_days = (now - entity['updated_at']).days
480
+
481
+ # Apply exponential decay
482
+ decay_factor = math.exp(-decay_rate * age_days)
483
+
484
+ # Update score
485
+ entity['score'] = entity.get('score', 1.0) * decay_factor
486
+
487
+ return sorted(entities, key=lambda x: x['score'], reverse=True)
488
+ ```
489
+
490
+ ### Sliding Window
491
+
492
+ Keep only recent entities:
493
+
494
+ ```python
495
+ def sliding_window_filter(graph: KnowledgeGraph, window_days=30):
496
+ """Filter graph to recent entities"""
497
+ cutoff = datetime.now() - timedelta(days=window_days)
498
+
499
+ # Filter entities
500
+ recent_entities = {
501
+ eid: entity
502
+ for eid, entity in graph.entities.items()
503
+ if entity.updated_at >= cutoff
504
+ }
505
+
506
+ # Filter relationships
507
+ recent_relationships = [
508
+ rel for rel in graph.relationships
509
+ if rel.updated_at >= cutoff
510
+ and rel.subject_id in recent_entities
511
+ and rel.object_id in recent_entities
512
+ ]
513
+
514
+ return KnowledgeGraph(
515
+ entities=recent_entities,
516
+ relationships=recent_relationships
517
+ )
518
+ ```
519
+
520
+ **Best Practices**:
521
+ - Apply temporal decay for long-running agents
522
+ - Use sliding windows to limit graph size
523
+ - Adjust decay rate based on domain
524
+ - Preserve important entities regardless of age
525
+
526
+ ---
527
+
528
+ ## 7. Graph Database Options
529
+
530
+ ### Comparison
531
+
532
+ | Database | Type | Scale | Query Language | Features |
533
+ |----------|------|-------|----------------|----------|
534
+ | **Neo4j** | Native graph | Billions | Cypher | ACID, clustering, visualization |
535
+ | **Amazon Neptune** | Managed | Billions | Gremlin/SPARQL | Serverless, high availability |
536
+ | **ArangoDB** | Multi-model | Millions | AQL | Document + Graph, flexible |
537
+ | **NetworkX** | In-memory | Thousands | Python API | Simple, local, analysis |
538
+
539
+ ### Neo4j Example
540
+
541
+ ```python
542
+ from neo4j import GraphDatabase
543
+
544
+ class Neo4jGraph:
545
+ def __init__(self, uri, user, password):
546
+ self.driver = GraphDatabase.driver(uri, auth=(user, password))
547
+
548
+ def add_entity(self, entity: Entity):
549
+ """Add entity to Neo4j"""
550
+ with self.driver.session() as session:
551
+ session.run(
552
+ "MERGE (e:Entity {id: $id}) "
553
+ "SET e.name = $name, e.type = $type, e.updated_at = datetime()",
554
+ id=entity.id, name=entity.name, type=entity.type
555
+ )
556
+
557
+ def add_relationship(self, rel: Relationship):
558
+ """Add relationship to Neo4j"""
559
+ with self.driver.session() as session:
560
+ session.run(
561
+ "MATCH (a:Entity {id: $subject_id}), (b:Entity {id: $object_id}) "
562
+ "MERGE (a)-[r:RELATES {predicate: $predicate}]->(b) "
563
+ "SET r.confidence = $confidence, r.updated_at = datetime()",
564
+ subject_id=rel.subject_id,
565
+ object_id=rel.object_id,
566
+ predicate=rel.predicate,
567
+ confidence=rel.confidence
568
+ )
569
+
570
+ def traverse(self, entity_id: str, max_depth=2):
571
+ """Traverse graph from entity"""
572
+ with self.driver.session() as session:
573
+ result = session.run(
574
+ "MATCH path = (start:Entity {id: $id})-[*1..$depth]-(end:Entity) "
575
+ "RETURN path",
576
+ id=entity_id, depth=max_depth
577
+ )
578
+ return [record["path"] for record in result]
579
+ ```
580
+
581
+ **Best Practices**:
582
+ - Use Neo4j for production graph workloads
583
+ - Use NetworkX for prototyping and analysis
584
+ - Use managed services (Neptune) for scale
585
+ - Optimize queries with indexes
586
+
587
+ ---
588
+
589
+ ## 8. Best Practices
590
+
591
+ ### DO
592
+
593
+ ✅ **Extract entities accurately**: Use hybrid NER + LLM
594
+ ✅ **Validate relationships**: Ensure consistency
595
+ ✅ **Limit traversal depth**: Avoid graph explosion
596
+ ✅ **Apply temporal decay**: Keep graph relevant
597
+ ✅ **Use graph databases**: For large-scale graphs
598
+ ✅ **Combine with vector search**: Best of both worlds
599
+ ✅ **Version graph schema**: Support evolution
600
+ ✅ **Monitor graph size**: Prune periodically
601
+
602
+ ### DON'T
603
+
604
+ ❌ **Don't extract all entities**: Be selective
605
+ ❌ **Don't ignore confidence scores**: Use for filtering
606
+ ❌ **Don't traverse entire graph**: Limit scope
607
+ ❌ **Don't keep stale entities**: Apply decay
608
+ ❌ **Don't use in-memory for large graphs**: Use database
609
+ ❌ **Don't forget to deduplicate**: Entities and relationships
610
+ ❌ **Don't ignore graph structure**: Leverage relationships
611
+
612
+ ---
613
+
614
+ ## 9. Common Pitfalls
615
+
616
+ ### Graph Explosion
617
+
618
+ **Problem**: Graph grows too large, traversal too slow
619
+
620
+ **Solution**:
621
+ - Limit traversal depth (1-3 hops)
622
+ - Apply temporal decay
623
+ - Prune low-confidence relationships
624
+ - Use subgraph extraction
625
+
626
+ ### Poor Entity Extraction
627
+
628
+ **Problem**: Missing or incorrect entities
629
+
630
+ **Solution**:
631
+ - Use hybrid NER + LLM extraction
632
+ - Validate entities against schema
633
+ - Implement entity resolution (deduplication)
634
+ - Use domain-specific models
635
+
636
+ ### Relationship Noise
637
+
638
+ **Problem**: Too many low-quality relationships
639
+
640
+ **Solution**:
641
+ - Filter by confidence threshold
642
+ - Validate relationship types
643
+ - Use pattern-based extraction for precision
644
+ - Review and prune periodically
645
+
646
+ ---
647
+
648
+ ## Configuration Example
649
+
650
+ ```json
651
+ {
652
+ "mcp": {
653
+ "type": "graph",
654
+ "entityExtraction": {
655
+ "method": "hybrid",
656
+ "nerModel": "en_core_web_sm",
657
+ "llmModel": "gpt-4o-mini",
658
+ "confidenceThreshold": 0.7
659
+ },
660
+ "relationshipExtraction": {
661
+ "method": "llm",
662
+ "llmModel": "gpt-4o-mini",
663
+ "confidenceThreshold": 0.8
664
+ },
665
+ "graphDatabase": {
666
+ "provider": "neo4j",
667
+ "uri": "bolt://localhost:7687",
668
+ "maxConnections": 50
669
+ },
670
+ "traversal": {
671
+ "maxDepth": 2,
672
+ "maxResults": 50
673
+ },
674
+ "temporalDecay": {
675
+ "enabled": true,
676
+ "decayRate": 0.1,
677
+ "slidingWindowDays": 30
678
+ },
679
+ "tokenBudget": {
680
+ "maxGraphTokens": 2048
681
+ }
682
+ }
683
+ }
684
+ ```
685
+
686
+ ---
687
+