@mytechtoday/augment-extensions 0.5.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 (523) 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 +113 -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 +15 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +576 -23
  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/config-system.d.ts +111 -0
  476. package/cli/dist/utils/config-system.d.ts.map +1 -0
  477. package/cli/dist/utils/config-system.js +239 -0
  478. package/cli/dist/utils/config-system.js.map +1 -0
  479. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  480. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  481. package/cli/dist/utils/extractCommandHelp.js +250 -0
  482. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  483. package/cli/dist/utils/hook-system.d.ts +84 -0
  484. package/cli/dist/utils/hook-system.d.ts.map +1 -0
  485. package/cli/dist/utils/hook-system.js +151 -0
  486. package/cli/dist/utils/hook-system.js.map +1 -0
  487. package/cli/dist/utils/inspection-cache.d.ts +56 -0
  488. package/cli/dist/utils/inspection-cache.d.ts.map +1 -0
  489. package/cli/dist/utils/inspection-cache.js +166 -0
  490. package/cli/dist/utils/inspection-cache.js.map +1 -0
  491. package/cli/dist/utils/inspection-handlers.d.ts +75 -0
  492. package/cli/dist/utils/inspection-handlers.d.ts.map +1 -0
  493. package/cli/dist/utils/inspection-handlers.js +171 -0
  494. package/cli/dist/utils/inspection-handlers.js.map +1 -0
  495. package/cli/dist/utils/install-rules.js +55 -55
  496. package/cli/dist/utils/mcp-integration.js +44 -44
  497. package/cli/dist/utils/module-system.d.ts +1 -0
  498. package/cli/dist/utils/module-system.d.ts.map +1 -1
  499. package/cli/dist/utils/module-system.js +8 -3
  500. package/cli/dist/utils/module-system.js.map +1 -1
  501. package/cli/dist/utils/plugin-system.d.ts +133 -0
  502. package/cli/dist/utils/plugin-system.d.ts.map +1 -0
  503. package/cli/dist/utils/plugin-system.js +210 -0
  504. package/cli/dist/utils/plugin-system.js.map +1 -0
  505. package/cli/dist/utils/progress.d.ts +67 -0
  506. package/cli/dist/utils/progress.d.ts.map +1 -0
  507. package/cli/dist/utils/progress.js +146 -0
  508. package/cli/dist/utils/progress.js.map +1 -0
  509. package/cli/dist/utils/rule-install-hooks.js +8 -8
  510. package/cli/dist/utils/stream-reader.d.ts +34 -0
  511. package/cli/dist/utils/stream-reader.d.ts.map +1 -0
  512. package/cli/dist/utils/stream-reader.js +147 -0
  513. package/cli/dist/utils/stream-reader.js.map +1 -0
  514. package/cli/dist/utils/vscode-editor.d.ts +45 -0
  515. package/cli/dist/utils/vscode-editor.d.ts.map +1 -0
  516. package/cli/dist/utils/vscode-editor.js +171 -0
  517. package/cli/dist/utils/vscode-editor.js.map +1 -0
  518. package/cli/dist/utils/vscode-links.d.ts +49 -0
  519. package/cli/dist/utils/vscode-links.d.ts.map +1 -0
  520. package/cli/dist/utils/vscode-links.js +167 -0
  521. package/cli/dist/utils/vscode-links.js.map +1 -0
  522. package/modules.md +667 -630
  523. package/package.json +85 -85
@@ -1,435 +1,435 @@
1
- # Token-Based MCP Example: Legal Contract Analysis
2
-
3
- ## Use Case
4
-
5
- A legal AI assistant that analyzes long contracts (50-200 pages) and answers questions about specific clauses, obligations, and risks.
6
-
7
- **Challenges**:
8
- - Contracts exceed context window (200k tokens)
9
- - Need to maintain context across multiple queries
10
- - Must preserve exact wording for legal accuracy
11
-
12
- ---
13
-
14
- ## Configuration
15
-
16
- ```json
17
- {
18
- "mcp": {
19
- "type": "token",
20
- "contextWindow": {
21
- "modelMaxTokens": 200000,
22
- "outputBuffer": 4096,
23
- "systemPromptTokens": 500,
24
- "effectiveWindow": 195404
25
- },
26
- "chunking": {
27
- "strategy": "sliding_window",
28
- "chunkSize": 4096,
29
- "overlap": 512
30
- },
31
- "summarization": {
32
- "enabled": true,
33
- "hierarchical": true,
34
- "levels": 3
35
- },
36
- "entitySpotlighting": {
37
- "enabled": true,
38
- "entityTypes": ["PARTY", "OBLIGATION", "DATE", "AMOUNT"]
39
- }
40
- }
41
- }
42
- ```
43
-
44
- ---
45
-
46
- ## Architecture
47
-
48
- ```
49
- ┌─────────────────────────────────────────────────────────────┐
50
- │ Legal Contract (150k tokens) │
51
- └─────────────────────────────────────────────────────────────┘
52
-
53
-
54
- ┌─────────────────────────────────────────────────────────────┐
55
- │ Hierarchical Summarization │
56
- │ ┌──────────────────────────────────────────────────────┐ │
57
- │ │ Level 1: Detailed Summary (75k tokens, 50%) │ │
58
- │ └──────────────────────────────────────────────────────┘ │
59
- │ ┌──────────────────────────────────────────────────────┐ │
60
- │ │ Level 2: Medium Summary (30k tokens, 20%) │ │
61
- │ └──────────────────────────────────────────────────────┘ │
62
- │ ┌──────────────────────────────────────────────────────┐ │
63
- │ │ Level 3: Gist (7.5k tokens, 5%) │ │
64
- │ └──────────────────────────────────────────────────────┘ │
65
- └─────────────────────────────────────────────────────────────┘
66
-
67
-
68
- ┌─────────────────────────────────────────────────────────────┐
69
- │ Entity Spotlighting │
70
- │ Parties: Acme Corp, Beta LLC │
71
- │ Key Dates: 2024-01-15 (effective), 2026-01-15 (expiry) │
72
- │ Obligations: Payment terms, Delivery schedule │
73
- │ Amounts: $500,000 (total), $50,000 (monthly) │
74
- └─────────────────────────────────────────────────────────────┘
75
-
76
-
77
- ┌─────────────────────────────────────────────────────────────┐
78
- │ Sliding Window Chunks (4096 tokens each) │
79
- │ Chunk 1: Sections 1-3 (overlap 512) │
80
- │ Chunk 2: Sections 3-5 (overlap 512) │
81
- │ Chunk 3: Sections 5-7 (overlap 512) │
82
- │ ... │
83
- └─────────────────────────────────────────────────────────────┘
84
- ```
85
-
86
- ---
87
-
88
- ## Implementation
89
-
90
- ### Step 1: Document Ingestion
91
-
92
- ```python
93
- import tiktoken
94
-
95
- class LegalContractAnalyzer:
96
- def __init__(self, config):
97
- self.config = config
98
- self.tokenizer = tiktoken.encoding_for_model("gpt-4o")
99
- self.summaries = {}
100
- self.entities = {}
101
- self.chunks = []
102
-
103
- def ingest_contract(self, contract_text: str):
104
- """Ingest and process contract"""
105
- # Step 1: Create hierarchical summaries
106
- self.summaries = self.create_hierarchical_summaries(contract_text)
107
-
108
- # Step 2: Extract entities
109
- self.entities = self.extract_entities(contract_text)
110
-
111
- # Step 3: Create sliding window chunks
112
- self.chunks = self.create_sliding_window_chunks(contract_text)
113
-
114
- print(f"Ingested contract:")
115
- print(f" Original: {self.count_tokens(contract_text)} tokens")
116
- print(f" Level 1 Summary: {self.count_tokens(self.summaries['level_1'])} tokens")
117
- print(f" Level 2 Summary: {self.count_tokens(self.summaries['level_2'])} tokens")
118
- print(f" Level 3 Gist: {self.count_tokens(self.summaries['gist'])} tokens")
119
- print(f" Chunks: {len(self.chunks)}")
120
- print(f" Entities: {len(self.entities)}")
121
-
122
- def count_tokens(self, text: str) -> int:
123
- """Count tokens in text"""
124
- return len(self.tokenizer.encode(text))
125
- ```
126
-
127
- ### Step 2: Hierarchical Summarization
128
-
129
- ```python
130
- def create_hierarchical_summaries(self, text: str):
131
- """Create multi-level summaries"""
132
- summaries = {}
133
- current_text = text
134
-
135
- # Level 1: 50% compression
136
- summaries['level_1'] = self.summarize(
137
- current_text,
138
- max_tokens=int(self.count_tokens(current_text) * 0.5)
139
- )
140
-
141
- # Level 2: 20% compression (of original)
142
- summaries['level_2'] = self.summarize(
143
- summaries['level_1'],
144
- max_tokens=int(self.count_tokens(text) * 0.2)
145
- )
146
-
147
- # Level 3: 5% compression (gist)
148
- summaries['gist'] = self.summarize(
149
- summaries['level_2'],
150
- max_tokens=int(self.count_tokens(text) * 0.05)
151
- )
152
-
153
- return summaries
154
-
155
- def summarize(self, text: str, max_tokens: int):
156
- """Summarize text to target token count"""
157
- prompt = f"""
158
- Summarize the following legal contract to approximately {max_tokens} tokens.
159
- Preserve key parties, obligations, dates, and amounts.
160
- Maintain legal precision.
161
-
162
- Contract: {text}
163
-
164
- Summary:
165
- """
166
-
167
- return llm_call(prompt, max_tokens=max_tokens)
168
- ```
169
-
170
- ### Step 3: Entity Extraction
171
-
172
- ```python
173
- def extract_entities(self, text: str):
174
- """Extract key entities"""
175
- prompt = f"""
176
- Extract key entities from this legal contract:
177
- - Parties (companies, individuals)
178
- - Obligations (what each party must do)
179
- - Dates (effective date, expiry, milestones)
180
- - Amounts (payments, penalties, limits)
181
-
182
- Contract: {text}
183
-
184
- Return as JSON:
185
- {{
186
- "parties": [...],
187
- "obligations": [...],
188
- "dates": [...],
189
- "amounts": [...]
190
- }}
191
- """
192
-
193
- response = llm_call(prompt)
194
- return json.loads(response)
195
- ```
196
-
197
- ---
198
-
199
- ### Step 4: Sliding Window Chunks
200
-
201
- ```python
202
- def create_sliding_window_chunks(self, text: str):
203
- """Create overlapping chunks"""
204
- chunk_size = self.config['chunking']['chunkSize']
205
- overlap = self.config['chunking']['overlap']
206
-
207
- tokens = self.tokenizer.encode(text)
208
- chunks = []
209
- start = 0
210
-
211
- while start < len(tokens):
212
- end = start + chunk_size
213
- chunk_tokens = tokens[start:end]
214
- chunk_text = self.tokenizer.decode(chunk_tokens)
215
-
216
- chunks.append({
217
- 'text': chunk_text,
218
- 'start_token': start,
219
- 'end_token': end,
220
- 'token_count': len(chunk_tokens)
221
- })
222
-
223
- start = end - overlap
224
-
225
- return chunks
226
- ```
227
-
228
- ### Step 5: Query Processing
229
-
230
- ```python
231
- def answer_question(self, question: str):
232
- """Answer question about contract"""
233
- # Allocate token budget
234
- total_budget = self.config['contextWindow']['effectiveWindow']
235
- output_buffer = self.config['contextWindow']['outputBuffer']
236
- available_budget = total_budget - output_buffer
237
-
238
- # Budget allocation
239
- gist_budget = 500
240
- entities_budget = 1000
241
- relevant_chunks_budget = available_budget - gist_budget - entities_budget
242
-
243
- # Build context
244
- context_parts = []
245
-
246
- # 1. Add gist (always included)
247
- context_parts.append(f"Contract Overview:\n{self.summaries['gist']}")
248
-
249
- # 2. Add relevant entities
250
- relevant_entities = self.get_relevant_entities(question)
251
- context_parts.append(f"\nKey Entities:\n{self.format_entities(relevant_entities)}")
252
-
253
- # 3. Find and add relevant chunks
254
- relevant_chunks = self.find_relevant_chunks(question, relevant_chunks_budget)
255
- context_parts.append(f"\nRelevant Sections:\n{self.format_chunks(relevant_chunks)}")
256
-
257
- # Build final prompt
258
- context = '\n'.join(context_parts)
259
- prompt = f"""
260
- Based on the following contract information, answer the question.
261
-
262
- {context}
263
-
264
- Question: {question}
265
-
266
- Answer:
267
- """
268
-
269
- return llm_call(prompt, max_tokens=output_buffer)
270
-
271
- def get_relevant_entities(self, question: str):
272
- """Get entities relevant to question"""
273
- # Simple keyword matching (could use embeddings)
274
- relevant = {}
275
- question_lower = question.lower()
276
-
277
- for entity_type, entities in self.entities.items():
278
- relevant[entity_type] = [
279
- e for e in entities
280
- if any(word in question_lower for word in e.lower().split())
281
- ]
282
-
283
- return relevant
284
-
285
- def find_relevant_chunks(self, question: str, token_budget: int):
286
- """Find most relevant chunks within budget"""
287
- # Score chunks by keyword overlap (could use embeddings)
288
- question_words = set(question.lower().split())
289
- scored_chunks = []
290
-
291
- for chunk in self.chunks:
292
- chunk_words = set(chunk['text'].lower().split())
293
- overlap = len(question_words & chunk_words)
294
- scored_chunks.append((chunk, overlap))
295
-
296
- # Sort by score
297
- scored_chunks.sort(key=lambda x: x[1], reverse=True)
298
-
299
- # Select chunks within budget
300
- selected = []
301
- total_tokens = 0
302
-
303
- for chunk, score in scored_chunks:
304
- if total_tokens + chunk['token_count'] <= token_budget:
305
- selected.append(chunk)
306
- total_tokens += chunk['token_count']
307
- else:
308
- break
309
-
310
- return selected
311
-
312
- def format_entities(self, entities: dict):
313
- """Format entities for context"""
314
- lines = []
315
- for entity_type, entity_list in entities.items():
316
- if entity_list:
317
- lines.append(f"{entity_type}: {', '.join(entity_list)}")
318
- return '\n'.join(lines)
319
-
320
- def format_chunks(self, chunks: list):
321
- """Format chunks for context"""
322
- return '\n\n---\n\n'.join([c['text'] for c in chunks])
323
- ```
324
-
325
- ---
326
-
327
- ## Example Usage
328
-
329
- ```python
330
- # Initialize analyzer
331
- config = {
332
- "contextWindow": {
333
- "modelMaxTokens": 200000,
334
- "outputBuffer": 4096,
335
- "systemPromptTokens": 500,
336
- "effectiveWindow": 195404
337
- },
338
- "chunking": {
339
- "chunkSize": 4096,
340
- "overlap": 512
341
- }
342
- }
343
-
344
- analyzer = LegalContractAnalyzer(config)
345
-
346
- # Ingest contract
347
- with open('contract.txt', 'r') as f:
348
- contract_text = f.read()
349
-
350
- analyzer.ingest_contract(contract_text)
351
-
352
- # Ask questions
353
- questions = [
354
- "What are the payment terms?",
355
- "When does this contract expire?",
356
- "What are Acme Corp's obligations?",
357
- "What are the termination conditions?"
358
- ]
359
-
360
- for question in questions:
361
- print(f"\nQ: {question}")
362
- answer = analyzer.answer_question(question)
363
- print(f"A: {answer}")
364
- ```
365
-
366
- ---
367
-
368
- ## Key Rules Applied
369
-
370
- ### ✅ Context Window Management
371
- - **Rule**: Calculate effective window (model max - output buffer - system prompt)
372
- - **Implementation**: 200k - 4k - 500 = 195,404 tokens available
373
-
374
- ### ✅ Hierarchical Summarization
375
- - **Rule**: Create multi-level summaries for long documents
376
- - **Implementation**: 3 levels (50%, 20%, 5% compression)
377
-
378
- ### ✅ Entity Spotlighting
379
- - **Rule**: Maintain entity reference tables
380
- - **Implementation**: Extract parties, obligations, dates, amounts
381
-
382
- ### ✅ Sliding Windows
383
- - **Rule**: Use overlapping chunks for context continuity
384
- - **Implementation**: 4096 token chunks with 512 token overlap
385
-
386
- ### ✅ Token Budgeting
387
- - **Rule**: Allocate budget across context components
388
- - **Implementation**: Gist (500) + Entities (1000) + Chunks (remaining)
389
-
390
- ---
391
-
392
- ## Performance Metrics
393
-
394
- | Metric | Value |
395
- |--------|-------|
396
- | Original Contract | 150,000 tokens |
397
- | Level 1 Summary | 75,000 tokens (50%) |
398
- | Level 2 Summary | 30,000 tokens (20%) |
399
- | Gist | 7,500 tokens (5%) |
400
- | Number of Chunks | 37 chunks |
401
- | Average Query Context | 8,000 tokens |
402
- | Query Latency | 2-3 seconds |
403
- | Accuracy | 95%+ (preserves exact wording) |
404
-
405
- ---
406
-
407
- ## Benefits
408
-
409
- ✅ **Handles long contracts**: Up to 200k tokens
410
- ✅ **Maintains accuracy**: Preserves exact legal wording
411
- ✅ **Fast queries**: 2-3 second response time
412
- ✅ **Flexible context**: Adapts to question type
413
- ✅ **Cost-effective**: Minimizes token usage
414
-
415
- ---
416
-
417
- ## Limitations
418
-
419
- ❌ **No cross-document analysis**: Single contract only
420
- ❌ **No relationship modeling**: Entities not linked
421
- ❌ **No long-term memory**: Each query is independent
422
- ❌ **Limited semantic search**: Keyword-based chunk selection
423
-
424
- ---
425
-
426
- ## Extensions
427
-
428
- To address limitations, consider:
429
- - **Vector-based MCP**: For semantic chunk retrieval
430
- - **Graph-augmented MCP**: For entity relationships
431
- - **State-based MCP**: For multi-turn conversations
432
- - **Hybrid MCP**: Combine all approaches
433
-
434
- ---
435
-
1
+ # Token-Based MCP Example: Legal Contract Analysis
2
+
3
+ ## Use Case
4
+
5
+ A legal AI assistant that analyzes long contracts (50-200 pages) and answers questions about specific clauses, obligations, and risks.
6
+
7
+ **Challenges**:
8
+ - Contracts exceed context window (200k tokens)
9
+ - Need to maintain context across multiple queries
10
+ - Must preserve exact wording for legal accuracy
11
+
12
+ ---
13
+
14
+ ## Configuration
15
+
16
+ ```json
17
+ {
18
+ "mcp": {
19
+ "type": "token",
20
+ "contextWindow": {
21
+ "modelMaxTokens": 200000,
22
+ "outputBuffer": 4096,
23
+ "systemPromptTokens": 500,
24
+ "effectiveWindow": 195404
25
+ },
26
+ "chunking": {
27
+ "strategy": "sliding_window",
28
+ "chunkSize": 4096,
29
+ "overlap": 512
30
+ },
31
+ "summarization": {
32
+ "enabled": true,
33
+ "hierarchical": true,
34
+ "levels": 3
35
+ },
36
+ "entitySpotlighting": {
37
+ "enabled": true,
38
+ "entityTypes": ["PARTY", "OBLIGATION", "DATE", "AMOUNT"]
39
+ }
40
+ }
41
+ }
42
+ ```
43
+
44
+ ---
45
+
46
+ ## Architecture
47
+
48
+ ```
49
+ ┌─────────────────────────────────────────────────────────────┐
50
+ │ Legal Contract (150k tokens) │
51
+ └─────────────────────────────────────────────────────────────┘
52
+
53
+
54
+ ┌─────────────────────────────────────────────────────────────┐
55
+ │ Hierarchical Summarization │
56
+ │ ┌──────────────────────────────────────────────────────┐ │
57
+ │ │ Level 1: Detailed Summary (75k tokens, 50%) │ │
58
+ │ └──────────────────────────────────────────────────────┘ │
59
+ │ ┌──────────────────────────────────────────────────────┐ │
60
+ │ │ Level 2: Medium Summary (30k tokens, 20%) │ │
61
+ │ └──────────────────────────────────────────────────────┘ │
62
+ │ ┌──────────────────────────────────────────────────────┐ │
63
+ │ │ Level 3: Gist (7.5k tokens, 5%) │ │
64
+ │ └──────────────────────────────────────────────────────┘ │
65
+ └─────────────────────────────────────────────────────────────┘
66
+
67
+
68
+ ┌─────────────────────────────────────────────────────────────┐
69
+ │ Entity Spotlighting │
70
+ │ Parties: Acme Corp, Beta LLC │
71
+ │ Key Dates: 2024-01-15 (effective), 2026-01-15 (expiry) │
72
+ │ Obligations: Payment terms, Delivery schedule │
73
+ │ Amounts: $500,000 (total), $50,000 (monthly) │
74
+ └─────────────────────────────────────────────────────────────┘
75
+
76
+
77
+ ┌─────────────────────────────────────────────────────────────┐
78
+ │ Sliding Window Chunks (4096 tokens each) │
79
+ │ Chunk 1: Sections 1-3 (overlap 512) │
80
+ │ Chunk 2: Sections 3-5 (overlap 512) │
81
+ │ Chunk 3: Sections 5-7 (overlap 512) │
82
+ │ ... │
83
+ └─────────────────────────────────────────────────────────────┘
84
+ ```
85
+
86
+ ---
87
+
88
+ ## Implementation
89
+
90
+ ### Step 1: Document Ingestion
91
+
92
+ ```python
93
+ import tiktoken
94
+
95
+ class LegalContractAnalyzer:
96
+ def __init__(self, config):
97
+ self.config = config
98
+ self.tokenizer = tiktoken.encoding_for_model("gpt-4o")
99
+ self.summaries = {}
100
+ self.entities = {}
101
+ self.chunks = []
102
+
103
+ def ingest_contract(self, contract_text: str):
104
+ """Ingest and process contract"""
105
+ # Step 1: Create hierarchical summaries
106
+ self.summaries = self.create_hierarchical_summaries(contract_text)
107
+
108
+ # Step 2: Extract entities
109
+ self.entities = self.extract_entities(contract_text)
110
+
111
+ # Step 3: Create sliding window chunks
112
+ self.chunks = self.create_sliding_window_chunks(contract_text)
113
+
114
+ print(f"Ingested contract:")
115
+ print(f" Original: {self.count_tokens(contract_text)} tokens")
116
+ print(f" Level 1 Summary: {self.count_tokens(self.summaries['level_1'])} tokens")
117
+ print(f" Level 2 Summary: {self.count_tokens(self.summaries['level_2'])} tokens")
118
+ print(f" Level 3 Gist: {self.count_tokens(self.summaries['gist'])} tokens")
119
+ print(f" Chunks: {len(self.chunks)}")
120
+ print(f" Entities: {len(self.entities)}")
121
+
122
+ def count_tokens(self, text: str) -> int:
123
+ """Count tokens in text"""
124
+ return len(self.tokenizer.encode(text))
125
+ ```
126
+
127
+ ### Step 2: Hierarchical Summarization
128
+
129
+ ```python
130
+ def create_hierarchical_summaries(self, text: str):
131
+ """Create multi-level summaries"""
132
+ summaries = {}
133
+ current_text = text
134
+
135
+ # Level 1: 50% compression
136
+ summaries['level_1'] = self.summarize(
137
+ current_text,
138
+ max_tokens=int(self.count_tokens(current_text) * 0.5)
139
+ )
140
+
141
+ # Level 2: 20% compression (of original)
142
+ summaries['level_2'] = self.summarize(
143
+ summaries['level_1'],
144
+ max_tokens=int(self.count_tokens(text) * 0.2)
145
+ )
146
+
147
+ # Level 3: 5% compression (gist)
148
+ summaries['gist'] = self.summarize(
149
+ summaries['level_2'],
150
+ max_tokens=int(self.count_tokens(text) * 0.05)
151
+ )
152
+
153
+ return summaries
154
+
155
+ def summarize(self, text: str, max_tokens: int):
156
+ """Summarize text to target token count"""
157
+ prompt = f"""
158
+ Summarize the following legal contract to approximately {max_tokens} tokens.
159
+ Preserve key parties, obligations, dates, and amounts.
160
+ Maintain legal precision.
161
+
162
+ Contract: {text}
163
+
164
+ Summary:
165
+ """
166
+
167
+ return llm_call(prompt, max_tokens=max_tokens)
168
+ ```
169
+
170
+ ### Step 3: Entity Extraction
171
+
172
+ ```python
173
+ def extract_entities(self, text: str):
174
+ """Extract key entities"""
175
+ prompt = f"""
176
+ Extract key entities from this legal contract:
177
+ - Parties (companies, individuals)
178
+ - Obligations (what each party must do)
179
+ - Dates (effective date, expiry, milestones)
180
+ - Amounts (payments, penalties, limits)
181
+
182
+ Contract: {text}
183
+
184
+ Return as JSON:
185
+ {{
186
+ "parties": [...],
187
+ "obligations": [...],
188
+ "dates": [...],
189
+ "amounts": [...]
190
+ }}
191
+ """
192
+
193
+ response = llm_call(prompt)
194
+ return json.loads(response)
195
+ ```
196
+
197
+ ---
198
+
199
+ ### Step 4: Sliding Window Chunks
200
+
201
+ ```python
202
+ def create_sliding_window_chunks(self, text: str):
203
+ """Create overlapping chunks"""
204
+ chunk_size = self.config['chunking']['chunkSize']
205
+ overlap = self.config['chunking']['overlap']
206
+
207
+ tokens = self.tokenizer.encode(text)
208
+ chunks = []
209
+ start = 0
210
+
211
+ while start < len(tokens):
212
+ end = start + chunk_size
213
+ chunk_tokens = tokens[start:end]
214
+ chunk_text = self.tokenizer.decode(chunk_tokens)
215
+
216
+ chunks.append({
217
+ 'text': chunk_text,
218
+ 'start_token': start,
219
+ 'end_token': end,
220
+ 'token_count': len(chunk_tokens)
221
+ })
222
+
223
+ start = end - overlap
224
+
225
+ return chunks
226
+ ```
227
+
228
+ ### Step 5: Query Processing
229
+
230
+ ```python
231
+ def answer_question(self, question: str):
232
+ """Answer question about contract"""
233
+ # Allocate token budget
234
+ total_budget = self.config['contextWindow']['effectiveWindow']
235
+ output_buffer = self.config['contextWindow']['outputBuffer']
236
+ available_budget = total_budget - output_buffer
237
+
238
+ # Budget allocation
239
+ gist_budget = 500
240
+ entities_budget = 1000
241
+ relevant_chunks_budget = available_budget - gist_budget - entities_budget
242
+
243
+ # Build context
244
+ context_parts = []
245
+
246
+ # 1. Add gist (always included)
247
+ context_parts.append(f"Contract Overview:\n{self.summaries['gist']}")
248
+
249
+ # 2. Add relevant entities
250
+ relevant_entities = self.get_relevant_entities(question)
251
+ context_parts.append(f"\nKey Entities:\n{self.format_entities(relevant_entities)}")
252
+
253
+ # 3. Find and add relevant chunks
254
+ relevant_chunks = self.find_relevant_chunks(question, relevant_chunks_budget)
255
+ context_parts.append(f"\nRelevant Sections:\n{self.format_chunks(relevant_chunks)}")
256
+
257
+ # Build final prompt
258
+ context = '\n'.join(context_parts)
259
+ prompt = f"""
260
+ Based on the following contract information, answer the question.
261
+
262
+ {context}
263
+
264
+ Question: {question}
265
+
266
+ Answer:
267
+ """
268
+
269
+ return llm_call(prompt, max_tokens=output_buffer)
270
+
271
+ def get_relevant_entities(self, question: str):
272
+ """Get entities relevant to question"""
273
+ # Simple keyword matching (could use embeddings)
274
+ relevant = {}
275
+ question_lower = question.lower()
276
+
277
+ for entity_type, entities in self.entities.items():
278
+ relevant[entity_type] = [
279
+ e for e in entities
280
+ if any(word in question_lower for word in e.lower().split())
281
+ ]
282
+
283
+ return relevant
284
+
285
+ def find_relevant_chunks(self, question: str, token_budget: int):
286
+ """Find most relevant chunks within budget"""
287
+ # Score chunks by keyword overlap (could use embeddings)
288
+ question_words = set(question.lower().split())
289
+ scored_chunks = []
290
+
291
+ for chunk in self.chunks:
292
+ chunk_words = set(chunk['text'].lower().split())
293
+ overlap = len(question_words & chunk_words)
294
+ scored_chunks.append((chunk, overlap))
295
+
296
+ # Sort by score
297
+ scored_chunks.sort(key=lambda x: x[1], reverse=True)
298
+
299
+ # Select chunks within budget
300
+ selected = []
301
+ total_tokens = 0
302
+
303
+ for chunk, score in scored_chunks:
304
+ if total_tokens + chunk['token_count'] <= token_budget:
305
+ selected.append(chunk)
306
+ total_tokens += chunk['token_count']
307
+ else:
308
+ break
309
+
310
+ return selected
311
+
312
+ def format_entities(self, entities: dict):
313
+ """Format entities for context"""
314
+ lines = []
315
+ for entity_type, entity_list in entities.items():
316
+ if entity_list:
317
+ lines.append(f"{entity_type}: {', '.join(entity_list)}")
318
+ return '\n'.join(lines)
319
+
320
+ def format_chunks(self, chunks: list):
321
+ """Format chunks for context"""
322
+ return '\n\n---\n\n'.join([c['text'] for c in chunks])
323
+ ```
324
+
325
+ ---
326
+
327
+ ## Example Usage
328
+
329
+ ```python
330
+ # Initialize analyzer
331
+ config = {
332
+ "contextWindow": {
333
+ "modelMaxTokens": 200000,
334
+ "outputBuffer": 4096,
335
+ "systemPromptTokens": 500,
336
+ "effectiveWindow": 195404
337
+ },
338
+ "chunking": {
339
+ "chunkSize": 4096,
340
+ "overlap": 512
341
+ }
342
+ }
343
+
344
+ analyzer = LegalContractAnalyzer(config)
345
+
346
+ # Ingest contract
347
+ with open('contract.txt', 'r') as f:
348
+ contract_text = f.read()
349
+
350
+ analyzer.ingest_contract(contract_text)
351
+
352
+ # Ask questions
353
+ questions = [
354
+ "What are the payment terms?",
355
+ "When does this contract expire?",
356
+ "What are Acme Corp's obligations?",
357
+ "What are the termination conditions?"
358
+ ]
359
+
360
+ for question in questions:
361
+ print(f"\nQ: {question}")
362
+ answer = analyzer.answer_question(question)
363
+ print(f"A: {answer}")
364
+ ```
365
+
366
+ ---
367
+
368
+ ## Key Rules Applied
369
+
370
+ ### ✅ Context Window Management
371
+ - **Rule**: Calculate effective window (model max - output buffer - system prompt)
372
+ - **Implementation**: 200k - 4k - 500 = 195,404 tokens available
373
+
374
+ ### ✅ Hierarchical Summarization
375
+ - **Rule**: Create multi-level summaries for long documents
376
+ - **Implementation**: 3 levels (50%, 20%, 5% compression)
377
+
378
+ ### ✅ Entity Spotlighting
379
+ - **Rule**: Maintain entity reference tables
380
+ - **Implementation**: Extract parties, obligations, dates, amounts
381
+
382
+ ### ✅ Sliding Windows
383
+ - **Rule**: Use overlapping chunks for context continuity
384
+ - **Implementation**: 4096 token chunks with 512 token overlap
385
+
386
+ ### ✅ Token Budgeting
387
+ - **Rule**: Allocate budget across context components
388
+ - **Implementation**: Gist (500) + Entities (1000) + Chunks (remaining)
389
+
390
+ ---
391
+
392
+ ## Performance Metrics
393
+
394
+ | Metric | Value |
395
+ |--------|-------|
396
+ | Original Contract | 150,000 tokens |
397
+ | Level 1 Summary | 75,000 tokens (50%) |
398
+ | Level 2 Summary | 30,000 tokens (20%) |
399
+ | Gist | 7,500 tokens (5%) |
400
+ | Number of Chunks | 37 chunks |
401
+ | Average Query Context | 8,000 tokens |
402
+ | Query Latency | 2-3 seconds |
403
+ | Accuracy | 95%+ (preserves exact wording) |
404
+
405
+ ---
406
+
407
+ ## Benefits
408
+
409
+ ✅ **Handles long contracts**: Up to 200k tokens
410
+ ✅ **Maintains accuracy**: Preserves exact legal wording
411
+ ✅ **Fast queries**: 2-3 second response time
412
+ ✅ **Flexible context**: Adapts to question type
413
+ ✅ **Cost-effective**: Minimizes token usage
414
+
415
+ ---
416
+
417
+ ## Limitations
418
+
419
+ ❌ **No cross-document analysis**: Single contract only
420
+ ❌ **No relationship modeling**: Entities not linked
421
+ ❌ **No long-term memory**: Each query is independent
422
+ ❌ **Limited semantic search**: Keyword-based chunk selection
423
+
424
+ ---
425
+
426
+ ## Extensions
427
+
428
+ To address limitations, consider:
429
+ - **Vector-based MCP**: For semantic chunk retrieval
430
+ - **Graph-augmented MCP**: For entity relationships
431
+ - **State-based MCP**: For multi-turn conversations
432
+ - **Hybrid MCP**: Combine all approaches
433
+
434
+ ---
435
+