@hsayed21/wikijs-mcp 2.0.1

package/dist/tools/list-pages.d.ts

@@ -0,0 +1,42 @@
+/**
+ * wikijs_list_pages Tool
+ *
+ * Lists all pages in Wiki.js with optional filtering and pagination
+ */
+import { z } from 'zod';
+import type { WikiJsClient } from '../services/client.js';
+import { listPagesSchema } from '../schemas/index.js';
+export declare const listPagesToolDefinition: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        locale: z.ZodOptional<z.ZodString>;
+        path: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+        limit: z.ZodDefault<z.ZodNumber>;
+        offset: z.ZodDefault<z.ZodNumber>;
+    }, "strip", z.ZodTypeAny, {
+        limit: number;
+        offset: number;
+        path?: string | undefined;
+        locale?: string | undefined;
+    }, {
+        path?: string | undefined;
+        locale?: string | undefined;
+        limit?: number | undefined;
+        offset?: number | undefined;
+    }>;
+    annotations: {
+        readOnlyHint: boolean;
+        destructiveHint: boolean;
+        idempotentHint: boolean;
+        openWorldHint: boolean;
+    };
+};
+export declare function handleListPages(client: WikiJsClient, args: z.infer<typeof listPagesSchema>): Promise<{
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}>;
+//# sourceMappingURL=list-pages.d.ts.map

package/dist/tools/list-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-pages.d.ts","sourceRoot":"","sources":["../../src/tools/list-pages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,eAAe,EAAuB,MAAM,qBAAqB,CAAC;AAI3E,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;CA+BnC,CAAC;AAEF,wBAAsB,eAAe,CACnC,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,eAAe,CAAC,GACpC,OAAO,CAAC;IAAE,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAqDhF"}

package/dist/tools/list-pages.js

@@ -0,0 +1,82 @@
+/**
+ * wikijs_list_pages Tool
+ *
+ * Lists all pages in Wiki.js with optional filtering and pagination
+ */
+import { listPagesSchema } from '../schemas/index.js';
+import { handleToolError } from '../services/error-handler.js';
+import { DEFAULT_PAGE_LIMIT } from '../constants.js';
+export const listPagesToolDefinition = {
+    name: 'wikijs_list_pages',
+    description: `List all pages in Wiki.js with optional filtering and pagination.
+
+This tool returns a paginated list of published pages. Use the offset parameter to navigate through large result sets.
+
+Args:
+  - locale (string, optional): Filter by locale (e.g., "en", "de")
+  - path (string, optional): Only include pages under this path
+  - limit (number): Max pages to return, default 50, max 200. Use -1 to return all matching pages.
+  - offset (number): Skip N pages for pagination, default 0
+
+Returns:
+  - pages: Array of published page summaries (id, path, title, description, locale, tags, updatedAt)
+  - pagination: { limit, offset, total_count, has_more, next_offset }
+
+Use pagination.has_more and pagination.next_offset to fetch more results.
+
+Examples:
+  - List all: (no params, returns first 50)
+  - List all matching pages: limit=-1
+  - Filter by locale: locale="de"
+  - Filter by path: path="osticket/"
+  - Paginate: offset=50, limit=50 (get pages 51-100)`,
+    inputSchema: listPagesSchema,
+    annotations: {
+        readOnlyHint: true,
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: true,
+    },
+};
+export async function handleListPages(client, args) {
+    try {
+        // Validate input with Zod
+        const validated = listPagesSchema.parse(args);
+        const limit = validated.limit ?? DEFAULT_PAGE_LIMIT;
+        const offset = limit < 0 ? 0 : validated.offset ?? 0;
+        const { pages, total } = await client.listPages(validated.locale ?? null, limit, offset, validated.path ?? null);
+        const pageList = pages.map((p) => ({
+            id: p.id,
+            path: p.path,
+            title: p.title,
+            description: p.description,
+            locale: p.locale,
+            isPublished: p.isPublished,
+            tags: p.tags || [],
+            updatedAt: p.updatedAt,
+        }));
+        const hasMore = offset + pageList.length < total;
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify({
+                        success: true,
+                        pages: pageList,
+                        pagination: {
+                            limit,
+                            offset,
+                            total_count: total,
+                            has_more: hasMore,
+                            ...(hasMore ? { next_offset: offset + pageList.length } : {}),
+                        },
+                    }, null, 2),
+                },
+            ],
+        };
+    }
+    catch (error) {
+        return handleToolError(error, 'wikijs_list_pages');
+    }
+}
+//# sourceMappingURL=list-pages.js.map

package/dist/tools/list-pages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"list-pages.js","sourceRoot":"","sources":["../../src/tools/list-pages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,eAAe,EAAuB,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD,MAAM,CAAC,MAAM,uBAAuB,GAAG;IACrC,IAAI,EAAE,mBAAmB;IACzB,WAAW,EAAE;;;;;;;;;;;;;;;;;;;;;qDAqBsC;IACnD,WAAW,EAAE,eAAe;IAC5B,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,eAAe,CACnC,MAAoB,EACpB,IAAqC;IAErC,IAAI,CAAC;QACH,0BAA0B;QAC1B,MAAM,SAAS,GAAmB,eAAe,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAE9D,MAAM,KAAK,GAAG,SAAS,CAAC,KAAK,IAAI,kBAAkB,CAAC;QACpD,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,IAAI,CAAC,CAAC;QAErD,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,GAAG,MAAM,MAAM,CAAC,SAAS,CAC7C,SAAS,CAAC,MAAM,IAAI,IAAI,EACxB,KAAK,EACL,MAAM,EACN,SAAS,CAAC,IAAI,IAAI,IAAI,CACvB,CAAC;QAEF,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACjC,EAAE,EAAE,CAAC,CAAC,EAAE;YACR,IAAI,EAAE,CAAC,CAAC,IAAI;YACZ,KAAK,EAAE,CAAC,CAAC,KAAK;YACd,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;YAChB,WAAW,EAAE,CAAC,CAAC,WAAW;YAC1B,IAAI,EAAE,CAAC,CAAC,IAAI,IAAI,EAAE;YAClB,SAAS,EAAE,CAAC,CAAC,SAAS;SACvB,CAAC,CAAC,CAAC;QAEJ,MAAM,OAAO,GAAG,MAAM,GAAG,QAAQ,CAAC,MAAM,GAAG,KAAK,CAAC;QAEjD,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;wBACE,OAAO,EAAE,IAAI;wBACb,KAAK,EAAE,QAAQ;wBACf,UAAU,EAAE;4BACV,KAAK;4BACL,MAAM;4BACN,WAAW,EAAE,KAAK;4BAClB,QAAQ,EAAE,OAAO;4BACjB,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,GAAG,QAAQ,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;yBAC9D;qBACF,EACD,IAAI,EACJ,CAAC,CACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,eAAe,CAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC;IACrD,CAAC;AACH,CAAC"}

package/dist/tools/search-pages.d.ts

@@ -0,0 +1,39 @@
+/**
+ * wikijs_search_pages Tool
+ *
+ * Searches pages in Wiki.js
+ */
+import { z } from 'zod';
+import type { WikiJsClient } from '../services/client.js';
+import { searchPagesSchema } from '../schemas/index.js';
+export declare const searchPagesToolDefinition: {
+    name: string;
+    description: string;
+    inputSchema: z.ZodObject<{
+        query: z.ZodString;
+        locale: z.ZodOptional<z.ZodString>;
+        path: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
+    }, "strip", z.ZodTypeAny, {
+        query: string;
+        path?: string | undefined;
+        locale?: string | undefined;
+    }, {
+        query: string;
+        path?: string | undefined;
+        locale?: string | undefined;
+    }>;
+    annotations: {
+        readOnlyHint: boolean;
+        destructiveHint: boolean;
+        idempotentHint: boolean;
+        openWorldHint: boolean;
+    };
+};
+export declare function handleSearchPages(client: WikiJsClient, args: z.infer<typeof searchPagesSchema>): Promise<{
+    content: Array<{
+        type: 'text';
+        text: string;
+    }>;
+    isError?: boolean;
+}>;
+//# sourceMappingURL=search-pages.d.ts.map

package/dist/tools/search-pages.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-pages.d.ts","sourceRoot":"","sources":["../../src/tools/search-pages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAC1D,OAAO,EAAE,iBAAiB,EAAyB,MAAM,qBAAqB,CAAC;AAG/E,eAAO,MAAM,yBAAyB;;;;;;;;;;;;;;;;;;;;;;CA2BrC,CAAC;AAEF,wBAAsB,iBAAiB,CACrC,MAAM,EAAE,YAAY,EACpB,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,GACtC,OAAO,CAAC;IAAE,OAAO,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAAC,OAAO,CAAC,EAAE,OAAO,CAAA;CAAE,CAAC,CAqChF"}

package/dist/tools/search-pages.js

@@ -0,0 +1,65 @@
+/**
+ * wikijs_search_pages Tool
+ *
+ * Searches pages in Wiki.js
+ */
+import { searchPagesSchema } from '../schemas/index.js';
+import { handleToolError } from '../services/error-handler.js';
+export const searchPagesToolDefinition = {
+    name: 'wikijs_search_pages',
+    description: `Search for pages in Wiki.js by query string.
+
+This tool performs a full-text search across published page content and metadata. Results are ranked by relevance.
+
+Args:
+  - query (string, required): Search query (min 2 chars, max 200 chars)
+  - locale (string, optional): Filter results by locale
+  - path (string, optional): Only include pages under this path
+
+Returns:
+  - totalHits: Total number of matching published pages
+  - suggestions: Search suggestions for refinement
+  - results: Array of matching pages (id, title, path, description, locale)
+
+Examples:
+  - Search for topic: query="osTicket API"
+  - Search in German pages: query="Plugin", locale="de"
+  - Search inside a section: query="API", path="osticket/"`,
+    inputSchema: searchPagesSchema,
+    annotations: {
+        readOnlyHint: true,
+        destructiveHint: false,
+        idempotentHint: true,
+        openWorldHint: true,
+    },
+};
+export async function handleSearchPages(client, args) {
+    try {
+        // Validate input with Zod
+        const validated = searchPagesSchema.parse(args);
+        const results = await client.searchPages(validated.query, validated.locale ?? null, validated.path ?? null);
+        return {
+            content: [
+                {
+                    type: 'text',
+                    text: JSON.stringify({
+                        success: true,
+                        totalHits: results.totalHits,
+                        suggestions: results.suggestions,
+                        results: results.results.map((r) => ({
+                            id: r.id,
+                            title: r.title,
+                            path: r.path,
+                            description: r.description,
+                            locale: r.locale,
+                        })),
+                    }, null, 2),
+                },
+            ],
+        };
+    }
+    catch (error) {
+        return handleToolError(error, 'wikijs_search_pages');
+    }
+}
+//# sourceMappingURL=search-pages.js.map

package/dist/tools/search-pages.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"search-pages.js","sourceRoot":"","sources":["../../src/tools/search-pages.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,EAAE,iBAAiB,EAAyB,MAAM,qBAAqB,CAAC;AAC/E,OAAO,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AAE/D,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,qBAAqB;IAC3B,WAAW,EAAE;;;;;;;;;;;;;;;;;2DAiB4C;IACzD,WAAW,EAAE,iBAAiB;IAC9B,WAAW,EAAE;QACX,YAAY,EAAE,IAAI;QAClB,eAAe,EAAE,KAAK;QACtB,cAAc,EAAE,IAAI;QACpB,aAAa,EAAE,IAAI;KACpB;CACF,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,iBAAiB,CACrC,MAAoB,EACpB,IAAuC;IAEvC,IAAI,CAAC;QACH,0BAA0B;QAC1B,MAAM,SAAS,GAAqB,iBAAiB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QAElE,MAAM,OAAO,GAAG,MAAM,MAAM,CAAC,WAAW,CACtC,SAAS,CAAC,KAAK,EACf,SAAS,CAAC,MAAM,IAAI,IAAI,EACxB,SAAS,CAAC,IAAI,IAAI,IAAI,CACvB,CAAC;QAEF,OAAO;YACL,OAAO,EAAE;gBACP;oBACE,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,IAAI,CAAC,SAAS,CAClB;wBACE,OAAO,EAAE,IAAI;wBACb,SAAS,EAAE,OAAO,CAAC,SAAS;wBAC5B,WAAW,EAAE,OAAO,CAAC,WAAW;wBAChC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;4BACnC,EAAE,EAAE,CAAC,CAAC,EAAE;4BACR,KAAK,EAAE,CAAC,CAAC,KAAK;4BACd,IAAI,EAAE,CAAC,CAAC,IAAI;4BACZ,WAAW,EAAE,CAAC,CAAC,WAAW;4BAC1B,MAAM,EAAE,CAAC,CAAC,MAAM;yBACjB,CAAC,CAAC;qBACJ,EACD,IAAI,EACJ,CAAC,CACF;iBACF;aACF;SACF,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,eAAe,CAAC,KAAK,EAAE,qBAAqB,CAAC,CAAC;IACvD,CAAC;AACH,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Wiki.js MCP Server Type Definitions
+ */
+export interface WikiPage {
+    id: number;
+    path: string;
+    title: string;
+    description: string;
+    content?: string;
+    contentType?: string;
+    isPublished: boolean;
+    locale: string;
+    createdAt?: string;
+    updatedAt?: string;
+    tags?: string[];
+}
+export interface WikiPageListItem {
+    id: number;
+    path: string;
+    title: string;
+    description: string;
+    isPublished: boolean;
+    locale: string;
+    contentType: string;
+    createdAt: string;
+    updatedAt: string;
+    tags: string[];
+}
+export interface SearchResult {
+    id: number;
+    title: string;
+    path: string;
+    description: string;
+    locale: string;
+}
+export interface SearchResponse {
+    results: SearchResult[];
+    suggestions: string[];
+    totalHits: number;
+}
+export interface WikiPageTreeNode {
+    id: number;
+    path: string;
+    depth: number;
+    title: string;
+    isPrivate: boolean;
+    isFolder: boolean;
+    privateNS?: string;
+    parent?: number;
+    pageId?: number;
+    locale: string;
+}
+export interface PaginationMeta {
+    limit: number;
+    offset: number;
+    total_count: number;
+    has_more: boolean;
+    next_offset?: number;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AAGH,MAAM,WAAW,QAAQ;IACvB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,EAAE,OAAO,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,YAAY;IAC3B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,YAAY,EAAE,CAAC;IACxB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,OAAO,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAGD,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB"}

package/dist/types.js

@@ -0,0 +1,5 @@
+/**
+ * Wiki.js MCP Server Type Definitions
+ */
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG"}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "@hsayed21/wikijs-mcp",
+  "version": "2.0.1",
+  "description": "Read-only MCP server for searching and retrieving published Wiki.js knowledge base pages",
+  "type": "module",
+  "main": "dist/index.js",
+  "bin": {
+    "wikijs-mcp": "dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "start": "node dist/index.js",
+    "dev": "tsx watch src/index.ts",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "mcp",
+    "mcp-server",
+    "wikijs",
+    "graphql",
+    "documentation",
+    "wiki",
+    "model-context-protocol"
+  ],
+  "author": "hsayed21",
+  "license": "MIT",
+  "dependencies": {
+    "@modelcontextprotocol/sdk": "^1.24.3",
+    "dotenv": "^16.4.5",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "@types/node": "^22.19.3",
+    "tsx": "^4.19.2",
+    "typescript": "^5.7.2",
+    "vitest": "^4.0.16"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ]
+}