@venizia/ignis-docs 0.0.1-1 → 0.0.1-10

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 (173) hide show
  1. package/LICENSE.md +102 -0
  2. package/README.md +459 -0
  3. package/dist/mcp-server/common/config.d.ts +64 -0
  4. package/dist/mcp-server/common/config.d.ts.map +1 -0
  5. package/dist/mcp-server/common/config.js +82 -0
  6. package/dist/mcp-server/common/config.js.map +1 -0
  7. package/dist/mcp-server/common/index.d.ts +3 -0
  8. package/dist/mcp-server/common/index.d.ts.map +1 -0
  9. package/dist/mcp-server/common/index.js.map +1 -0
  10. package/dist/mcp-server/common/paths.d.ts.map +1 -0
  11. package/{mcp-server/dist → dist/mcp-server}/common/paths.js +13 -11
  12. package/dist/mcp-server/common/paths.js.map +1 -0
  13. package/{mcp-server/dist → dist/mcp-server}/helpers/docs.helper.d.ts +5 -5
  14. package/dist/mcp-server/helpers/docs.helper.d.ts.map +1 -0
  15. package/{mcp-server/dist → dist/mcp-server}/helpers/docs.helper.js +38 -34
  16. package/dist/mcp-server/helpers/docs.helper.js.map +1 -0
  17. package/dist/mcp-server/helpers/github.helper.d.ts +37 -0
  18. package/dist/mcp-server/helpers/github.helper.d.ts.map +1 -0
  19. package/dist/mcp-server/helpers/github.helper.js +100 -0
  20. package/dist/mcp-server/helpers/github.helper.js.map +1 -0
  21. package/dist/mcp-server/helpers/index.d.ts +4 -0
  22. package/dist/mcp-server/helpers/index.d.ts.map +1 -0
  23. package/{mcp-server/dist → dist/mcp-server}/helpers/index.js +1 -0
  24. package/dist/mcp-server/helpers/index.js.map +1 -0
  25. package/dist/mcp-server/helpers/logger.helper.d.ts.map +1 -0
  26. package/dist/mcp-server/helpers/logger.helper.js.map +1 -0
  27. package/{mcp-server/dist → dist/mcp-server}/index.d.ts.map +1 -1
  28. package/dist/mcp-server/index.js +90 -0
  29. package/dist/mcp-server/index.js.map +1 -0
  30. package/{mcp-server/dist → dist/mcp-server}/tools/base.tool.d.ts +8 -12
  31. package/dist/mcp-server/tools/base.tool.d.ts.map +1 -0
  32. package/{mcp-server/dist → dist/mcp-server}/tools/base.tool.js +3 -5
  33. package/dist/mcp-server/tools/base.tool.js.map +1 -0
  34. package/{mcp-server/dist/tools/get-doc-content.tool.d.ts → dist/mcp-server/tools/docs/get-document-content.tool.d.ts} +13 -17
  35. package/dist/mcp-server/tools/docs/get-document-content.tool.d.ts.map +1 -0
  36. package/{mcp-server/dist/tools/get-doc-content.tool.js → dist/mcp-server/tools/docs/get-document-content.tool.js} +20 -22
  37. package/dist/mcp-server/tools/docs/get-document-content.tool.js.map +1 -0
  38. package/{mcp-server/dist/tools/get-doc-metadata.tool.d.ts → dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts} +21 -25
  39. package/dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts.map +1 -0
  40. package/{mcp-server/dist/tools/get-doc-metadata.tool.js → dist/mcp-server/tools/docs/get-document-metadata.tool.js} +35 -27
  41. package/dist/mcp-server/tools/docs/get-document-metadata.tool.js.map +1 -0
  42. package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts +50 -0
  43. package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts.map +1 -0
  44. package/dist/mcp-server/tools/docs/get-package-overview.tool.js +221 -0
  45. package/dist/mcp-server/tools/docs/get-package-overview.tool.js.map +1 -0
  46. package/dist/mcp-server/tools/docs/index.d.ts +7 -0
  47. package/dist/mcp-server/tools/docs/index.d.ts.map +1 -0
  48. package/dist/mcp-server/tools/docs/index.js +23 -0
  49. package/dist/mcp-server/tools/docs/index.js.map +1 -0
  50. package/{mcp-server/dist/tools → dist/mcp-server/tools/docs}/list-categories.tool.d.ts +3 -3
  51. package/dist/mcp-server/tools/docs/list-categories.tool.d.ts.map +1 -0
  52. package/{mcp-server/dist/tools → dist/mcp-server/tools/docs}/list-categories.tool.js +10 -9
  53. package/dist/mcp-server/tools/docs/list-categories.tool.js.map +1 -0
  54. package/{mcp-server/dist/tools/list-docs.tool.d.ts → dist/mcp-server/tools/docs/list-documents.tool.d.ts} +5 -5
  55. package/dist/mcp-server/tools/docs/list-documents.tool.d.ts.map +1 -0
  56. package/{mcp-server/dist/tools/list-docs.tool.js → dist/mcp-server/tools/docs/list-documents.tool.js} +15 -14
  57. package/dist/mcp-server/tools/docs/list-documents.tool.js.map +1 -0
  58. package/{mcp-server/dist/tools/search-docs.tool.d.ts → dist/mcp-server/tools/docs/search-documents.tool.d.ts} +23 -19
  59. package/dist/mcp-server/tools/docs/search-documents.tool.d.ts.map +1 -0
  60. package/{mcp-server/dist/tools/search-docs.tool.js → dist/mcp-server/tools/docs/search-documents.tool.js} +29 -25
  61. package/dist/mcp-server/tools/docs/search-documents.tool.js.map +1 -0
  62. package/dist/mcp-server/tools/github/index.d.ts +5 -0
  63. package/dist/mcp-server/tools/github/index.d.ts.map +1 -0
  64. package/dist/mcp-server/tools/github/index.js +21 -0
  65. package/dist/mcp-server/tools/github/index.js.map +1 -0
  66. package/dist/mcp-server/tools/github/list-project-files.tool.d.ts +28 -0
  67. package/dist/mcp-server/tools/github/list-project-files.tool.d.ts.map +1 -0
  68. package/dist/mcp-server/tools/github/list-project-files.tool.js +98 -0
  69. package/dist/mcp-server/tools/github/list-project-files.tool.js.map +1 -0
  70. package/dist/mcp-server/tools/github/search-code.tool.d.ts +42 -0
  71. package/dist/mcp-server/tools/github/search-code.tool.d.ts.map +1 -0
  72. package/dist/mcp-server/tools/github/search-code.tool.js +194 -0
  73. package/dist/mcp-server/tools/github/search-code.tool.js.map +1 -0
  74. package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts +55 -0
  75. package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts.map +1 -0
  76. package/dist/mcp-server/tools/github/verify-dependencies.tool.js +167 -0
  77. package/dist/mcp-server/tools/github/verify-dependencies.tool.js.map +1 -0
  78. package/dist/mcp-server/tools/github/view-source-file.tool.d.ts +26 -0
  79. package/dist/mcp-server/tools/github/view-source-file.tool.d.ts.map +1 -0
  80. package/dist/mcp-server/tools/github/view-source-file.tool.js +91 -0
  81. package/dist/mcp-server/tools/github/view-source-file.tool.js.map +1 -0
  82. package/dist/mcp-server/tools/index.d.ts +4 -0
  83. package/dist/mcp-server/tools/index.d.ts.map +1 -0
  84. package/dist/mcp-server/tools/index.js +22 -0
  85. package/dist/mcp-server/tools/index.js.map +1 -0
  86. package/package.json +46 -23
  87. package/wiki/changelogs/2025-12-16-initial-architecture.md +145 -0
  88. package/wiki/changelogs/2025-12-16-model-repo-datasource-refactor.md +300 -0
  89. package/wiki/changelogs/2025-12-17-refactor.md +90 -0
  90. package/wiki/changelogs/2025-12-18-performance-optimizations.md +130 -0
  91. package/wiki/changelogs/2025-12-18-repository-validation-security.md +249 -0
  92. package/wiki/changelogs/index.md +33 -0
  93. package/wiki/changelogs/planned-transaction-support.md +216 -0
  94. package/wiki/changelogs/template.md +123 -0
  95. package/wiki/get-started/5-minute-quickstart.md +1 -1
  96. package/wiki/get-started/best-practices/api-usage-examples.md +54 -8
  97. package/wiki/get-started/best-practices/architectural-patterns.md +43 -2
  98. package/wiki/get-started/best-practices/code-style-standards.md +41 -0
  99. package/wiki/get-started/best-practices/common-pitfalls.md +5 -3
  100. package/wiki/get-started/best-practices/contribution-workflow.md +40 -6
  101. package/wiki/get-started/best-practices/data-modeling.md +177 -0
  102. package/wiki/get-started/best-practices/security-guidelines.md +3 -1
  103. package/wiki/get-started/building-a-crud-api.md +63 -78
  104. package/wiki/get-started/core-concepts/components.md +4 -2
  105. package/wiki/get-started/core-concepts/controllers.md +14 -14
  106. package/wiki/get-started/core-concepts/dependency-injection.md +13 -1
  107. package/wiki/get-started/core-concepts/persistent.md +383 -431
  108. package/wiki/get-started/core-concepts/services.md +21 -27
  109. package/wiki/get-started/mcp-docs-server.md +130 -32
  110. package/wiki/get-started/philosophy.md +198 -25
  111. package/wiki/get-started/quickstart.md +1 -1
  112. package/wiki/public/logo.svg +1 -0
  113. package/wiki/references/base/application.md +5 -5
  114. package/wiki/references/base/components.md +1 -1
  115. package/wiki/references/base/controllers.md +43 -17
  116. package/wiki/references/base/datasources.md +195 -33
  117. package/wiki/references/base/dependency-injection.md +8 -7
  118. package/wiki/references/base/models.md +713 -25
  119. package/wiki/references/base/repositories.md +475 -22
  120. package/wiki/references/base/services.md +2 -2
  121. package/wiki/references/components/authentication.md +228 -10
  122. package/wiki/references/components/health-check.md +1 -1
  123. package/wiki/references/components/index.md +4 -2
  124. package/wiki/references/components/static-asset.md +1289 -0
  125. package/wiki/references/components/swagger.md +1 -1
  126. package/wiki/references/helpers/error.md +2 -2
  127. package/wiki/references/helpers/inversion.md +29 -14
  128. package/wiki/references/helpers/storage.md +538 -11
  129. package/wiki/references/src-details/core.md +21 -6
  130. package/wiki/references/src-details/docs.md +19 -9
  131. package/wiki/references/src-details/inversion.md +4 -4
  132. package/wiki/references/src-details/mcp-server.md +185 -234
  133. package/wiki/references/utilities/index.md +1 -1
  134. package/wiki/references/utilities/request.md +162 -3
  135. package/mcp-server/dist/common/config.d.ts +0 -27
  136. package/mcp-server/dist/common/config.d.ts.map +0 -1
  137. package/mcp-server/dist/common/config.js +0 -27
  138. package/mcp-server/dist/common/config.js.map +0 -1
  139. package/mcp-server/dist/common/index.d.ts +0 -3
  140. package/mcp-server/dist/common/index.d.ts.map +0 -1
  141. package/mcp-server/dist/common/index.js.map +0 -1
  142. package/mcp-server/dist/common/paths.d.ts.map +0 -1
  143. package/mcp-server/dist/common/paths.js.map +0 -1
  144. package/mcp-server/dist/helpers/docs.helper.d.ts.map +0 -1
  145. package/mcp-server/dist/helpers/docs.helper.js.map +0 -1
  146. package/mcp-server/dist/helpers/index.d.ts +0 -3
  147. package/mcp-server/dist/helpers/index.d.ts.map +0 -1
  148. package/mcp-server/dist/helpers/index.js.map +0 -1
  149. package/mcp-server/dist/helpers/logger.helper.d.ts.map +0 -1
  150. package/mcp-server/dist/helpers/logger.helper.js.map +0 -1
  151. package/mcp-server/dist/index.js +0 -62
  152. package/mcp-server/dist/index.js.map +0 -1
  153. package/mcp-server/dist/tools/base.tool.d.ts.map +0 -1
  154. package/mcp-server/dist/tools/base.tool.js.map +0 -1
  155. package/mcp-server/dist/tools/get-doc-content.tool.d.ts.map +0 -1
  156. package/mcp-server/dist/tools/get-doc-content.tool.js.map +0 -1
  157. package/mcp-server/dist/tools/get-doc-metadata.tool.d.ts.map +0 -1
  158. package/mcp-server/dist/tools/get-doc-metadata.tool.js.map +0 -1
  159. package/mcp-server/dist/tools/index.d.ts +0 -8
  160. package/mcp-server/dist/tools/index.d.ts.map +0 -1
  161. package/mcp-server/dist/tools/index.js +0 -18
  162. package/mcp-server/dist/tools/index.js.map +0 -1
  163. package/mcp-server/dist/tools/list-categories.tool.d.ts.map +0 -1
  164. package/mcp-server/dist/tools/list-categories.tool.js.map +0 -1
  165. package/mcp-server/dist/tools/list-docs.tool.d.ts.map +0 -1
  166. package/mcp-server/dist/tools/list-docs.tool.js.map +0 -1
  167. package/mcp-server/dist/tools/search-docs.tool.d.ts.map +0 -1
  168. package/mcp-server/dist/tools/search-docs.tool.js.map +0 -1
  169. /package/{mcp-server/dist → dist/mcp-server}/common/index.js +0 -0
  170. /package/{mcp-server/dist → dist/mcp-server}/common/paths.d.ts +0 -0
  171. /package/{mcp-server/dist → dist/mcp-server}/helpers/logger.helper.d.ts +0 -0
  172. /package/{mcp-server/dist → dist/mcp-server}/helpers/logger.helper.js +0 -0
  173. /package/{mcp-server/dist → dist/mcp-server}/index.d.ts +0 -0
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../mcp-server/index.ts"],"names":[],"mappings":";;;AACA,qCAAwC;AACxC,qCAAsC;AACtC,uCAA+C;AAC/C,mCAWiB;AAEjB,+EAA+E;AAC/E,2BAA2B;AAC3B,+EAA+E;AAE/E,MAAM,QAAQ,GAAG;IACf,sBAAsB;IACtB,UAAU,EAAE,IAAI,sBAAc,EAAE,CAAC,OAAO,EAAE;IAC1C,aAAa,EAAE,IAAI,yBAAiB,EAAE,CAAC,OAAO,EAAE;IAChD,QAAQ,EAAE,IAAI,oBAAY,EAAE,CAAC,OAAO,EAAE;IACtC,cAAc,EAAE,IAAI,0BAAkB,EAAE,CAAC,OAAO,EAAE;IAClD,cAAc,EAAE,IAAI,0BAAkB,EAAE,CAAC,OAAO,EAAE;IAClD,kBAAkB,EAAE,IAAI,8BAAsB,EAAE,CAAC,OAAO,EAAE;IAE1D,uBAAuB;IACvB,UAAU,EAAE,IAAI,sBAAc,EAAE,CAAC,OAAO,EAAE;IAC1C,gBAAgB,EAAE,IAAI,4BAAoB,EAAE,CAAC,OAAO,EAAE;IACtD,cAAc,EAAE,IAAI,0BAAkB,EAAE,CAAC,OAAO,EAAE;IAClD,kBAAkB,EAAE,IAAI,8BAAsB,EAAE,CAAC,OAAO,EAAE;CAC3D,CAAC;AAEF,MAAM,aAAa,GAAG;IACpB,aAAa,EAAE,KAAK,IAAI,EAAE;QACxB,MAAM,IAAI,GAAG,MAAM,oBAAU,CAAC,IAAI,EAAE,CAAC;QAErC,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;YACpB,MAAM,SAAS,GAAG,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC;YAElE,OAAO;gBACL,GAAG,EAAE,gBAAgB,GAAG,CAAC,EAAE,EAAE;gBAC7B,IAAI,EAAE,GAAG,CAAC,KAAK;gBACf,WAAW,EAAE,GAAG,GAAG,CAAC,QAAQ,MAAM,SAAS,QAAQ;gBACnD,QAAQ,EAAE,eAAe;aAC1B,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,EAAE,EAAE;QACpC,MAAM,EAAE,GAAG,GAAG,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;QAC5C,MAAM,OAAO,GAAG,MAAM,oBAAU,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;QAE5D,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;YACrB,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,EAAE,EAAE,CAAC;QAC/C,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IAC3B,CAAC;CACF,CAAC;AAEF,MAAM,SAAS,GAAG,IAAI,eAAS,CAAC;IAC9B,IAAI,EAAE,mBAAU,CAAC,MAAM,CAAC,IAAI;IAC5B,OAAO,EAAE,mBAAU,CAAC,MAAM,CAAC,OAAO;IAElC,2CAA2C;IAC3C,KAAK,EAAE,QAAQ;IAEf,+CAA+C;IAC/C,SAAS,EAAE,aAAa;CACzB,CAAC,CAAC;AAEH,+EAA+E;AAC/E,uBAAuB;AACvB,+EAA+E;AAE/E;;;;;GAKG;AACH,MAAM,SAAS,GAAG,GAAuB,EAAE;IACzC,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACnC,MAAM,MAAM,GAAG,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC;IACjC,OAAO,EAAE,MAAM,EAAE,CAAC;AACpB,CAAC,CAAC;AAEF,+EAA+E;AAC/E,wBAAwB;AACxB,+EAA+E;AAE/E,MAAM,IAAI,GAAG,KAAK,IAAI,EAAE;IACtB,2CAA2C;IAC3C,MAAM,EAAE,MAAM,EAAE,GAAG,SAAS,EAAE,CAAC;IAC/B,mBAAU,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAEjC,gBAAM,CAAC,IAAI,CAAC,uDAAuD,CAAC,CAAC;IACrE,gBAAM,CAAC,IAAI,CAAC,yBAAyB,mBAAU,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;IAEjE,IAAI,CAAC;QACH,MAAM,oBAAU,CAAC,IAAI,EAAE,CAAC;QACxB,gBAAM,CAAC,IAAI,CAAC,2CAA2C,CAAC,CAAC;QAEzD,MAAM,SAAS,CAAC,UAAU,EAAE,CAAC;QAC7B,gBAAM,CAAC,IAAI,CAAC,sCAAsC,CAAC,CAAC;IACtD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,gBAAM,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACpC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC;AACH,CAAC,CAAC;AAEF,IAAI,EAAE,CAAC"}
@@ -1,13 +1,9 @@
1
- import { createTool } from "@mastra/core/tools";
2
- import type { z } from "zod";
1
+ import { createTool } from '@mastra/core/tools';
2
+ import type { z } from 'zod';
3
3
  /**
4
4
  * The tool type returned by createTool.
5
5
  */
6
6
  export type TMastraTool = ReturnType<typeof createTool>;
7
- /**
8
- * Re-export createTool for use in subclasses.
9
- */
10
- export { createTool };
11
7
  /**
12
8
  * Abstract base class for all MCP documentation tools.
13
9
  *
@@ -27,11 +23,11 @@ export { createTool };
27
23
  * readonly inputSchema = InputSchema;
28
24
  * readonly outputSchema = OutputSchema;
29
25
  *
30
- * async execute(input: z.infer<typeof InputSchema>) {
26
+ * async execute(opts: z.infer<typeof InputSchema>) {
31
27
  * return { result: 'done' };
32
28
  * }
33
29
  *
34
- * toMastraTool() {
30
+ * getTool() {
35
31
  * return createTool({
36
32
  * id: this.id,
37
33
  * description: this.description,
@@ -43,7 +39,7 @@ export { createTool };
43
39
  * }
44
40
  * ```
45
41
  */
46
- export declare abstract class BaseTool<TInputSchema extends z.ZodType = z.ZodType, TOutputSchema extends z.ZodType = z.ZodType> {
42
+ export declare abstract class BaseTool<TInputSchema extends z.ZodType, TOutputSchema extends z.ZodType> {
47
43
  /**
48
44
  * Unique identifier for the tool.
49
45
  * Used by MCP clients to invoke the tool.
@@ -70,10 +66,10 @@ export declare abstract class BaseTool<TInputSchema extends z.ZodType = z.ZodTyp
70
66
  /**
71
67
  * Executes the tool's main logic.
72
68
  *
73
- * @param input - Validated input matching inputSchema
69
+ * @param opts - Validated options object matching inputSchema
74
70
  * @returns Promise resolving to output matching outputSchema
75
71
  */
76
- abstract execute(input: z.infer<TInputSchema>): Promise<z.infer<TOutputSchema>>;
72
+ abstract execute(opts: z.infer<TInputSchema>): Promise<z.infer<TOutputSchema>>;
77
73
  /**
78
74
  * Converts this tool instance to a Mastra-compatible tool object.
79
75
  * Must be implemented by each subclass to ensure proper type inference.
@@ -82,7 +78,7 @@ export declare abstract class BaseTool<TInputSchema extends z.ZodType = z.ZodTyp
82
78
  *
83
79
  * @example
84
80
  * ```typescript
85
- * toMastraTool() {
81
+ * getTool() {
86
82
  * return createTool({
87
83
  * id: this.id,
88
84
  * description: this.description,
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base.tool.d.ts","sourceRoot":"","sources":["../../../mcp-server/tools/base.tool.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,KAAK,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAM7B;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,OAAO,UAAU,CAAC,CAAC;AAMxD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,8BAAsB,QAAQ,CAAC,YAAY,SAAS,CAAC,CAAC,OAAO,EAAE,aAAa,SAAS,CAAC,CAAC,OAAO;IAC5F;;;;;OAKG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAE7B;;;;OAIG;IACH,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAEtC;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,WAAW,EAAE,YAAY,CAAC;IAE5C;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC;IAE9C;;;;;OAKG;IACH,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;IAE9E;;;;;;;;;;;;;;;;;;OAkBG;IACH,QAAQ,CAAC,OAAO,IAAI,WAAW;CAChC"}
@@ -1,8 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.BaseTool = exports.createTool = void 0;
4
- const tools_1 = require("@mastra/core/tools");
5
- Object.defineProperty(exports, "createTool", { enumerable: true, get: function () { return tools_1.createTool; } });
3
+ exports.BaseTool = void 0;
6
4
  // ============================================================================
7
5
  // BASE TOOL CLASS
8
6
  // ============================================================================
@@ -25,11 +23,11 @@ Object.defineProperty(exports, "createTool", { enumerable: true, get: function (
25
23
  * readonly inputSchema = InputSchema;
26
24
  * readonly outputSchema = OutputSchema;
27
25
  *
28
- * async execute(input: z.infer<typeof InputSchema>) {
26
+ * async execute(opts: z.infer<typeof InputSchema>) {
29
27
  * return { result: 'done' };
30
28
  * }
31
29
  *
32
- * toMastraTool() {
30
+ * getTool() {
33
31
  * return createTool({
34
32
  * id: this.id,
35
33
  * description: this.description,
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base.tool.js","sourceRoot":"","sources":["../../../mcp-server/tools/base.tool.ts"],"names":[],"mappings":";;;AAYA,+EAA+E;AAC/E,kBAAkB;AAClB,+EAA+E;AAE/E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAsB,QAAQ;CAwD7B;AAxDD,4BAwDC"}
@@ -1,30 +1,26 @@
1
- import { z } from "zod";
2
- import { BaseTool, type TMastraTool } from "./base.tool";
1
+ import { z } from 'zod';
2
+ import { BaseTool, TMastraTool } from '../base.tool';
3
3
  declare const InputSchema: z.ZodObject<{
4
4
  id: z.ZodString;
5
5
  }, z.core.$strip>;
6
- declare const OutputSchema: z.ZodUnion<readonly [z.ZodObject<{
6
+ declare const OutputSchema: z.ZodObject<{
7
7
  id: z.ZodString;
8
- content: z.ZodString;
9
- }, z.core.$strip>, z.ZodObject<{
10
- id: z.ZodString;
11
- error: z.ZodString;
12
- }, z.core.$strip>]>;
8
+ content: z.ZodOptional<z.ZodString>;
9
+ error: z.ZodOptional<z.ZodString>;
10
+ }, z.core.$strip>;
13
11
  export declare class GetDocContentTool extends BaseTool<typeof InputSchema, typeof OutputSchema> {
14
- readonly id = "getDocContent";
12
+ readonly id = "getDocumentContent";
15
13
  readonly description = "\nRetrieves the complete markdown content of a specific Ignis Framework documentation file.\n\nPURPOSE:\nUse this tool to fetch the full text of a documentation page when you need detailed information\nbeyond what search snippets provide. This is your primary tool for reading documentation content.\n\nWHEN TO USE:\n- After searchDocs returns relevant results and you need full content\n- When user asks for detailed explanation of a specific topic\n- To read code examples, API references, or configuration guides\n- When you need to quote or reference specific documentation sections\n\nWHEN NOT TO USE:\n- Don't use this for discovery - use searchDocs or listDocs first\n- Don't fetch multiple documents blindly - review search results first\n\nDOCUMENT ID FORMAT:\nThe 'id' parameter is the relative file path from the wiki root:\n- \"get-started/quickstart.md\" - Quickstart guide\n- \"references/components/http-server.md\" - HTTP Server component reference\n- \"get-started/core-concepts/dependency-injection.md\" - DI concepts\n\nHOW TO GET VALID IDs:\n1. Use searchDocs to find documents by keyword\n2. Use listDocs to browse all available documents\n3. Use listCategories + listDocs(category) for structured browsing\n\nOUTPUT:\nReturns full markdown content suitable for:\n- Answering user questions with accurate information\n- Extracting code examples\n- Understanding API usage patterns\n- Providing step-by-step guidance\n";
16
14
  readonly inputSchema: z.ZodObject<{
17
15
  id: z.ZodString;
18
16
  }, z.core.$strip>;
19
- readonly outputSchema: z.ZodUnion<readonly [z.ZodObject<{
17
+ readonly outputSchema: z.ZodObject<{
20
18
  id: z.ZodString;
21
- content: z.ZodString;
22
- }, z.core.$strip>, z.ZodObject<{
23
- id: z.ZodString;
24
- error: z.ZodString;
25
- }, z.core.$strip>]>;
26
- execute(input: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
19
+ content: z.ZodOptional<z.ZodString>;
20
+ error: z.ZodOptional<z.ZodString>;
21
+ }, z.core.$strip>;
22
+ execute(opts: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
27
23
  getTool(): TMastraTool;
28
24
  }
29
25
  export {};
30
- //# sourceMappingURL=get-doc-content.tool.d.ts.map
26
+ //# sourceMappingURL=get-document-content.tool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-document-content.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/docs/get-document-content.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAqFrD,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;iBAOhB,CAAC;AAMH,qBAAa,iBAAkB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACtF,QAAQ,CAAC,EAAE,wBAAwB;IACnC,QAAQ,CAAC,WAAW,o6CAAoB;IACxC,QAAQ,CAAC,WAAW;;sBAAe;IACnC,QAAQ,CAAC,YAAY;;;;sBAAgB;IAE/B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;IAUvF,OAAO,IAAI,WAAW;CASvB"}
@@ -1,9 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.GetDocContentTool = void 0;
4
+ const tools_1 = require("@mastra/core/tools");
4
5
  const zod_1 = require("zod");
5
- const helpers_1 = require("../helpers");
6
- const base_tool_1 = require("./base.tool");
6
+ const base_tool_1 = require("../base.tool");
7
+ const helpers_1 = require("../../../mcp-server/helpers");
7
8
  // ----------------------------------------------------------------------------
8
9
  // DESCRIPTIONS
9
10
  // ----------------------------------------------------------------------------
@@ -81,47 +82,44 @@ TYPICAL STRUCTURE:
81
82
  // ----------------------------------------------------------------------------
82
83
  // SCHEMAS
83
84
  // ----------------------------------------------------------------------------
84
- const SuccessSchema = zod_1.z.object({
85
- id: zod_1.z.string().describe("The document ID that was requested."),
86
- content: zod_1.z.string().describe(CONTENT_DESCRIPTION),
87
- });
88
- const ErrorSchema = zod_1.z.object({
89
- id: zod_1.z.string().describe("The document ID that was requested but not found."),
90
- error: zod_1.z.string().describe("Error message. Verify the ID using listDocs or searchDocs."),
91
- });
92
85
  const InputSchema = zod_1.z.object({
93
86
  id: zod_1.z.string().min(1).describe(ID_DESCRIPTION),
94
87
  });
95
- const OutputSchema = zod_1.z
96
- .union([SuccessSchema, ErrorSchema])
97
- .describe("Document content on success, or error object if not found.");
88
+ const OutputSchema = zod_1.z.object({
89
+ id: zod_1.z.string().describe('The document ID that was requested.'),
90
+ content: zod_1.z.string().optional().describe(CONTENT_DESCRIPTION),
91
+ error: zod_1.z
92
+ .string()
93
+ .optional()
94
+ .describe('Error message if document not found. Verify the ID using listDocs or searchDocs.'),
95
+ });
98
96
  // ----------------------------------------------------------------------------
99
97
  // TOOL CLASS
100
98
  // ----------------------------------------------------------------------------
101
99
  class GetDocContentTool extends base_tool_1.BaseTool {
102
100
  constructor() {
103
101
  super(...arguments);
104
- this.id = "getDocContent";
102
+ this.id = 'getDocumentContent';
105
103
  this.description = TOOL_DESCRIPTION;
106
104
  this.inputSchema = InputSchema;
107
105
  this.outputSchema = OutputSchema;
108
106
  }
109
- async execute(input) {
110
- const content = await helpers_1.DocsHelper.getDocContent({ id: input.id });
107
+ async execute(opts) {
108
+ const content = await helpers_1.DocsHelper.getDocumentContent({ id: opts.id });
111
109
  if (!content) {
112
- return { error: "Document not found", id: input.id };
110
+ return { error: 'Document not found', id: opts.id };
113
111
  }
114
- return { content, id: input.id };
112
+ return { content, id: opts.id };
115
113
  }
116
114
  getTool() {
117
- return (0, base_tool_1.createTool)({
115
+ return (0, tools_1.createTool)({
118
116
  id: this.id,
119
117
  description: this.description,
120
- inputSchema: InputSchema,
121
- outputSchema: OutputSchema,
118
+ inputSchema: this.inputSchema,
119
+ outputSchema: this.outputSchema,
122
120
  execute: async ({ context }) => this.execute(context),
123
121
  });
124
122
  }
125
123
  }
126
124
  exports.GetDocContentTool = GetDocContentTool;
127
- //# sourceMappingURL=get-doc-content.tool.js.map
125
+ //# sourceMappingURL=get-document-content.tool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-document-content.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/docs/get-document-content.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,4CAAqD;AACrD,kDAAkD;AAElD,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAkCxB,CAAC;AAEF,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;;CAmBtB,CAAC;AAEF,MAAM,mBAAmB,GAAG;;;;;;;;;;;;;;;CAe3B,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAC9D,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,mBAAmB,CAAC;IAC5D,KAAK,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,kFAAkF,CAAC;CAChG,CAAC,CAAC;AAEH,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,iBAAkB,SAAQ,oBAAiD;IAAxF;;QACW,OAAE,GAAG,oBAAoB,CAAC;QAC1B,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IAqBvC,CAAC;IAnBC,KAAK,CAAC,OAAO,CAAC,IAAiC;QAC7C,MAAM,OAAO,GAAG,MAAM,oBAAU,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAErE,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACtD,CAAC;QAED,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;IAClC,CAAC;IAED,OAAO;QACL,OAAO,IAAA,kBAAU,EAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AAzBD,8CAyBC"}
@@ -1,40 +1,36 @@
1
- import { z } from "zod";
2
- import { BaseTool, type TMastraTool } from "./base.tool";
1
+ import { z } from 'zod';
2
+ import { BaseTool, TMastraTool } from '../base.tool';
3
3
  declare const InputSchema: z.ZodObject<{
4
4
  id: z.ZodString;
5
5
  }, z.core.$strip>;
6
- declare const OutputSchema: z.ZodUnion<readonly [z.ZodObject<{
6
+ declare const OutputSchema: z.ZodObject<{
7
7
  id: z.ZodString;
8
- title: z.ZodString;
9
- category: z.ZodString;
10
- wordCount: z.ZodNumber;
11
- charCount: z.ZodNumber;
12
- lastModified: z.ZodOptional<z.ZodDate>;
8
+ title: z.ZodOptional<z.ZodString>;
9
+ category: z.ZodOptional<z.ZodString>;
10
+ wordCount: z.ZodOptional<z.ZodNumber>;
11
+ charCount: z.ZodOptional<z.ZodNumber>;
12
+ lastModified: z.ZodOptional<z.ZodString>;
13
13
  size: z.ZodOptional<z.ZodNumber>;
14
- }, z.core.$strip>, z.ZodObject<{
15
- id: z.ZodString;
16
- error: z.ZodString;
17
- }, z.core.$strip>]>;
14
+ error: z.ZodOptional<z.ZodString>;
15
+ }, z.core.$strip>;
18
16
  export declare class GetDocMetadataTool extends BaseTool<typeof InputSchema, typeof OutputSchema> {
19
- readonly id = "getDocMetadata";
17
+ readonly id = "getDocumentMetadata";
20
18
  readonly description = "\nRetrieves statistical metadata about a specific Ignis Framework documentation file\nwithout fetching its full content.\n\nPURPOSE:\nUse this tool to get information ABOUT a document (size, word count, last modified)\nwithout retrieving the actual content. Useful for assessing documents before reading them fully.\n\nWHEN TO USE:\n- To check document length before fetching full content\n- To estimate reading time or complexity\n- To verify a document exists and get basic info\n- To check when documentation was last updated\n- When you need document stats for comparison or reporting\n\nWHEN NOT TO USE:\n- When you need the actual document content (use getDocContent instead)\n- For searching documents (use searchDocs instead)\n- For listing multiple documents (use listDocs instead)\n\nMETADATA FIELDS EXPLAINED:\n- wordCount: Total words in content body (excludes frontmatter)\n - Quick read: < 500 words\n - Medium: 500-1500 words\n - Long/detailed: > 1500 words\n\n- charCount: Total characters (useful for token estimation)\n - Rough token estimate: charCount / 4 for English text\n\n- lastModified: File modification timestamp\n - Recent = actively maintained documentation\n - Old = may need verification for accuracy\n\n- size: Raw file size in bytes (includes frontmatter YAML)\n\nUSE CASES:\n1. \"Is this document long?\" \u2192 Check wordCount\n2. \"Will this fit in context?\" \u2192 Check charCount, estimate tokens\n3. \"Is this documentation current?\" \u2192 Check lastModified\n4. \"Which document is more detailed?\" \u2192 Compare wordCounts\n";
21
19
  readonly inputSchema: z.ZodObject<{
22
20
  id: z.ZodString;
23
21
  }, z.core.$strip>;
24
- readonly outputSchema: z.ZodUnion<readonly [z.ZodObject<{
22
+ readonly outputSchema: z.ZodObject<{
25
23
  id: z.ZodString;
26
- title: z.ZodString;
27
- category: z.ZodString;
28
- wordCount: z.ZodNumber;
29
- charCount: z.ZodNumber;
30
- lastModified: z.ZodOptional<z.ZodDate>;
24
+ title: z.ZodOptional<z.ZodString>;
25
+ category: z.ZodOptional<z.ZodString>;
26
+ wordCount: z.ZodOptional<z.ZodNumber>;
27
+ charCount: z.ZodOptional<z.ZodNumber>;
28
+ lastModified: z.ZodOptional<z.ZodString>;
31
29
  size: z.ZodOptional<z.ZodNumber>;
32
- }, z.core.$strip>, z.ZodObject<{
33
- id: z.ZodString;
34
- error: z.ZodString;
35
- }, z.core.$strip>]>;
36
- execute(input: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
30
+ error: z.ZodOptional<z.ZodString>;
31
+ }, z.core.$strip>;
32
+ execute(opts: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
37
33
  getTool(): TMastraTool;
38
34
  }
39
35
  export {};
40
- //# sourceMappingURL=get-doc-metadata.tool.d.ts.map
36
+ //# sourceMappingURL=get-document-metadata.tool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-document-metadata.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/docs/get-document-metadata.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAyErD,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;;;;;;iBAmBhB,CAAC;AAMH,qBAAa,kBAAmB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACvF,QAAQ,CAAC,EAAE,yBAAyB;IACpC,QAAQ,CAAC,WAAW,6iDAAoB;IACxC,QAAQ,CAAC,WAAW;;sBAAe;IACnC,QAAQ,CAAC,YAAY;;;;;;;;;sBAAgB;IAE/B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;IAavF,OAAO,IAAI,WAAW;CASvB"}
@@ -1,9 +1,10 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.GetDocMetadataTool = void 0;
4
+ const tools_1 = require("@mastra/core/tools");
4
5
  const zod_1 = require("zod");
5
- const helpers_1 = require("../helpers");
6
- const base_tool_1 = require("./base.tool");
6
+ const base_tool_1 = require("../base.tool");
7
+ const helpers_1 = require("../../../mcp-server/helpers");
7
8
  // ----------------------------------------------------------------------------
8
9
  // DESCRIPTIONS
9
10
  // ----------------------------------------------------------------------------
@@ -70,52 +71,59 @@ IMPORTANT:
70
71
  // ----------------------------------------------------------------------------
71
72
  // SCHEMAS
72
73
  // ----------------------------------------------------------------------------
73
- const SuccessSchema = zod_1.z.object({
74
- id: zod_1.z.string().describe("The document ID that was requested."),
75
- title: zod_1.z.string().describe("Document title from frontmatter or filename."),
76
- category: zod_1.z.string().describe('Document category (e.g., "Getting Started", "References").'),
77
- wordCount: zod_1.z.number().int().describe("Total words. Useful for reading time estimation."),
78
- charCount: zod_1.z.number().int().describe("Total characters. Useful for token estimation."),
79
- lastModified: zod_1.z.date().optional().describe("Last modified timestamp. May be undefined."),
80
- size: zod_1.z.number().int().optional().describe("File size in bytes. May be undefined."),
81
- });
82
- const ErrorSchema = zod_1.z.object({
83
- id: zod_1.z.string().describe("The document ID that was requested but not found."),
84
- error: zod_1.z.string().describe("Error message indicating the document was not found."),
85
- });
86
74
  const InputSchema = zod_1.z.object({
87
75
  id: zod_1.z.string().min(1).describe(ID_DESCRIPTION),
88
76
  });
89
- const OutputSchema = zod_1.z
90
- .union([SuccessSchema, ErrorSchema])
91
- .describe("Document metadata on success, or error object if not found.");
77
+ const OutputSchema = zod_1.z.object({
78
+ id: zod_1.z.string().describe('The document ID that was requested.'),
79
+ title: zod_1.z.string().optional().describe('Document title from frontmatter or filename.'),
80
+ category: zod_1.z
81
+ .string()
82
+ .optional()
83
+ .describe('Document category (e.g., "Getting Started", "References").'),
84
+ wordCount: zod_1.z
85
+ .number()
86
+ .int()
87
+ .optional()
88
+ .describe('Total words. Useful for reading time estimation.'),
89
+ charCount: zod_1.z.number().int().optional().describe('Total characters. Useful for token estimation.'),
90
+ lastModified: zod_1.z
91
+ .string()
92
+ .optional()
93
+ .describe('Last modified timestamp (ISO string). May be undefined.'),
94
+ size: zod_1.z.number().int().optional().describe('File size in bytes. May be undefined.'),
95
+ error: zod_1.z.string().optional().describe('Error message if document not found.'),
96
+ });
92
97
  // ----------------------------------------------------------------------------
93
98
  // TOOL CLASS
94
99
  // ----------------------------------------------------------------------------
95
100
  class GetDocMetadataTool extends base_tool_1.BaseTool {
96
101
  constructor() {
97
102
  super(...arguments);
98
- this.id = "getDocMetadata";
103
+ this.id = 'getDocumentMetadata';
99
104
  this.description = TOOL_DESCRIPTION;
100
105
  this.inputSchema = InputSchema;
101
106
  this.outputSchema = OutputSchema;
102
107
  }
103
- async execute(input) {
104
- const metadata = await helpers_1.DocsHelper.getDocMetadata({ id: input.id });
108
+ async execute(opts) {
109
+ const metadata = await helpers_1.DocsHelper.getDocumentMetadata({ id: opts.id });
105
110
  if (!metadata) {
106
- return { error: "Document not found", id: input.id };
111
+ return { error: 'Document not found', id: opts.id };
107
112
  }
108
- return metadata;
113
+ return {
114
+ ...metadata,
115
+ lastModified: metadata.lastModified?.toISOString(),
116
+ };
109
117
  }
110
118
  getTool() {
111
- return (0, base_tool_1.createTool)({
119
+ return (0, tools_1.createTool)({
112
120
  id: this.id,
113
121
  description: this.description,
114
- inputSchema: InputSchema,
115
- outputSchema: OutputSchema,
122
+ inputSchema: this.inputSchema,
123
+ outputSchema: this.outputSchema,
116
124
  execute: async ({ context }) => this.execute(context),
117
125
  });
118
126
  }
119
127
  }
120
128
  exports.GetDocMetadataTool = GetDocMetadataTool;
121
- //# sourceMappingURL=get-doc-metadata.tool.js.map
129
+ //# sourceMappingURL=get-document-metadata.tool.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-document-metadata.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/docs/get-document-metadata.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,4CAAqD;AACrD,kDAAkD;AAElD,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAwCxB,CAAC;AAEF,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;CAkBtB,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC;CAC/C,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,EAAE,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IAC9D,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,8CAA8C,CAAC;IACrF,QAAQ,EAAE,OAAC;SACR,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,4DAA4D,CAAC;IACzE,SAAS,EAAE,OAAC;SACT,MAAM,EAAE;SACR,GAAG,EAAE;SACL,QAAQ,EAAE;SACV,QAAQ,CAAC,kDAAkD,CAAC;IAC/D,SAAS,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,gDAAgD,CAAC;IACjG,YAAY,EAAE,OAAC;SACZ,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uCAAuC,CAAC;IACnF,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,sCAAsC,CAAC;CAC9E,CAAC,CAAC;AAEH,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,kBAAmB,SAAQ,oBAAiD;IAAzF;;QACW,OAAE,GAAG,qBAAqB,CAAC;QAC3B,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IAwBvC,CAAC;IAtBC,KAAK,CAAC,OAAO,CAAC,IAAiC;QAC7C,MAAM,QAAQ,GAAG,MAAM,oBAAU,CAAC,mBAAmB,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,CAAC;QAEvE,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,EAAE,KAAK,EAAE,oBAAoB,EAAE,EAAE,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC;QACtD,CAAC;QAED,OAAO;YACL,GAAG,QAAQ;YACX,YAAY,EAAE,QAAQ,CAAC,YAAY,EAAE,WAAW,EAAE;SACnD,CAAC;IACJ,CAAC;IAED,OAAO;QACL,OAAO,IAAA,kBAAU,EAAC;YAChB,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,OAAO,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AA5BD,gDA4BC"}
@@ -0,0 +1,50 @@
1
+ import { z } from 'zod';
2
+ import { BaseTool, TMastraTool } from '../base.tool';
3
+ declare const InputSchema: z.ZodObject<{
4
+ packageName: z.ZodOptional<z.ZodString>;
5
+ }, z.core.$strip>;
6
+ declare const OutputSchema: z.ZodObject<{
7
+ packages: z.ZodArray<z.ZodObject<{
8
+ name: z.ZodString;
9
+ npmName: z.ZodString;
10
+ description: z.ZodString;
11
+ directories: z.ZodArray<z.ZodObject<{
12
+ name: z.ZodString;
13
+ purpose: z.ZodString;
14
+ }, z.core.$strip>>;
15
+ content: z.ZodOptional<z.ZodString>;
16
+ }, z.core.$strip>>;
17
+ error: z.ZodOptional<z.ZodString>;
18
+ }, z.core.$strip>;
19
+ export declare class GetPackageOverviewTool extends BaseTool<typeof InputSchema, typeof OutputSchema> {
20
+ readonly id = "getPackageOverview";
21
+ readonly description = "\nReturns an overview of Ignis packages from the source details documentation.\n\nPURPOSE:\nProvides AI agents with comprehensive understanding of the Ignis monorepo structure,\npackage purposes, main exports, and directory layouts. This is essential for helping\nusers understand which package to use for specific features.\n\nWHEN TO USE:\n- When user asks \"what packages does Ignis have?\"\n- When user needs to understand project structure\n- When user asks which package provides a specific feature\n- Before helping user implement a feature (to know where code should go)\n- When user asks about imports or package dependencies\n\nWHEN NOT TO USE:\n- For specific API documentation (use getDocContent with references/ docs)\n- For code examples (use searchCode or getDocContent)\n- For troubleshooting (use searchDocs)\n\nOUTPUT:\nReturns package name, description, main directories, and key components.\nThe content comes from wiki/references/src-details/ documentation.\n";
22
+ readonly inputSchema: z.ZodObject<{
23
+ packageName: z.ZodOptional<z.ZodString>;
24
+ }, z.core.$strip>;
25
+ readonly outputSchema: z.ZodObject<{
26
+ packages: z.ZodArray<z.ZodObject<{
27
+ name: z.ZodString;
28
+ npmName: z.ZodString;
29
+ description: z.ZodString;
30
+ directories: z.ZodArray<z.ZodObject<{
31
+ name: z.ZodString;
32
+ purpose: z.ZodString;
33
+ }, z.core.$strip>>;
34
+ content: z.ZodOptional<z.ZodString>;
35
+ }, z.core.$strip>>;
36
+ error: z.ZodOptional<z.ZodString>;
37
+ }, z.core.$strip>;
38
+ /**
39
+ * Extracts package description from first paragraph after title
40
+ */
41
+ private extractDescription;
42
+ /**
43
+ * Extracts directory table from markdown content
44
+ */
45
+ private extractDirectories;
46
+ execute(opts: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
47
+ getTool(): TMastraTool;
48
+ }
49
+ export {};
50
+ //# sourceMappingURL=get-package-overview.tool.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"get-package-overview.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/docs/get-package-overview.tool.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAgErD,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;;;;;;;;;iBAGhB,CAAC;AAmBH,qBAAa,sBAAuB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IAC3F,QAAQ,CAAC,EAAE,wBAAwB;IACnC,QAAQ,CAAC,WAAW,09BAAoB;IACxC,QAAQ,CAAC,WAAW;;sBAAe;IACnC,QAAQ,CAAC,YAAY;;;;;;;;;;;;sBAAgB;IAErC;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA8B1B;;OAEG;IACH,OAAO,CAAC,kBAAkB;IA0CpB,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,WAAW,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,YAAY,CAAC,CAAC;IAuDvF,OAAO,IAAI,WAAW;CASvB"}