@venizia/ignis-docs 0.0.6-1 → 0.0.6-3
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.
- package/dist/mcp-server/index.js +1 -0
- package/dist/mcp-server/index.js.map +1 -1
- package/dist/mcp-server/tools/base.tool.d.ts +4 -8
- package/dist/mcp-server/tools/base.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/base.tool.js +1 -1
- package/dist/mcp-server/tools/base.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/get-document-content.tool.d.ts +8 -2
- package/dist/mcp-server/tools/docs/get-document-content.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/get-document-content.tool.js +1 -1
- package/dist/mcp-server/tools/docs/get-document-content.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts +13 -2
- package/dist/mcp-server/tools/docs/get-document-metadata.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/get-document-metadata.tool.js +1 -1
- package/dist/mcp-server/tools/docs/get-document-metadata.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts +16 -2
- package/dist/mcp-server/tools/docs/get-package-overview.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/get-package-overview.tool.js +1 -1
- package/dist/mcp-server/tools/docs/get-package-overview.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/list-categories.tool.d.ts +5 -2
- package/dist/mcp-server/tools/docs/list-categories.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/list-categories.tool.js +1 -1
- package/dist/mcp-server/tools/docs/list-categories.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/list-documents.tool.d.ts +11 -2
- package/dist/mcp-server/tools/docs/list-documents.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/list-documents.tool.js +1 -1
- package/dist/mcp-server/tools/docs/list-documents.tool.js.map +1 -1
- package/dist/mcp-server/tools/docs/search-documents.tool.d.ts +13 -2
- package/dist/mcp-server/tools/docs/search-documents.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/docs/search-documents.tool.js +1 -1
- package/dist/mcp-server/tools/docs/search-documents.tool.js.map +1 -1
- package/dist/mcp-server/tools/github/list-project-files.tool.d.ts +9 -2
- package/dist/mcp-server/tools/github/list-project-files.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/github/list-project-files.tool.js +1 -1
- package/dist/mcp-server/tools/github/list-project-files.tool.js.map +1 -1
- package/dist/mcp-server/tools/github/search-code.tool.d.ts +16 -2
- package/dist/mcp-server/tools/github/search-code.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/github/search-code.tool.js +1 -1
- package/dist/mcp-server/tools/github/search-code.tool.js.map +1 -1
- package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts +19 -2
- package/dist/mcp-server/tools/github/verify-dependencies.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/github/verify-dependencies.tool.js +1 -1
- package/dist/mcp-server/tools/github/verify-dependencies.tool.js.map +1 -1
- package/dist/mcp-server/tools/github/view-source-file.tool.d.ts +8 -2
- package/dist/mcp-server/tools/github/view-source-file.tool.d.ts.map +1 -1
- package/dist/mcp-server/tools/github/view-source-file.tool.js +1 -1
- package/dist/mcp-server/tools/github/view-source-file.tool.js.map +1 -1
- package/package.json +68 -54
- package/wiki/guides/reference/mcp-docs-server.md +0 -134
- package/wiki/references/base/controllers.md +11 -8
- package/wiki/references/components/authentication/usage.md +3 -3
- package/wiki/references/components/authorization/api.md +1213 -0
- package/wiki/references/components/authorization/errors.md +387 -0
- package/wiki/references/components/authorization/index.md +712 -0
- package/wiki/references/components/authorization/usage.md +696 -0
- package/wiki/references/components/index.md +2 -0
- package/wiki/references/helpers/index.md +1 -0
- package/wiki/references/helpers/kafka/index.md +305 -0
|
@@ -159,7 +159,7 @@ class VerifyDependenciesTool extends base_tool_1.BaseTool {
|
|
|
159
159
|
description: this.description,
|
|
160
160
|
inputSchema: this.inputSchema,
|
|
161
161
|
outputSchema: this.outputSchema,
|
|
162
|
-
execute: async (
|
|
162
|
+
execute: async (input) => this.execute(input),
|
|
163
163
|
});
|
|
164
164
|
}
|
|
165
165
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"verify-dependencies.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/github/verify-dependencies.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,
|
|
1
|
+
{"version":3,"file":"verify-dependencies.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/github/verify-dependencies.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,4CAAwC;AACxC,kDAA4D;AAE5D,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;;;;CAoBxB,CAAC;AAEF,MAAM,wBAAwB,GAAG;;;;;;;;CAQhC,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,oBAAoB,GAAG,OAAC,CAAC,MAAM,CAAC;IACpC,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,cAAc,EAAE,OAAC,CAAC,MAAM,EAAE;IAC1B,aAAa,EAAE,OAAC,CAAC,MAAM,EAAE;IACzB,UAAU,EAAE,OAAC,CAAC,OAAO,EAAE;CACxB,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;CAC3D,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,YAAY,EAAE,OAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;IACtD,eAAe,EAAE,OAAC,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC,QAAQ,EAAE;IACzD,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CAC7B,CAAC,CAAC;AAOH,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,sBAAuB,SAAQ,oBAAiD;IAA7F;;QACW,OAAE,GAAG,oBAAoB,CAAC;QAC1B,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IA6GvC,CAAC;IA3GS,KAAK,CAAC,gBAAgB,CAAC,IAA6B;QAC1D,IAAI,CAAC;YACH,MAAM,GAAG,GAAG,8BAA8B,IAAI,CAAC,WAAW,SAAS,CAAC;YACpE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;YAClC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;gBACjB,OAAO,SAAS,CAAC;YACnB,CAAC;YACD,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAyB,CAAC;YAC7D,OAAO,IAAI,CAAC,OAAO,IAAI,SAAS,CAAC;QACnC,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAM,CAAC,IAAI,CAAC,sCAAsC,IAAI,CAAC,WAAW,GAAG,EAAE,KAAK,CAAC,CAAC;YAC9E,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAED;;;OAGG;IACK,YAAY,CAAC,IAAyB;QAC5C,gDAAgD;QAChD,IACE,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,YAAY,CAAC;YACrC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC;YAChC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC;YAC9B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;YAC/B,IAAI,CAAC,OAAO,KAAK,GAAG;YACpB,IAAI,CAAC,OAAO,KAAK,QAAQ,EACzB,CAAC;YACD,OAAO,IAAI,CAAC;QACd,CAAC;QAED,gDAAgD;QAChD,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAE9D,mEAAmE;QACnE,0CAA0C;QAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QACjE,OAAO,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAC7C,CAAC;IAEO,KAAK,CAAC,mBAAmB,CAAC,IAAuC;QACvE,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAA2C,EAAE,CAAC;QAC3D,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YACxD,MAAM,aAAa,GAAG,IAAI,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;YAErD,6BAA6B;YAC7B,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAO,CAAC,IAAI,CAAC;oBACX,IAAI;oBACJ,cAAc,EAAE,OAAO;oBACvB,aAAa,EAAE,KAAK;oBACpB,UAAU,EAAE,KAAK;iBAClB,CAAC,CAAC;gBACH,SAAS;YACX,CAAC;YAED,MAAM,aAAa,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC;YACzE,OAAO,CAAC,IAAI,CAAC;gBACX,IAAI;gBACJ,cAAc,EAAE,aAAa;gBAC7B,aAAa;gBACb,UAAU,EAAE,aAAa,KAAK,SAAS,IAAI,aAAa,KAAK,aAAa;aAC3E,CAAC,CAAC;QACL,CAAC;QACD,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAiC;QAC7C,MAAM,eAAe,GAAG,GAAG,IAAI,CAAC,WAAW,eAAe,CAAC;QAC3D,MAAM,MAAM,GAAG,MAAM,sBAAY,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,eAAe,EAAE,CAAC,CAAC;QAEhF,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;YACtB,OAAO,EAAE,KAAK,EAAE,kCAAkC,eAAe,YAAY,MAAM,CAAC,KAAK,EAAE,EAAE,CAAC;QAChG,CAAC;QAED,IAAI,CAAC;YACH,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;YAC/C,MAAM,CAAC,YAAY,EAAE,eAAe,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;gBACxD,IAAI,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,YAAY,EAAE,CAAC;gBAC5D,IAAI,CAAC,mBAAmB,CAAC,EAAE,IAAI,EAAE,WAAW,CAAC,eAAe,EAAE,CAAC;aAChE,CAAC,CAAC;YAEH,OAAO;gBACL,WAAW,EAAE,WAAW,CAAC,IAAI;gBAC7B,YAAY;gBACZ,eAAe;aAChB,CAAC;QACJ,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,gBAAM,CAAC,KAAK,CAAC,uCAAuC,EAAE,KAAK,CAAC,CAAC;YAC7D,OAAO,EAAE,KAAK,EAAE,mCAAmC,eAAe,GAAG,EAAE,CAAC;QAC1E,CAAC;IACH,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,EAAC,KAAK,EAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;SAC5C,CAAC,CAAC;IACL,CAAC;CACF;AAjHD,wDAiHC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { z } from 'zod';
|
|
2
|
-
import { BaseTool
|
|
2
|
+
import { BaseTool } from '../base.tool';
|
|
3
3
|
declare const InputSchema: z.ZodObject<{
|
|
4
4
|
filePath: z.ZodString;
|
|
5
5
|
}, z.core.$strip>;
|
|
@@ -20,7 +20,13 @@ export declare class ViewSourceFileTool extends BaseTool<typeof InputSchema, typ
|
|
|
20
20
|
error: z.ZodOptional<z.ZodString>;
|
|
21
21
|
}, z.core.$strip>;
|
|
22
22
|
execute(opts: z.infer<typeof InputSchema>): Promise<z.infer<typeof OutputSchema>>;
|
|
23
|
-
getTool():
|
|
23
|
+
getTool(): import("@mastra/core/tools", { with: { "resolution-mode": "import" } }).Tool<{
|
|
24
|
+
filePath: string;
|
|
25
|
+
}, {
|
|
26
|
+
filePath: string;
|
|
27
|
+
content?: string | undefined;
|
|
28
|
+
error?: string | undefined;
|
|
29
|
+
}, unknown, unknown, import("@mastra/core/tools", { with: { "resolution-mode": "import" } }).ToolExecutionContext<unknown, unknown, unknown>, "viewSourceFile", unknown>;
|
|
24
30
|
}
|
|
25
31
|
export {};
|
|
26
32
|
//# sourceMappingURL=view-source-file.tool.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"view-source-file.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/github/view-source-file.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"view-source-file.tool.d.ts","sourceRoot":"","sources":["../../../../mcp-server/tools/github/view-source-file.tool.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AA4CxC,QAAA,MAAM,WAAW;;iBAEf,CAAC;AAEH,QAAA,MAAM,YAAY;;;;iBAOhB,CAAC;AAMH,qBAAa,kBAAmB,SAAQ,QAAQ,CAAC,OAAO,WAAW,EAAE,OAAO,YAAY,CAAC;IACvF,QAAQ,CAAC,EAAE,oBAAoB;IAC/B,QAAQ,CAAC,WAAW,kwBAAoB;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;IAgBvF,OAAO;;;;;;;CASR"}
|
|
@@ -83,7 +83,7 @@ class ViewSourceFileTool extends base_tool_1.BaseTool {
|
|
|
83
83
|
description: this.description,
|
|
84
84
|
inputSchema: this.inputSchema,
|
|
85
85
|
outputSchema: this.outputSchema,
|
|
86
|
-
execute: async (
|
|
86
|
+
execute: async (input) => this.execute(input),
|
|
87
87
|
});
|
|
88
88
|
}
|
|
89
89
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"view-source-file.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/github/view-source-file.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,
|
|
1
|
+
{"version":3,"file":"view-source-file.tool.js","sourceRoot":"","sources":["../../../../mcp-server/tools/github/view-source-file.tool.ts"],"names":[],"mappings":";;;AAAA,8CAAgD;AAChD,6BAAwB;AACxB,4CAAwC;AACxC,kDAAoD;AAEpD,+EAA+E;AAC/E,eAAe;AACf,+EAA+E;AAE/E,MAAM,gBAAgB,GAAG;;;;;;;;;;;;;;;;;CAiBxB,CAAC;AAEF,MAAM,qBAAqB,GAAG;;;;;;;;;;;;CAY7B,CAAC;AAEF,+EAA+E;AAC/E,UAAU;AACV,+EAA+E;AAE/E,MAAM,WAAW,GAAG,OAAC,CAAC,MAAM,CAAC;IAC3B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,qBAAqB,CAAC;CAC5D,CAAC,CAAC;AAEH,MAAM,YAAY,GAAG,OAAC,CAAC,MAAM,CAAC;IAC5B,QAAQ,EAAE,OAAC,CAAC,MAAM,EAAE;IACpB,OAAO,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,2CAA2C,CAAC;IACpF,KAAK,EAAE,OAAC;SACL,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,mEAAmE,CAAC;CACjF,CAAC,CAAC;AAEH,+EAA+E;AAC/E,aAAa;AACb,+EAA+E;AAE/E,MAAa,kBAAmB,SAAQ,oBAAiD;IAAzF;;QACW,OAAE,GAAG,gBAAgB,CAAC;QACtB,gBAAW,GAAG,gBAAgB,CAAC;QAC/B,gBAAW,GAAG,WAAW,CAAC;QAC1B,iBAAY,GAAG,YAAY,CAAC;IA2BvC,CAAC;IAzBC,KAAK,CAAC,OAAO,CAAC,IAAiC;QAC7C,MAAM,MAAM,GAAG,MAAM,sBAAY,CAAC,cAAc,CAAC,EAAE,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC;QAE9E,IAAI,OAAO,IAAI,MAAM,EAAE,CAAC;YACtB,OAAO;gBACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;gBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB,CAAC;QACJ,CAAC;QAED,OAAO;YACL,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB,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,EAAC,KAAK,EAAC,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC;SAC5C,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,gDA+BC"}
|
package/package.json
CHANGED
|
@@ -1,34 +1,71 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@venizia/ignis-docs",
|
|
3
|
-
"version": "0.0.6-
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.0.6-3",
|
|
4
|
+
"description": "Interactive documentation site and MCP (Model Context Protocol) server for the Ignis Framework. Includes a VitePress-powered documentation site with guides, API references, and best practices. Ships an MCP server (CLI: ignis-docs-mcp) with 11 tools for AI assistants to search docs, browse source code, verify dependencies, and access real-time framework knowledge. Built with Mastra MCP SDK and Fuse.js fuzzy search.",
|
|
5
5
|
"keywords": [
|
|
6
|
-
"ignis",
|
|
7
|
-
"documentation",
|
|
8
|
-
"docs",
|
|
9
|
-
"guide",
|
|
10
|
-
"wiki",
|
|
11
|
-
"examples",
|
|
12
|
-
"vitepress",
|
|
13
|
-
"mcp",
|
|
14
|
-
"model-context-protocol",
|
|
15
|
-
"mastra",
|
|
16
|
-
"mastra-mcp",
|
|
17
6
|
"ai",
|
|
18
|
-
"ai-
|
|
19
|
-
"llm-gateway",
|
|
20
|
-
"model-router",
|
|
7
|
+
"ai-assistant",
|
|
21
8
|
"ai-development",
|
|
22
|
-
"
|
|
23
|
-
"
|
|
9
|
+
"ai-tools",
|
|
10
|
+
"api-docs",
|
|
11
|
+
"api-reference",
|
|
12
|
+
"bun",
|
|
13
|
+
"claude",
|
|
14
|
+
"claude-code",
|
|
24
15
|
"cli",
|
|
25
|
-
"
|
|
16
|
+
"cli-tool",
|
|
17
|
+
"code-search",
|
|
18
|
+
"copilot",
|
|
19
|
+
"cursor",
|
|
26
20
|
"dev-tools",
|
|
27
|
-
"
|
|
28
|
-
"
|
|
21
|
+
"developer-tools",
|
|
22
|
+
"docs",
|
|
23
|
+
"documentation",
|
|
24
|
+
"examples",
|
|
25
|
+
"framework-docs",
|
|
26
|
+
"fuse.js",
|
|
27
|
+
"fuzzy-search",
|
|
28
|
+
"guide",
|
|
29
|
+
"ignis",
|
|
30
|
+
"llm",
|
|
31
|
+
"llm-tools",
|
|
32
|
+
"mastra",
|
|
33
|
+
"mastra-mcp",
|
|
34
|
+
"mcp",
|
|
35
|
+
"mcp-server",
|
|
36
|
+
"model-context-protocol",
|
|
37
|
+
"nodejs",
|
|
38
|
+
"static-site",
|
|
39
|
+
"tutorials",
|
|
40
|
+
"typescript",
|
|
41
|
+
"venizia",
|
|
42
|
+
"vitepress",
|
|
43
|
+
"wiki",
|
|
44
|
+
"windsurf"
|
|
29
45
|
],
|
|
46
|
+
"homepage": "https://venizia-ai.github.io/ignis",
|
|
47
|
+
"repository": {
|
|
48
|
+
"type": "git",
|
|
49
|
+
"url": "git+https://github.com/VENIZIA-AI/ignis.git",
|
|
50
|
+
"directory": "packages/docs"
|
|
51
|
+
},
|
|
52
|
+
"bugs": {
|
|
53
|
+
"url": "https://github.com/VENIZIA-AI/ignis/issues"
|
|
54
|
+
},
|
|
55
|
+
"author": {
|
|
56
|
+
"name": "VENIZIA AI Developer",
|
|
57
|
+
"email": "developer@venizia.ai",
|
|
58
|
+
"url": "https://venizia.ai"
|
|
59
|
+
},
|
|
60
|
+
"license": "MIT",
|
|
61
|
+
"engines": {
|
|
62
|
+
"bun": ">=1.3"
|
|
63
|
+
},
|
|
30
64
|
"main": "./dist/mcp-server/index.js",
|
|
31
65
|
"types": "./dist/mcp-server/index.d.ts",
|
|
66
|
+
"bin": {
|
|
67
|
+
"ignis-docs-mcp": "./dist/mcp-server/index.js"
|
|
68
|
+
},
|
|
32
69
|
"exports": {
|
|
33
70
|
".": {
|
|
34
71
|
"types": "./dist/mcp-server/index.d.ts",
|
|
@@ -47,9 +84,6 @@
|
|
|
47
84
|
"default": "./dist/mcp-server/common/index.js"
|
|
48
85
|
}
|
|
49
86
|
},
|
|
50
|
-
"bin": {
|
|
51
|
-
"ignis-docs-mcp": "./dist/mcp-server/index.js"
|
|
52
|
-
},
|
|
53
87
|
"files": [
|
|
54
88
|
"README.md",
|
|
55
89
|
"LICENSE.md",
|
|
@@ -61,9 +95,6 @@
|
|
|
61
95
|
"publishConfig": {
|
|
62
96
|
"access": "public"
|
|
63
97
|
},
|
|
64
|
-
"engines": {
|
|
65
|
-
"bun": ">=1.3"
|
|
66
|
-
},
|
|
67
98
|
"scripts": {
|
|
68
99
|
"force-update": "sh ./scripts/force-update.sh",
|
|
69
100
|
"eslint": "eslint --report-unused-disable-directives .",
|
|
@@ -83,24 +114,9 @@
|
|
|
83
114
|
"mcp:dev": "bun --watch mcp-server/index.ts",
|
|
84
115
|
"prepublishOnly": "bun run mcp:rebuild"
|
|
85
116
|
},
|
|
86
|
-
"repository": {
|
|
87
|
-
"type": "git",
|
|
88
|
-
"url": "git+https://github.com/VENIZIA-AI/ignis.git",
|
|
89
|
-
"directory": "packages/docs"
|
|
90
|
-
},
|
|
91
|
-
"author": {
|
|
92
|
-
"name": "VENIZIA AI Developer",
|
|
93
|
-
"email": "developer@venizia.ai",
|
|
94
|
-
"url": "https://venizia.ai"
|
|
95
|
-
},
|
|
96
|
-
"bugs": {
|
|
97
|
-
"url": "https://github.com/VENIZIA-AI/ignis/issues"
|
|
98
|
-
},
|
|
99
|
-
"homepage": "https://venizia-ai.github.io/ignis",
|
|
100
|
-
"license": "MIT",
|
|
101
117
|
"dependencies": {
|
|
102
|
-
"@mastra/core": "^
|
|
103
|
-
"@mastra/mcp": "^0.
|
|
118
|
+
"@mastra/core": "^1.5.0",
|
|
119
|
+
"@mastra/mcp": "^1.0.1",
|
|
104
120
|
"cytoscape": "^3.33.1",
|
|
105
121
|
"cytoscape-cose-bilkent": "^4.1.0",
|
|
106
122
|
"dayjs": "^1.11.19",
|
|
@@ -108,21 +124,19 @@
|
|
|
108
124
|
"fast-glob": "^3.3.3",
|
|
109
125
|
"fuse.js": "^7.1.0",
|
|
110
126
|
"gray-matter": "^4.0.3",
|
|
111
|
-
"zod": "^4.
|
|
127
|
+
"zod": "^4.3.6"
|
|
112
128
|
},
|
|
113
129
|
"devDependencies": {
|
|
114
|
-
"@braintree/sanitize-url": "^7.1.
|
|
115
|
-
"@types/bun": "^1.3.
|
|
116
|
-
"@types/glob": "^8.1.0",
|
|
130
|
+
"@braintree/sanitize-url": "^7.1.2",
|
|
131
|
+
"@types/bun": "^1.3.9",
|
|
117
132
|
"@venizia/dev-configs": "^0.0.6",
|
|
118
|
-
"eslint": "^9.
|
|
119
|
-
"
|
|
120
|
-
"prettier": "^3.6.2",
|
|
133
|
+
"eslint": "^9.39.3",
|
|
134
|
+
"prettier": "^3.8.1",
|
|
121
135
|
"tsc-alias": "^1.8.16",
|
|
122
|
-
"tsx": "^4.
|
|
123
|
-
"typescript": "^5.
|
|
136
|
+
"tsx": "^4.20.6",
|
|
137
|
+
"typescript": "^5.9.3",
|
|
124
138
|
"vitepress": "^1.6.4",
|
|
125
139
|
"vitepress-plugin-mermaid": "^2.0.17",
|
|
126
|
-
"vue": "^3.5.
|
|
140
|
+
"vue": "^3.5.28"
|
|
127
141
|
}
|
|
128
142
|
}
|
|
@@ -18,7 +18,6 @@ Pick which AI assistant you're using:
|
|
|
18
18
|
| Tool | Best For |
|
|
19
19
|
| ------------------------------------- | ---------------------------------------- |
|
|
20
20
|
| [Claude Code](#claude-code-cli-setup) | Terminal users, developers (Recommended) |
|
|
21
|
-
| [Gemini CLI](#gemini-cli-setup) | Google AI users |
|
|
22
21
|
| [VS Code](#vs-code-setup) | VS Code with MCP extensions |
|
|
23
22
|
| [Cursor](#cursor-setup) | AI-first code editor |
|
|
24
23
|
| [Windsurf](#windsurf-setup) | Codeium's AI editor |
|
|
@@ -244,139 +243,6 @@ Once working, try these queries:
|
|
|
244
243
|
"Show me an example of dependency injection in Ignis"
|
|
245
244
|
```
|
|
246
245
|
|
|
247
|
-
## Gemini CLI Setup
|
|
248
|
-
|
|
249
|
-
> **Important:** As of December 2024, Google's official Gemini CLI has limited MCP support. This setup is **experimental** and may require custom configuration.
|
|
250
|
-
|
|
251
|
-
### Prerequisites
|
|
252
|
-
|
|
253
|
-
1. **Install Google AI CLI tools:**
|
|
254
|
-
|
|
255
|
-
```bash
|
|
256
|
-
# Option 1: Using pip (Python)
|
|
257
|
-
pip install google-generativeai
|
|
258
|
-
|
|
259
|
-
# Option 2: Using Node.js wrapper
|
|
260
|
-
npm install -g @google/generative-ai
|
|
261
|
-
```
|
|
262
|
-
|
|
263
|
-
2. **Get your API key:**
|
|
264
|
-
- Visit [Google AI Studio](https://makersuite.google.com/app/apikey)
|
|
265
|
-
- Create a new API key
|
|
266
|
-
- Save it securely
|
|
267
|
-
|
|
268
|
-
### Setup Steps
|
|
269
|
-
|
|
270
|
-
#### 1. Configure environment
|
|
271
|
-
|
|
272
|
-
```bash
|
|
273
|
-
# Set your API key
|
|
274
|
-
export GOOGLE_API_KEY="your-api-key-here"
|
|
275
|
-
|
|
276
|
-
# Or add to your shell config (~/.bashrc, ~/.zshrc):
|
|
277
|
-
echo 'export GOOGLE_API_KEY="your-api-key-here"' >> ~/.bashrc
|
|
278
|
-
source ~/.bashrc
|
|
279
|
-
```
|
|
280
|
-
|
|
281
|
-
#### 2. Create MCP config directory
|
|
282
|
-
|
|
283
|
-
```bash
|
|
284
|
-
# Create config directory
|
|
285
|
-
mkdir -p ~/.config/gemini
|
|
286
|
-
|
|
287
|
-
# The config file location:
|
|
288
|
-
# macOS/Linux: ~/.config/gemini/mcp_servers.json
|
|
289
|
-
# Windows: %USERPROFILE%\.config\gemini\mcp_servers.json
|
|
290
|
-
```
|
|
291
|
-
|
|
292
|
-
#### 3. Add MCP Server Configuration
|
|
293
|
-
|
|
294
|
-
Create `~/.config/gemini/mcp_servers.json`:
|
|
295
|
-
|
|
296
|
-
**Recommended: Using npx**
|
|
297
|
-
|
|
298
|
-
```json
|
|
299
|
-
{
|
|
300
|
-
"mcpServers": {
|
|
301
|
-
"ignis-docs": {
|
|
302
|
-
"command": "npx",
|
|
303
|
-
"args": ["-y", "@venizia/ignis-docs"],
|
|
304
|
-
"env": {}
|
|
305
|
-
}
|
|
306
|
-
}
|
|
307
|
-
}
|
|
308
|
-
```
|
|
309
|
-
|
|
310
|
-
**Alternative: Global install**
|
|
311
|
-
|
|
312
|
-
```bash
|
|
313
|
-
# First install globally
|
|
314
|
-
npm install -g @venizia/ignis-docs
|
|
315
|
-
```
|
|
316
|
-
|
|
317
|
-
Then configure:
|
|
318
|
-
|
|
319
|
-
```json
|
|
320
|
-
{
|
|
321
|
-
"mcpServers": {
|
|
322
|
-
"ignis-docs": {
|
|
323
|
-
"command": "ignis-docs-mcp",
|
|
324
|
-
"env": {}
|
|
325
|
-
}
|
|
326
|
-
}
|
|
327
|
-
}
|
|
328
|
-
```
|
|
329
|
-
|
|
330
|
-
#### 4. Test manually first
|
|
331
|
-
|
|
332
|
-
Before integrating with Gemini, test the MCP server works:
|
|
333
|
-
|
|
334
|
-
```bash
|
|
335
|
-
# Test the MCP server can start
|
|
336
|
-
npx @venizia/ignis-docs
|
|
337
|
-
|
|
338
|
-
# Expected output:
|
|
339
|
-
# "MCP Server listening on stdio..."
|
|
340
|
-
# (Press Ctrl+C to stop)
|
|
341
|
-
```
|
|
342
|
-
|
|
343
|
-
#### 5. Use with Gemini (if supported)
|
|
344
|
-
|
|
345
|
-
**Note:** MCP support in Gemini CLI is limited. Alternative approaches:
|
|
346
|
-
|
|
347
|
-
**Option A: Use Google AI Python SDK with custom MCP wrapper**
|
|
348
|
-
|
|
349
|
-
```python
|
|
350
|
-
# This requires writing custom integration code
|
|
351
|
-
# See: https://github.com/modelcontextprotocol/python-sdk
|
|
352
|
-
```
|
|
353
|
-
|
|
354
|
-
**Option B: Use via Claude Code CLI instead**
|
|
355
|
-
|
|
356
|
-
- Gemini CLI MCP support is experimental
|
|
357
|
-
- Claude Code has better MCP support out of the box
|
|
358
|
-
- Recommendation: Use [Claude Code CLI setup](#claude-code-cli-setup) for Ignis docs
|
|
359
|
-
|
|
360
|
-
#### Troubleshooting
|
|
361
|
-
|
|
362
|
-
**"Command not found: gemini"**
|
|
363
|
-
|
|
364
|
-
- Google doesn't have an official "gemini" CLI command
|
|
365
|
-
- Use `gcloud ai` or Python SDK instead
|
|
366
|
-
- Consider using Claude Code CLI for better MCP support
|
|
367
|
-
|
|
368
|
-
**MCP server not loading**
|
|
369
|
-
|
|
370
|
-
- Gemini CLI MCP support is experimental
|
|
371
|
-
- Check if your Gemini CLI version supports MCP:
|
|
372
|
-
```bash
|
|
373
|
-
gemini --version
|
|
374
|
-
gemini mcp list # If this command doesn't exist, MCP isn't supported
|
|
375
|
-
```
|
|
376
|
-
|
|
377
|
-
**Recommended Alternative:**
|
|
378
|
-
Use Claude Code CLI (see setup above) - it has full MCP support and works reliably.
|
|
379
|
-
|
|
380
246
|
## VS Code Setup
|
|
381
247
|
|
|
382
248
|
VS Code supports MCP through various extensions. The setup process is similar to Microsoft's Playwright MCP integration.
|
|
@@ -377,12 +377,14 @@ When resolving authentication for a route, the following priority applies:
|
|
|
377
377
|
### Authentication Examples
|
|
378
378
|
|
|
379
379
|
```typescript
|
|
380
|
+
import { Authentication, ControllerFactory } from '@venizia/ignis';
|
|
381
|
+
|
|
380
382
|
// 1. JWT auth on ALL routes
|
|
381
383
|
const UserController = ControllerFactory.defineCrudController({
|
|
382
384
|
entity: UserEntity,
|
|
383
385
|
repository: { name: 'UserRepository' },
|
|
384
386
|
controller: { name: 'UserController', basePath: '/users' },
|
|
385
|
-
authStrategies: [
|
|
387
|
+
authStrategies: [Authentication.STRATEGY_JWT],
|
|
386
388
|
});
|
|
387
389
|
|
|
388
390
|
// 2. JWT auth on all, but skip for public read endpoints
|
|
@@ -390,7 +392,7 @@ const ProductController = ControllerFactory.defineCrudController({
|
|
|
390
392
|
entity: ProductEntity,
|
|
391
393
|
repository: { name: 'ProductRepository' },
|
|
392
394
|
controller: { name: 'ProductController', basePath: '/products' },
|
|
393
|
-
authStrategies: [
|
|
395
|
+
authStrategies: [Authentication.STRATEGY_JWT],
|
|
394
396
|
routes: {
|
|
395
397
|
find: { skipAuth: true },
|
|
396
398
|
findById: { skipAuth: true },
|
|
@@ -404,9 +406,9 @@ const ArticleController = ControllerFactory.defineCrudController({
|
|
|
404
406
|
repository: { name: 'ArticleRepository' },
|
|
405
407
|
controller: { name: 'ArticleController', basePath: '/articles' },
|
|
406
408
|
routes: {
|
|
407
|
-
create: { authStrategies: [
|
|
408
|
-
updateById: { authStrategies: [
|
|
409
|
-
deleteById: { authStrategies: [
|
|
409
|
+
create: { authStrategies: [Authentication.STRATEGY_JWT] },
|
|
410
|
+
updateById: { authStrategies: [Authentication.STRATEGY_JWT] },
|
|
411
|
+
deleteById: { authStrategies: [Authentication.STRATEGY_JWT] },
|
|
410
412
|
},
|
|
411
413
|
});
|
|
412
414
|
|
|
@@ -415,7 +417,7 @@ const OrderController = ControllerFactory.defineCrudController({
|
|
|
415
417
|
entity: OrderEntity,
|
|
416
418
|
repository: { name: 'OrderRepository' },
|
|
417
419
|
controller: { name: 'OrderController', basePath: '/orders' },
|
|
418
|
-
authStrategies: [
|
|
420
|
+
authStrategies: [Authentication.STRATEGY_JWT],
|
|
419
421
|
routes: {
|
|
420
422
|
find: {
|
|
421
423
|
skipAuth: true,
|
|
@@ -432,6 +434,7 @@ const OrderController = ControllerFactory.defineCrudController({
|
|
|
432
434
|
### Route Customization Examples
|
|
433
435
|
|
|
434
436
|
```typescript
|
|
437
|
+
import { Authentication, ControllerFactory } from '@venizia/ignis';
|
|
435
438
|
import { z } from '@hono/zod-openapi';
|
|
436
439
|
|
|
437
440
|
// Custom request body for create
|
|
@@ -453,7 +456,7 @@ const UserController = ControllerFactory.defineCrudController({
|
|
|
453
456
|
entity: UserEntity,
|
|
454
457
|
repository: { name: 'UserRepository' },
|
|
455
458
|
controller: { name: 'UserController', basePath: '/users' },
|
|
456
|
-
authStrategies: [
|
|
459
|
+
authStrategies: [Authentication.STRATEGY_JWT],
|
|
457
460
|
routes: {
|
|
458
461
|
// Public read endpoints
|
|
459
462
|
find: {
|
|
@@ -473,7 +476,7 @@ const UserController = ControllerFactory.defineCrudController({
|
|
|
473
476
|
|
|
474
477
|
// Delete requires JWT auth (uses default schema)
|
|
475
478
|
deleteById: {
|
|
476
|
-
authStrategies: [
|
|
479
|
+
authStrategies: [Authentication.STRATEGY_JWT],
|
|
477
480
|
},
|
|
478
481
|
},
|
|
479
482
|
});
|
|
@@ -23,7 +23,7 @@ const FALLBACK_AUTH_CONFIG = {
|
|
|
23
23
|
path: '/api/data',
|
|
24
24
|
method: HTTP.Methods.GET,
|
|
25
25
|
authStrategies: [Authentication.STRATEGY_JWT, Authentication.STRATEGY_BASIC],
|
|
26
|
-
authMode:
|
|
26
|
+
authMode: AuthenticationModes.ANY,
|
|
27
27
|
responses: jsonResponse({
|
|
28
28
|
description: 'Data accessible via JWT or Basic auth',
|
|
29
29
|
schema: z.object({ data: z.any() }),
|
|
@@ -47,12 +47,12 @@ const PUBLIC_ROUTE_CONFIG = {
|
|
|
47
47
|
The `authenticate()` function is a convenience wrapper around `AuthenticationStrategyRegistry.getInstance().authenticate()`. It returns a Hono `MiddlewareHandler` suitable for direct middleware usage:
|
|
48
48
|
|
|
49
49
|
```typescript
|
|
50
|
-
import { authenticate, Authentication } from '@venizia/ignis';
|
|
50
|
+
import { authenticate, Authentication, AuthenticationModes } from '@venizia/ignis';
|
|
51
51
|
|
|
52
52
|
// Use as Hono middleware directly
|
|
53
53
|
const authMiddleware = authenticate({
|
|
54
54
|
strategies: [Authentication.STRATEGY_JWT],
|
|
55
|
-
mode:
|
|
55
|
+
mode: AuthenticationModes.ANY,
|
|
56
56
|
});
|
|
57
57
|
|
|
58
58
|
// Apply to a Hono route
|